Segment data as reported
segmentsReturn a company's segment facts as the filer tagged them (business segments, geographies, products) from the SEC Financial Statement Data Sets: tag, member, dims and value with the filing as proof. Members are never renamed or mapped across companies; eliminations appear under dims.ConsolidationItems. tag narrows to one line (for example RevenueFromContractWithCustomerExcludingAssessedTax). Filing-layer read: served with generous limits on every tier. Use it when asked for revenue or profit by business line, geography or product. If a dataset, field, company or analysis you need is missing, call request_data.
Example tool call
This call uses example arguments supplied in the tool’s input schema.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"tag": "RevenueFromContractWithCustomerExcludingAssessedTax",
"kind": "geography",
"company": "ticker:AAPL"
},
"name": "segments"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tag | No | Only this XBRL tag. | |
| kind | No | Segment axis kind. | |
| as_of | No | Knowledge date or timestamp (YYYY-MM-DD or RFC 3339). The answer is what FinancialMD knew at that instant: only facts whose known interval contains as_of. Omit for the current view. | |
| limit | No | Maximum number of periods or items to return (default 2, at most 20). | |
| company | Yes | Company identifier: a FinancialMD id ("fmd_01H..."), an SEC CIK ("cik:320193"), or a ticker ("ticker:AAPL", optionally with the MIC "ticker:AAPL.XNAS"). A bare ticker like "AAPL" is accepted and sent as ticker:AAPL. | |
| period_type | No | Annual (four-quarter) or quarterly facts. | annual |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | { period_type, items: [{ tag, taxonomy, kind, member, dims, period_end, value }], note } | |
| meta | No | Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base. | |
| error | No | Present only on isError results: the API error code and message plus remedy hints. |