get_filing_outline
Every readable part of one filing, both lanes, with sizes.
What it does
The scan tool: call it before reading anything. Returns every addressable section of one filing -- by default the latest annual report -- across two lanes, each entry with a section_id for read_filing_section and a measured size so you can choose what to spend. The notes lane comes from EDGAR's own per-note rendering; read notes.label for what that category contains, because it is wider than the accounting notes alone. The narrative lane is regex-sectioned from the primary document and is SECOND CLASS: it carries confidence, failure_reason and notice at document level and confidence, flags and notice per section. Some filers incorporate MD&A by reference and print only a pointer where the disclosure should be; that section is flagged incorporated_by_reference and must not be read as the disclosure itself.
get_filing_outline is on the free tier. A free account gets 12 agent calls per 16 hours and this is one of them; Pro is uncounted. The website's own screening allowance is counted separately.
Arguments, returns and a worked call
Everything below is generated from the same registry entry the MCP server and /openapi.json are generated from, so this page cannot name an argument that does not exist. The two examples are the same call, once over each transport.
get_filing_outline
FreeThe scan tool: call it before reading anything. Returns every addressable section of one filing -- by default the latest annual report -- across two lanes, each entry with a `section_id` for read_filing_section and a measured size so you can choose what to spend. The notes lane comes from EDGAR's own per-note rendering; read `notes.label` for what that category contains, because it is wider than the accounting notes alone. The narrative lane is regex-sectioned from the primary document and is SECOND CLASS: it carries `confidence`, `failure_reason` and `notice` at document level and `confidence`, `flags` and `notice` per section. Some filers incorporate MD&A by reference and print only a pointer where the disclosure should be; that section is flagged `incorporated_by_reference` and must not be read as the disclosure itself.
Arguments
symbol string, required — The ticker as Crush The Market spells it.
accession string, optional — A specific filing, as list_filings spells it. Defaults to the latest annual report (10-K, 20-F or 40-F).
sizes boolean, optional — Measure every note by fetching it, so `chars` and `tokens` are real rather than null. Defaults to true. Pass false for a cheaper outline when you do not need to budget.
Returns
symbol, filing, notes, narrative, note, error, as_of, source, disclaimer
> curl -s https://crushthemarket.com/api/v1/get_filing_outline \ -H "Authorization: Bearer $CTM_KEY" \ -H 'Content-Type: application/json' \ -d '{"symbol":"AAPL"}'{ "jsonrpc": "2.0", "id": 1, "method": "tools/call", "params": { "name": "get_filing_outline", "arguments": { "symbol": "AAPL" } }}Can answer
bad_request — `symbol` is missing, or `accession` is not in the form 0000000000-00-000000.
no_sec_filer — No SEC filer is mapped to the symbol. `adr_symbol` from list_filings may name one that is.
no_annual_report_yet — EDGAR lists filings for the issuer but no annual report among them.
unknown_filing — The accession is not one EDGAR lists for this symbol.
filing_summary_missing — EDGAR has no FilingSummary.xml for the filing, so the notes lane cannot be built.
edgar_unavailable — EDGAR did not answer, or answered with an error, after retries.
Calling get_filing_outline
- 1.Register free — an email address, no card — then create a key under API Keys on your account page. Your email address has to be verified first, and the key is shown once.
- 2.Using a chat client that speaks MCP? The MCP guide is one paste. Anything else takes bearer auth, the error codes and the limits from the REST guide.
- 3.Make the call above with your own key in it.
Every successful response carries as_of, source, a quota block saying how much of the allowance is left, and the same disclaimer this page ends on.
More for agents
Data, not advice. Do your own diligence.