Cross-company comparison (XBRL frames)
compare_companiesCompare one financial metric or XBRL concept across ALL reporting companies for a CALENDAR period (SEC frames API), e.g. rank by revenue for CY2024, or compare specific companies. Pass metric (revenue, gross_profit, operating_income, net_income, eps_basic, eps_diluted, operating_cash_flow, capex, total_assets, total_liabilities, stockholders_equity, cash, long_term_debt; aliases like sales, eps, assets) to fall back across the common tags for it (revenue: Revenues > RevenueFromContractWithCustomerExcludingAssessedTax > SalesRevenueNet), with the tag used per company; or pass tag for one exact concept. Period: CY2024 (annual duration), CY2024Q2 (quarter), CY2024Q4I (instant, for balance-sheet items; added automatically for balance-sheet metrics). Calendar basis: each filer's ~1-year (or ~3-month) period that best fits the calendar period, so CY2024 for Microsoft is its fiscal year ending 2024-06-30 (flagged fiscal_period_differs); use get_financials for fiscal years. accn is the latest filing reporting the value. Pass companies to filter to specific tickers/CIKs (exact or prefix names also work, without typo correction; unresolved items are listed in unresolved); otherwise returns the top limit by value.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"period": "<period>"
},
"name": "compare_companies"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | Exact XBRL tag, e.g. 'Revenues', 'NetIncomeLoss', 'Assets' (case-sensitive). Use instead of metric. | |
| unit | No | USD (default), USD-per-shares, shares, pure. With metric, defaults to the metric's unit | |
| limit | No | ||
| order | No | desc | |
| metric | No | Normalized metric with tag fallback, e.g. 'revenue', 'net_income', 'eps_diluted', 'total_assets'. Use instead of tag. | |
| period | Yes | CY2024, CY2024Q3, or CY2024Q4I | |
| taxonomy | No | For tag only | us-gaap |
| companies | No | Tickers or CIKs to include (default: all) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| unit | No | ||
| label | No | ||
| period | Yes | ||
| concept | No | ||
| results | Yes | ||
| source_url | No | ||
| missing_ciks | No | ||
| companies_reporting | No |