Compare Companies On One Metric
compare_companiesCompares one normalized metric across several filers in a single call, with reporting periods aligned so companies whose fiscal calendars end in different months still line up period by period. Use it for peer, competitor or ranking questions — which of these companies earns the most revenue, whose total assets grew fastest, how a filer's net income stands against its sector — where the same figure is wanted for two to eight tickers. Exactly one metric per call, because the upstream aligns a single metric across companies rather than returning a matrix; ask again per metric if you need more. Returns one row per ticker carrying the aligned period values and the resolved XBRL tag, plus a per-row error for any ticker that fails to resolve or has never reported the metric. See /.well-known/x402 for current pricing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | How many aligned reporting periods to return per company, newest first. Accepts 1 to 12; defaults to 4 when omitted. | |
| metric | Yes | The single normalized metric key every company is compared on, as published by list_metrics — for instance revenue, net_income or assets. One metric per call. | |
| period | Yes | Reporting frequency to return: 'annual' for fiscal-year figures drawn from 10-K filings, 'quarterly' for fiscal-quarter figures drawn from 10-Q filings. | annual |
| tickers | Yes | The companies to compare, as exchange ticker symbols. Between 2 and 8 distinct symbols; duplicates are folded together and a symbol that does not resolve is reported on its own row rather than failing the call. |