Endpoints: 76,849MCP servers: 32,730Payout addresses: 3,825Paid calls: 6,158Letters: 84Defects: 3,898counted 1 min ago
teppi

Server definition

Hash
sha256:42b18cb17c2136a95af10bf4d400780b8ff08424561a139185d5e1605f6f43ff
What it is
What a remote MCP server returned when asked what it offers: 62 tools

The blob, as servednamed by its sha256

{ "instructions": "FinancialMD serves company financial data built from public filings. Every number carries a proof back to its filing and is point-in-time. Start with company_lookup or company_profile to resolve the company, then financials_standardized for comparable statements, financials_as_reported for the filer's own lines, ratios for margins, returns, leverage and growth computed from the filings, verify_value to check a number, snapshot_as_of to replay what was known on a date, compare_versions to see restatements, proof_get to trace a value, filings_list and filing_get for documents, filing_facts for every fact of one filing, screen to filter and rank every covered company on its latest metrics, changes_since to poll for updates, insider_transactions for Forms 3, 4 and 5, institutional_holders for the 13F managers holding a company, institutional_holdings for one manager's 13F portfolio, stock_prices for daily bars built from IEX trades only (single venue, not the consolidated tape; raw, or split-adjusted and total return with adjust). Further tools cover daily valuation ratios, dividends and splits, earnings dates, 8-K events and news, segments, company-reported KPIs, fund holdings and fees, identifiers, filing documents and full-text search of filings; line_item finds one reported line by its label and period when the standardized statements do not carry it (detail lines, segment figures, company metrics, the company's own guidance); technical_indicators, forward_ratios on our own model estimates, pre_ipo_companies for S-1 and F-1 registrants, and fund letters by writer and by company are also here; coverage says what is served and what is not. Every value object has value, unit, currency, period, known interval, restated flag and proof; cite proof.source_url when quoting a number. Information only, not investment advice.", "tools": [ { "description": "Answer one short question about one company from its own filed values: statements, ratios, guidance, company metrics, segments and recent 8-K events. The answer in data.answer is written by an AI model and is labelled as such in data.label. The model sees only a numbered list of our facts. The server then checks that every number in the answer matches a fact it cites, and withholds the answer when one does not: data.answer is null, data.withheld_reason says why, and data.related_facts lists the facts to read instead. data.citations holds each cited fact as a value object with its proof and filing link, so quote those values, not the prose. It restates filed values; it does not compute, forecast or advise, and an answer with words of advice is withheld. It needs an API key or a signed-in connector: without one the answer is unauthorized with a sign-in link. Each key or connector has 20 answers a day (data.usage); a withheld answer does not count. Use it for a quick factual question such as last year's revenue or margin; use the statement, ratio or line item tools when you need the full table or an exact line.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL", "question": "What was revenue and gross margin last fiscal year?" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "question": { "description": "The question about this company. Plain English, 3 to 300 characters, no links. Example: What was revenue and gross margin last fiscal year?", "maxLength": 300, "minLength": 3, "type": "string" } }, "required": [ "company", "question" ], "type": "object" }, "name": "ask_company", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ question, answer (string or null), citations: [{ fact, dataset, label, period, value (value object with proof) or null, text, source_url }], withheld_reason (null, no_facts, cannot_answer, no_citations, unknown_citation, unverified_numbers, invalid_model_output, advice, prompt_attack, harmful_content), unverified_numbers: [string], related_facts: [same shape as citations], facts_considered, generated_by \"model\", label, model, method_version, disclaimer, cached }", "properties": { "answer": { "type": [ "string", "null" ] }, "cached": { "type": "boolean" }, "citations": { "type": "array" }, "disclaimer": { "type": "string" }, "facts_considered": { "type": "integer" }, "generated_by": { "enum": [ "model" ], "type": "string" }, "label": { "type": "string" }, "method_version": { "type": "string" }, "model": { "type": [ "string", "null" ] }, "question": { "type": "string" }, "related_facts": { "type": "array" }, "unverified_numbers": { "type": "array" }, "usage": { "properties": { "limit_today": { "type": "integer" }, "used_today": { "type": "integer" } }, "type": "object" }, "withheld_reason": { "type": [ "string", "null" ] } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return one issuer-filed document (from call_materials or issuer_releases) as ordered passages: section (prepared_remarks, qa, safe_harbor...), speaker, role, whether the speaker is company or analyst, topic tags and character offsets into the filed text. Filter with topic \"guidance\" for passages about outlook, \"kpi\" for operating metrics, or by section or speaker. Topic tags are keyword rules that say where to read, not extracted figures; quote the passage and cite its ref and source_url. Text is null when the filed document carries another party's copyright notice: follow source_url instead. Use it to read what management said in a filed document, passage by passage.", "inputSchema": { "additionalProperties": false, "examples": [ { "id": "doc_123", "topic": "guidance" }, { "id": "doc_123", "limit": 20, "section": "qa" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "id": { "description": "Document id, for example doc_123 (from call_materials or issuer_releases).", "pattern": "^(doc_)?[0-9]{1,18}$", "type": "string" }, "limit": { "default": 40, "description": "Maximum number of periods or items to return (default 40, at most 500).", "maximum": 500, "minimum": 1, "type": "integer" }, "section": { "description": "Only passages of this section.", "enum": [ "body", "prepared_remarks", "qa", "safe_harbor", "participants", "operator" ], "type": "string" }, "speaker": { "description": "Only passages whose speaker name contains this text.", "maxLength": 80, "minLength": 2, "type": "string" }, "topic": { "description": "Only passages tagged with this topic (guidance, results, kpi, capital_return...).", "pattern": "^[a-z_]{2,40}$", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "call_material", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ document: { id, kind, title, fiscal_period, accession, has_qa, text_served, third_party_notice, source_url, retrieved_at }, sections: [{ section, passages, speakers }], passages: [{ seq, section, speaker, speaker_role, speaker_kind, topics, char_start, char_end, text, ref }], next_cursor, related, note }", "properties": { "document": { "type": "object" }, "next_cursor": { "type": [ "string", "null" ] }, "note": { "type": "string" }, "passages": { "items": { "type": "object" }, "type": "array" }, "related": { "type": "object" }, "sections": { "items": { "type": "object" }, "type": "array" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "List what a company itself filed with the SEC around its earnings calls: earnings releases, prepared remarks, shareholder letters, presentations and any call transcript the issuer chose to file (8-K exhibit 99, Rule 425). Each document has its kind, fiscal period, whether it has a Q&A section, speaker count and link. Most issuers do not file a transcript, so expect prepared remarks and releases more often than full Q&A, and no webcast audio is transcribed. Use it to find what management said in its own filed words; then read passages with call_material.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL" }, { "company": "ticker:NFLX", "kind": "shareholder_letter" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "from": { "description": "Accepted on or after (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "kind": { "description": "Only documents of this kind.", "enum": [ "earnings_release", "prepared_remarks", "call_transcript", "shareholder_letter", "presentation" ], "type": "string" }, "limit": { "default": 20, "description": "Maximum number of periods or items to return (default 20, at most 200).", "maximum": 200, "minimum": 1, "type": "integer" }, "to": { "description": "Accepted on or before (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, "required": [ "company" ], "type": "object" }, "name": "call_materials", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ items: [{ id, kind, title, fiscal_period, accession, form, exhibit_type, filed, accepted_at, has_qa, speaker_count, passage_count, text_served, third_party_notice, classification, passages_url, source_url, retrieved_at }], next_cursor, related, note }", "properties": { "items": { "items": { "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "note": { "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return conference calls as issuers announce them in their own SEC filings, soonest first: the date, the time as the issuer stated it, the fiscal period, the issuer's own webcast page when the filing gives one, and the sentence that announces the call. Link and metadata only: no audio and no transcript. Defaults to a week back and about three months ahead. Use it for when a company's call is and where the issuer hosts it; for release dates use events_calendar.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL" }, { "from": "2026-11-01", "to": "2026-11-30" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "Optional: one company. 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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "from": { "description": "Calls on or after (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "limit": { "default": 20, "description": "Maximum number of periods or items to return (default 20, at most 200).", "maximum": 200, "minimum": 1, "type": "integer" }, "to": { "description": "Calls on or before (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, "required": [], "type": "object" }, "name": "calls_calendar", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ window: { from, to }, items: [{ id, company, call_date, call_at, time_stated, fiscal_period, webcast_url, dial_in_stated, announced_in: { accession, document, quote }, materials_filed, materials_url, source_url, retrieved_at }], next_cursor, note }", "properties": { "items": { "items": { "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "note": { "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "List facts whose knowledge interval opened since a timestamp: new periods from fresh filings and restatements of earlier periods. Each item has the company, the concept_id, the version number (1 for a first report, higher for a restatement) and the new value object with its period, known interval, restated flag and proof. This is the pull twin of the financial_data_updated webhook: poll it to keep a model, a cache or a watchlist current, or scope it to one company to see what changed in its history. Cursor paging via data.next_cursor.", "inputSchema": { "additionalProperties": false, "examples": [ { "limit": 50, "since": "2026-11-01T00:00:00Z" }, { "company": "ticker:AAPL", "since": "2026-10-01" } ], "properties": { "company": { "description": "Optional: only changes for this company.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "limit": { "default": 100, "description": "Maximum number of periods or items to return (default 100, at most 1000).", "maximum": 1000, "minimum": 1, "type": "integer" }, "since": { "description": "Return changes known since this instant (YYYY-MM-DD or RFC 3339 timestamp).", "examples": [ "2026-11-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" } }, "required": [ "since" ], "type": "object" }, "name": "changes_since", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ items: [{ company { fmd_id, cik, name }, concept_id, version, value (value object with period, known, restated, proof) }], next_cursor }.", "properties": { "items": { "items": { "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return FinancialMD's own forward estimates for a company: the next four quarters and two fiscal years of revenue, operating income, net income, diluted EPS and free cash flow, each a point with an 80 percent interval, computed from the company's SEC filings by the published method fmd-baseline-1 (the median of four seasonal components, moved to the company's own guidance midpoint where it gave one). These are NOT consensus and NOT analyst or Street estimates: always call them \"FinancialMD model-based baseline estimates\", never \"the estimate\" or \"expected by the market\". Every estimate carries generated_by: model, the proof ids of the facts it read, its components, and track_record: the error of the same method replayed over history using only facts known at each date (median_ape, wape against naive_wape, bias, interval_coverage), for this company and for all companies; quote the track record whenever you quote an estimate. data.guidance is what the company itself stated (range, basis GAAP or adjusted, the exact sentence, accession and character offsets). data.signals are rule-based descriptions: guidance raised, lowered or maintained against the prior statement, the direction of our own estimate revisions, and the reported result against the guided range and against our prior estimate. There are no ratings, no price targets and no advice here. as_of answers as known at that date. Use it for forward-looking questions, guidance, and whether a result came in above or below what the company guided.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL", "metric": "revenue" }, { "company": "DAL", "period_type": "annual" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "metric": { "description": "Only estimates of this line (guidance is always returned in full).", "enum": [ "revenue", "operating_income", "net_income", "eps_diluted", "free_cash_flow" ], "type": "string" }, "period_type": { "description": "Only quarterly or only fiscal-year estimates.", "enum": [ "quarterly", "annual" ], "type": "string" } }, "required": [ "company" ], "type": "object" }, "name": "company_estimates", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ generated_by: \"model\", label, method, estimates: [{ metric, period_type, fiscal_year, fiscal_period, value, interval, components, anchor, revision, input_fact_proofs, track_record }], guidance: [{ metric, low, mid, high, basis, source, change, result }], signals: [{ kind, direction, rule }], track_record, coverage_note, disclaimer }", "properties": { "coverage_note": { "type": [ "string", "null" ] }, "disclaimer": { "type": "string" }, "estimates": { "items": { "type": "object" }, "type": "array" }, "generated_by": { "type": "string" }, "guidance": { "items": { "type": "object" }, "type": "array" }, "label": { "type": "string" }, "method": { "type": "object" }, "signals": { "items": { "type": "object" }, "type": "array" }, "track_record": { "type": "object" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return the 8-K filings of a company, newest first, each with the items the filer selected (2.02 results, 5.02 officer changes, 1.01 agreements, 2.01 acquisitions, 4.02 non-reliance...) classified by event_type, with a headline and an importance from 1 to 5 (importance_min 4 keeps the major ones). A filing-based event feed, not wire news; for all companies use news; follow source_url for the text. Use it when asked what material events one company disclosed.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL", "limit": 10 } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "event_type": { "description": "Only filings with an item of this type (earnings, leadership_change, agreement, acquisition_disposition, restatement...).", "pattern": "^[a-z_]{2,40}$", "type": "string" }, "importance_min": { "default": 1, "description": "Only filings whose highest item is at least this important.", "maximum": 5, "minimum": 1, "type": "integer" }, "limit": { "default": 20, "description": "Maximum number of periods or items to return (default 20, at most 500).", "maximum": 500, "minimum": 1, "type": "integer" } }, "required": [ "company" ], "type": "object" }, "name": "company_events", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ items: [{ accession, form, filed, accepted_at, report_date, source_url, importance, headline, event_types, items: [{ item, title, event_type, importance }] }], next_cursor, note }", "properties": { "items": { "items": { "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "note": { "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return the metrics a company reports in its own earnings releases and reports: adjusted (non-GAAP) measures such as adjusted EBITDA or adjusted EPS, and operating KPIs such as segment or product sales. Each value carries the filer's row label, confidence (high: printed identically in two or more places; medium: printed once) and a proof id; proof_get on it returns the exact citation: accession, document, table, row and value index, character span, the raw printed text and the GAAP reconciliation table. Adjusted metrics are the company's own definitions: say \"as reported by the company (non-GAAP)\", never call them GAAP and never compare them across companies. Values two documents print differently are withheld and not returned (data.withheld counts them). data.metrics lists the company's metrics; filter with metric, kind, period_type, from and to. Percent metrics are percent points. Use it when the question is about a non-GAAP figure or an operating metric the standardized statements do not carry.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:MSFT", "kind": "adjusted", "limit": 10 }, { "company": "AAPL", "metric": "apple_iphone_net_sales" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "from": { "description": "First period end, inclusive (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "kind": { "description": "adjusted: non-GAAP measures; operating: operating statistics.", "enum": [ "adjusted", "operating" ], "type": "string" }, "limit": { "default": 50, "description": "Maximum number of periods or items to return (default 50, at most 1000).", "maximum": 1000, "minimum": 1, "type": "integer" }, "metric": { "description": "Only this metric slug (for example adjusted_ebitda); data.metrics lists them.", "pattern": "^[a-z][a-z0-9_]{1,80}$", "type": "string" }, "period_type": { "description": "Only this period type.", "enum": [ "annual", "quarterly", "point" ], "type": "string" }, "to": { "description": "Last period end, inclusive (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, "required": [ "company" ], "type": "object" }, "name": "company_kpis", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ items: [{ metric, reported_label, label, period_type, period_start, period_end, value, confidence, confidence_label, corroborated_by, reconciliation_anchor }], next_cursor, metrics, withheld, note }", "properties": { "items": { "items": { "type": "object" }, "type": "array" }, "metrics": { "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "note": { "type": "string" }, "withheld": { "type": "integer" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return the image that identifies a company and where it came from. kind wikimedia_commons: a logo file from Wikimedia Commons, taken only when it is public domain or under a verified open licence, with its author, licence, source page and the attribution line to show. kind generated: a monogram tile drawn from the ticker when no such file was accepted; it is not the company's mark. data.images holds SVG and PNG links (32 to 512 pixels). Logos are trademarks of their owners: use them only to identify the company, never to suggest endorsement. Use it when an interface needs a picture beside a company name.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL" } ], "properties": { "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "company" ], "type": "object" }, "name": "company_logo", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ kind, media_type, width, height, images: { svg, png: { \"128\": url } }, source: { file_page_url, author, licence: { id, name, url, pd_rationale }, retrieved_at }, match: { method, confidence }, attribution: { source, text, url }, generated: { generated_by, initials, colour, reason }, use_policy }", "properties": { "attribution": { "type": [ "object", "null" ] }, "generated": { "type": [ "object", "null" ] }, "images": { "type": "object" }, "kind": { "type": "string" }, "source": { "type": [ "object", "null" ] }, "use_policy": { "type": "object" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Resolve a ticker, CIK, FinancialMD id or company name to the company FinancialMD covers, so later calls can use a stable identifier. Identifiers (ticker:AAPL, cik:320193, fmd_...) resolve directly and return the profile with meta.company showing what matched; a free-text name searches the directory and returns candidates with their ids, tickers and listings. Use this first when you are not sure of the ticker, or when a ticker is ambiguous across exchanges (ticker:AAPL.XNAS pins the venue). Issuers on EU and UK regulated markets that do not file with the SEC are covered too: they have no CIK, each candidate carries registry \"esef\" and an lei, and later calls take lei:<LEI> or the fmd_id. Statements and filings work for them, in the reporting currency; ownership, prices, events and segments answer not_covered.", "inputSchema": { "additionalProperties": false, "examples": [ { "query": "AAPL" }, { "country": "US", "limit": 5, "query": "Berkshire Hathaway" } ], "properties": { "country": { "description": "Optional ISO 3166-1 alpha-2 filter for name searches.", "pattern": "^[A-Za-z]{2}$", "type": "string" }, "exchange": { "description": "Optional exchange MIC filter for name searches (for example XNAS, XNYS).", "pattern": "^[A-Za-z0-9]{4}$", "type": "string" }, "limit": { "default": 10, "description": "Maximum number of periods or items to return (default 10, at most 50).", "maximum": 50, "minimum": 1, "type": "integer" }, "query": { "description": "Ticker, \"cik:<n>\", \"lei:<LEI>\", \"fmd_<id>\", or a company name such as \"Apple\".", "examples": [ "AAPL", "cik:320193", "Berkshire Hathaway" ], "maxLength": 120, "minLength": 1, "type": "string" } }, "required": [ "query" ], "type": "object" }, "name": "company_lookup", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "For an identifier: the company profile. For a name: { items: [{ fmd_id, cik, name, country, registry, lei, reporting_template, status, primary_ticker, primary_mic, available_datasets }], next_cursor }.", "type": [ "object", "array" ] }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return the profile of one company: legal name, FinancialMD id, CIK, listings (ticker, exchange, currency), sector and industry, the statement template it is standardized with (for example industrial, bank, insurer), its fiscal year end, and the list of datasets available (which statements, ratios, filings, KPIs exist), the listing status (active, delisted with the date, or inactive), country and business address, former names, the newest head count with its source sentence (served only at confidence 0.90 or more) and cover-page shares per share class (never summed across classes). Call it before pulling statements to learn the template and fiscal calendar, and to confirm the identifier resolved to the right company.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL" }, { "company": "cik:1067983" } ], "properties": { "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "company" ], "type": "object" }, "name": "company_profile", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "Profile: fmd_id, cik, name, country, reporting_template, fiscal_year_end_month, status, sic_code, sector (SIC division), industry (SEC title of the SIC code), classification { scheme, sic_code, source_url, scheme_url } or null, listings (ticker, mic, currency, is_primary), available_datasets, updated_at, registry (sec, or esef for an EU or UK issuer), reporting_currency, accounting_standard, registrations [{ registry, local_id, id_kind, role, countries, source_url }].", "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return the AI-written report on a company (business, segments, financial trajectory, capital allocation, and risks taken from the filing's own risk factors) or, with artefact \"bull_bear\", its bull and bear cases. The text is written by a model from FinancialMD's standardized facts and the company's own SEC filings only: no outside research, no news, no price targets, no buy, sell or hold view, no advice. Every claim lists the fact proof ids behind its numbers and the filing passage it rests on (accession, section, character span, quotation); data.grounding counts claims, cited and verified. When you repeat any of it, say it is AI-written, keep the citations, and never present it as reported fact, as an analyst's estimate or rating, or as investment advice. data.quality_scores are descriptive bands computed by published formulas from our own ratios, not ratings. Reports are versioned and point-in-time (as_of); a company without a published report answers not_found with details.status. Use it for a cited plain-language overview of a company; for the numbers themselves call financials_standardized or ratios.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL" }, { "artefact": "bull_bear", "company": "ticker:KO" } ], "properties": { "artefact": { "description": "company_report (default) or bull_bear.", "enum": [ "company_report", "bull_bear" ], "type": "string" }, "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "company" ], "type": "object" }, "name": "company_research", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ artefact, version, generated_by: \"model\", model, method_version, generated_at, source_filings, disclaimer, sections: [{ key, claims: [{ text, facts, derived, passages, numbers }] }], grounding: { claims, cited, verified }, quality_scores, versions, filing_summaries } from GET /v1/company/research (company_report) or GET /v1/company/bull_bear (bull_bear).", "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "For one fiscal period of a company, compare every line item as first reported (the original filing) with its current value (after any restatement, reclassification or correction in later filings), with the proofs of both versions so each can be traced to its filing. The result lists each concept with first_reported, current, changed, delta and delta_percent, and counts how many items changed. Use it for restatement reviews, earnings-quality work and to explain why a number in an old report differs from today's database. Optionally restrict to one concept. Costs two standardized reads.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL", "fiscal_period": "FY", "fiscal_year": 2023, "statement": "income_statement" }, { "company": "cik:320193", "concept": "balance_sheet_total_assets", "fiscal_period": "Q2", "fiscal_year": 2024, "statement": "balance_sheet" } ], "properties": { "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "concept": { "description": "Optional: compare only this standardized concept id.", "pattern": "^[a-z][a-z0-9_]{1,80}$", "type": "string" }, "fiscal_period": { "description": "Fiscal period label: FY for the full year, or Q1, Q2, Q3, Q4.", "enum": [ "FY", "Q1", "Q2", "Q3", "Q4" ], "type": "string" }, "fiscal_year": { "description": "Fiscal year as the filer labels it (for example 2024 for Apple's year ending 2024-09-28).", "maximum": 2100, "minimum": 1990, "type": "integer" }, "period_type": { "description": "Period basis to search; defaults to annual for FY and quarterly for Q1 to Q4.", "enum": [ "annual", "quarterly", "ltm", "ytd" ], "type": "string" }, "statement": { "description": "Which financial statement.", "enum": [ "income_statement", "balance_sheet", "cash_flow" ], "type": "string" } }, "required": [ "company", "statement", "fiscal_year", "fiscal_period" ], "type": "object" }, "name": "compare_versions", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "statement, the matched period, rows with first_reported and current value objects (each with proof), changed_count and row_count.", "properties": { "changed_count": { "type": "integer" }, "current": { "type": "object" }, "original": { "type": "object" }, "period": { "type": "object" }, "row_count": { "type": "integer" }, "rows": { "items": { "properties": { "changed": { "type": "boolean" }, "concept_id": { "type": "string" }, "current": { "anyOf": [ { "description": "A proven number: value, unit, currency, decimals, period, known interval, restated, method, calc_type, proof.", "properties": { "calc_type": { "type": "string" }, "currency": { "type": [ "string", "null" ] }, "decimals": { "type": [ "integer", "null" ] }, "known": { "properties": { "from": { "type": "string" }, "to": { "type": [ "string", "null" ] } }, "type": "object" }, "method": { "type": "string" }, "period": { "type": "object" }, "proof": { "description": "Where a value comes from: filing accession, form, filing date, taxonomy and tag, source URL, page and anchor.", "properties": { "accession": { "type": "string" }, "anchor": { "type": [ "string", "null" ] }, "dims": {}, "filed": { "type": "string" }, "form": { "type": "string" }, "id": { "type": "string" }, "inputs": { "description": "For derived values (ratios): the proof ids of the inputs.", "items": { "type": "string" }, "type": "array" }, "page": { "type": [ "integer", "null" ] }, "source_url": { "type": "string" }, "tag": { "type": [ "string", "null" ] }, "taxonomy": { "type": [ "string", "null" ] } }, "type": "object" }, "restated": { "type": "boolean" }, "unit": { "type": "string" }, "value": { "type": [ "number", "null" ] } }, "type": "object" }, { "type": "null" } ] }, "delta": { "type": [ "number", "null" ] }, "delta_percent": { "type": [ "number", "null" ] }, "first_reported": { "anyOf": [ { "description": "A proven number: value, unit, currency, decimals, period, known interval, restated, method, calc_type, proof.", "properties": { "calc_type": { "type": "string" }, "currency": { "type": [ "string", "null" ] }, "decimals": { "type": [ "integer", "null" ] }, "known": { "properties": { "from": { "type": "string" }, "to": { "type": [ "string", "null" ] } }, "type": "object" }, "method": { "type": "string" }, "period": { "type": "object" }, "proof": { "description": "Where a value comes from: filing accession, form, filing date, taxonomy and tag, source URL, page and anchor.", "properties": { "accession": { "type": "string" }, "anchor": { "type": [ "string", "null" ] }, "dims": {}, "filed": { "type": "string" }, "form": { "type": "string" }, "id": { "type": "string" }, "inputs": { "description": "For derived values (ratios): the proof ids of the inputs.", "items": { "type": "string" }, "type": "array" }, "page": { "type": [ "integer", "null" ] }, "source_url": { "type": "string" }, "tag": { "type": [ "string", "null" ] }, "taxonomy": { "type": [ "string", "null" ] } }, "type": "object" }, "restated": { "type": "boolean" }, "unit": { "type": "string" }, "value": { "type": [ "number", "null" ] } }, "type": "object" }, { "type": "null" } ] }, "label": { "type": "string" } }, "required": [ "concept_id", "first_reported", "current", "changed" ], "type": "object" }, "type": "array" }, "statement": { "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return a company's stock splits (as reported in XBRL, with whether IEX prices across the ex-date confirm the ratio) and its dividends per share declared or paid in each fiscal period, as filed. A dividend row is a per-period total, not one payment, and has no ex-date. Every value carries the XBRL fact as proof. For split-adjusted prices call stock_prices with adjust \"splits\". Use it to check for a stock split before comparing per-share figures or prices across dates.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "kind": { "description": "Only declared or only paid dividends.", "enum": [ "declared", "paid" ], "type": "string" }, "limit": { "default": 12, "description": "Maximum number of periods or items to return (default 12, at most 400).", "maximum": 400, "minimum": 1, "type": "integer" } }, "required": [ "company" ], "type": "object" }, "name": "corporate_actions", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ splits: { items }, dividends: { items } } from GET /v1/company/splits and /v1/company/dividends.", "properties": { "dividends": { "type": "object" }, "splits": { "type": "object" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Say whether FinancialMD serves a dataset, and if not, why and what to use instead. Call it before searching for data that may not be here: Street consensus estimates, consensus EPS and revenue estimates, analyst ratings, price targets, earnings call transcripts and audio, real-time, intraday or consolidated prices, CUSIP or ISIN, Morningstar research, wire news and mutual fund NAV are not served (licensed, not built, or waiting on a decision). For forward numbers FinancialMD serves its own model-based estimates and company guidance (company_estimates), which are not consensus. With no topic it lists every dataset with its routes and tools.", "inputSchema": { "additionalProperties": false, "examples": [ { "topic": "consensus estimates" }, { "status": "conceded" } ], "properties": { "status": { "description": "Only datasets with this status.", "enum": [ "served", "conceded", "not_built", "founder_decision" ], "type": "string" }, "topic": { "description": "What you are looking for, in a few words (for example \"consensus estimates\", \"transcripts\", \"intraday prices\", \"segments\").", "maxLength": 80, "minLength": 2, "type": "string" } }, "required": [], "type": "object" }, "name": "coverage", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ datasets: [{ id, name, status, routes, mcp_tools, reason, licence, alternatives }], note, free_coverage?: { as_of, companies: [{ cik, ticker, name }], funds: [{ cik, name }] } }", "properties": { "datasets": { "items": { "type": "object" }, "type": "array" }, "free_coverage": { "type": "object" }, "note": { "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return a company's cash dividends per share as its SEC filings state them, newest first: amount (on the basis of the day declared, not split-adjusted), declaration, record, ex-dividend and payment dates, each null when the filing does not state it, with how each was captured (xbrl date tags, a dividend table or a sentence) and the citation text. ex_date_method says whether the ex-date is stated or derived from the record date by the settlement rule. When EDGAR states no record date (JPMorgan after 2018) or only the month paid (Realty Income), there is no ex-date: say so and do not make one up. Dividends announced only on a company's website are absent. For split-adjusted and total-return prices call stock_prices with adjust. Use it for dividend history, ex-dividend dates and payment dates.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "MSFT", "limit": 8 } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "from": { "description": "First date, inclusive (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "limit": { "default": 12, "description": "Maximum number of periods or items to return (default 12, at most 500).", "maximum": 500, "minimum": 1, "type": "integer" }, "to": { "description": "Last date, inclusive (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, "required": [ "company" ], "type": "object" }, "name": "dividends", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ items: [{ kind, share_class, amount, declared_date, record_date, ex_date, ex_date_method, ex_date_note, pay_date, pay_month, pay_note, method, citation, document, source_url }], note }", "properties": { "items": { "items": { "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "note": { "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return FinancialMD's own company events, newest first, across all companies or one. Built only from SEC filings as EDGAR accepts them: 8-K and 6-K (earnings, restatements, officer changes, M&A, bankruptcy...), Schedule 13D and 13G stakes, Rule 425 merger communications, late-filing notices (NT 10-K), S-1 registrations and clusters of insider purchases. Each event has a type, an importance from 1 to 5 with the rule that set it, a headline FinancialMD generates by rule from the filing's own facts (labelled, never a wire headline), key numbers quoted with their passage, and the filing link. Amendments fold under the original. Use it for what happened at a company or across the market; it is not wire news.", "inputSchema": { "additionalProperties": false, "examples": [ { "importance_min": 4, "limit": 10 }, { "company": "ticker:AAPL", "event_type": "leadership_change" } ], "properties": { "amendments": { "default": "collapse", "description": "collapse lists an amendment under its original (amended_by); all shows every filing as its own event.", "enum": [ "collapse", "all" ], "type": "string" }, "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "Optional: one company. 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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "event_type": { "description": "Only events of this type (earnings, restatement, leadership_change, acquisition_disposition, bankruptcy, activist_stake, passive_stake, merger_communication, late_filing, registration, insider_buying_cluster...).", "pattern": "^[a-z_]{2,40}$", "type": "string" }, "form": { "description": "Only events from this form, for example 8-K, 6-K, 13D, 13G, 425, NT 10-K, S-1.", "pattern": "^[A-Za-z0-9 \\-]{1,20}$", "type": "string" }, "from": { "description": "Accepted on or after (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "importance_min": { "default": 1, "description": "Only events at least this important (5 critical, 4 major, 3 notable, 2 routine, 1 minor).", "maximum": 5, "minimum": 1, "type": "integer" }, "limit": { "default": 20, "description": "Maximum number of periods or items to return (default 20, at most 200).", "maximum": 200, "minimum": 1, "type": "integer" }, "to": { "description": "Accepted on or before (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, "required": [], "type": "object" }, "name": "event_feed", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ items: [{ id, company, event_type, event_types, importance, importance_rule, headline, headline_generated_by, headline_method, form, items, accession, amended_by, party_role, counterparty, filed, accepted_at, key_numbers: [{ label, value, unit, quote, document_url, char_start, char_end }], exhibits, source_url, retrieved_at }], next_cursor, note }", "properties": { "items": { "items": { "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "note": { "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return earnings-release dates for one company or every company: confirmed dates are when an 8-K with Item 2.02 (results of operations) was accepted, with session bmo, dmh or amc; predicted dates are a model (the release a year earlier plus 364 days), labelled \"expected (model)\". Without from or to the window starts 30 days before as_of. Do not call a confirmed date an earnings call. Use it when asked when a company reports results, or which companies report in a window.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL" }, { "confidence": "predicted", "from": "2026-11-12", "to": "2026-11-19" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "confidence": { "description": "confirmed: an 8-K Item 2.02 was filed; predicted: the cadence model.", "enum": [ "confirmed", "predicted" ], "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "from": { "description": "First date, inclusive (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "limit": { "default": 50, "description": "Maximum number of periods or items to return (default 50, at most 1000).", "maximum": 1000, "minimum": 1, "type": "integer" }, "to": { "description": "Last date, inclusive (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, "required": [], "type": "object" }, "name": "events_calendar", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ items: [{ company, event_type, date, session, confidence, label, fiscal_period, proof, known }], next_cursor, note }", "properties": { "items": { "items": { "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "note": { "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return where a filing's documents are: the primary document on EDGAR, the filing index, the full submission text, the inline XBRL viewer, a FinancialMD URL that serves the primary HTML document, and URLs for the same document as a PDF with selectable text and as page images. format \"pages\" renders the PDF if needed and returns its page count; add page to get the URL of that page's PNG image, so an answer can cite a page. The first render of a document can take some seconds; an upstream_unavailable error with a retry time means it is still rendering. A document past the rendering limits answers not_covered with the EDGAR link. Use it when you need to read, link or cite a page of the text of a filing.", "inputSchema": { "additionalProperties": false, "examples": [ { "accession": "0000320193-24-000123" }, { "accession": "0000320193-24-000123", "page": 12 } ], "properties": { "accession": { "description": "Accession number, e.g. 0000320193-24-000123.", "pattern": "^\\d{10}-\\d{2}-\\d{6}$", "type": "string" }, "format": { "description": "links (default): the document URLs. pages: the PDF page count and its URLs.", "enum": [ "links", "pages" ], "type": "string" }, "page": { "description": "A page number of the PDF, from 1. Implies format \"pages\"; the answer names that page's image URL.", "maximum": 1500, "minimum": 1, "type": "integer" } }, "required": [ "accession" ], "type": "object" }, "name": "filing_document", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "links: { accession, registry, form, filed, primary_doc, document_url, index_url, full_text_url, inline_xbrl_viewer_url, html_url, pdf: { available, url, pages_url, page_image_url_template, note } }. pages: { accession, form, filed, document_url, pages, pdf_url, pdf_bytes, page_image_url_template, page_image, images_inlined, images_skipped, render_version, rendered_at }", "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return every fact one filing tagged that maps to a FinancialMD concept, across all statements in one call: income statement, balance sheet, cash flow and supplemental (share counts, per-share figures), each in display order with the newest period first. Each fact is a value object with the filer's XBRL taxonomy, tag and dimensions, the concept it maps to, its label, and a proof pointing at the page and anchor in the filing. Prior-year comparatives printed in the filing are included (their fiscal labels are null). Tags without a mapping (company extensions) are not included. Use it to read a filing end to end instead of calling financials_as_reported once per statement.", "inputSchema": { "additionalProperties": false, "examples": [ { "accession": "0000320193-24-000123" }, { "accession": "0000320193-24-000123", "limit": 200, "statement": "balance_sheet" } ], "properties": { "accession": { "description": "SEC accession number in dashed form, for example 0000320193-24-000123.", "examples": [ "0000320193-24-000123" ], "pattern": "^\\d{10}-\\d{2}-\\d{6}$", "type": "string" }, "limit": { "default": 2000, "description": "Maximum number of periods or items to return (default 2000, at most 5000).", "maximum": 5000, "minimum": 1, "type": "integer" }, "statement": { "description": "Optional: only facts of this statement.", "enum": [ "income_statement", "balance_sheet", "cash_flow", "supplemental" ], "type": "string" } }, "required": [ "accession" ], "type": "object" }, "name": "filing_facts", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ filing (summary, company, fact_count), statements: [{ statement, facts: [value object + taxonomy, tag, dims, is_instant, label, concept_id, display_order, is_subtotal] }], returned, truncated }.", "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return one filing by its SEC accession number: registry, form, period end, fiscal year and period, filing date and acceptance time, the primary document name and its SEC source URL, and the accession it amends (for 10-K/A and 10-Q/A). The document itself is not returned (it can be megabytes); read it from source_url, and read its numbers with financials_as_reported. Use it when you hold an accession number and need the filing's form, dates and source URL.", "inputSchema": { "additionalProperties": false, "examples": [ { "accession": "0000320193-24-000123" } ], "properties": { "accession": { "description": "SEC accession number in dashed form, for example 0000320193-24-000123.", "examples": [ "0000320193-24-000123" ], "pattern": "^\\d{10}-\\d{2}-\\d{6}$", "type": "string" } }, "required": [ "accession" ], "type": "object" }, "name": "filing_get", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "The filing: accession, registry, form, period_end, fiscal_year, fiscal_period, filed, accepted_at, primary_doc, source_url, amends, pipeline_version.", "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Keyword search across the text of EDGAR documents filed since 2001 (10-K, 10-Q, 8-K and their exhibits, proxies, S-1s...) through SEC EDGAR full-text search. Put a phrase in double quotes. Returns documents, best match first, each with its form, filing date, the companies on it (FinancialMD ids where covered) and links to the document and the filing index. Use it to find which companies mention a risk, customer, product or term; then read numbers with financials_standardized or the document with filing_document.", "inputSchema": { "additionalProperties": false, "examples": [ { "forms": "10-K", "from": "2026-01-01", "q": "\"going concern\"" }, { "company": "ticker:AAPL", "q": "tariffs" } ], "properties": { "company": { "description": "Optional: only this company's documents. 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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "forms": { "description": "Comma-separated form types, for example \"10-K,10-Q\".", "pattern": "^[A-Za-z0-9/\\- ]{1,20}(,[A-Za-z0-9/\\- ]{1,20}){0,9}$", "type": "string" }, "from": { "description": "Filed on or after (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "limit": { "default": 10, "description": "Maximum number of periods or items to return (default 10, at most 100).", "maximum": 100, "minimum": 1, "type": "integer" }, "page": { "default": 1, "description": "Page number, 1-based.", "maximum": 100, "minimum": 1, "type": "integer" }, "q": { "description": "Words to find; a phrase in double quotes matches exactly. Letters, digits, spaces and common punctuation.", "maxLength": 200, "minLength": 2, "type": "string" }, "to": { "description": "Filed on or before (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, "required": [ "q" ], "type": "object" }, "name": "filing_search", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ total, items: [{ accession, form, file_type, filed, period_ending, companies: [{ cik, name, fmd_id, ticker }], document_url, index_url }], next_page, source }", "properties": { "items": { "items": { "type": "object" }, "type": "array" }, "next_page": { "type": [ "integer", "null" ] }, "source": { "type": "object" }, "total": { "type": "integer" }, "total_relation": { "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return the AI-written summary of one 10-K, 10-Q, 8-K or 20-F: its key points, financial highlights and the risks or events it reports. The text is written by a model from FinancialMD's standardized facts and the company's own SEC filings only: no outside research, no news, no price targets, no buy, sell or hold view, no advice. Every claim lists the fact proof ids behind its numbers and the filing passage it rests on (accession, section, character span, quotation); data.grounding counts claims, cited and verified. When you repeat any of it, say it is AI-written, keep the citations, and never present it as reported fact, as an analyst's estimate or rating, or as investment advice. Other forms are not summarised, and a filing without a published summary answers not_found with details.status. Use it to see what a filing says before reading it; filing_document gives the filing itself.", "inputSchema": { "additionalProperties": false, "examples": [ { "accession": "0000320193-24-000123" } ], "properties": { "accession": { "description": "Accession number, e.g. 0000320193-24-000123.", "pattern": "^\\d{10}-\\d{2}-\\d{6}$", "type": "string" }, "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" } }, "required": [ "accession" ], "type": "object" }, "name": "filing_summary", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ filing: { accession, form, filed, accepted_at, source_url }, artefact: \"filing_summary\", version, generated_by: \"model\", model, method_version, generated_at, disclaimer, sections, grounding: { claims, cited, verified }, versions } from GET /v1/filing/{accession}/summary.", "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "List a company's filings newest first: accession number, form type (10-K, 10-Q, 8-K, 20-F, 40-F, 6-K and others), filing date, acceptance time, period end, fiscal year and period, the primary document and its SEC URL, and the filing it amends. Filter by form; as_of limits the list to filings known on a date; cursor pages through long histories. Use filing_get for one filing's details and financials_as_reported to read its numbers.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL", "form": "10-K", "limit": 5 }, { "as_of": "2020-01-01", "company": "cik:320193", "limit": 20 } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "form": { "description": "Optional form type filter, for example \"10-K\", \"10-Q\", \"8-K\", \"20-F\".", "examples": [ "10-K", "10-Q" ], "pattern": "^[0-9A-Za-z\\-/]{1,12}$", "type": "string" }, "limit": { "default": 50, "description": "Maximum number of periods or items to return (default 50, at most 500).", "maximum": 500, "minimum": 1, "type": "integer" } }, "required": [ "company" ], "type": "object" }, "name": "filings_list", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ items: [{ accession, registry, form, period_end, fiscal_year, fiscal_period, filed, accepted_at, primary_doc, source_url, amends, pipeline_version }], next_cursor }.", "properties": { "items": { "items": { "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return a statement exactly as the filer presented it: the company's own line-item labels, XBRL taxonomy and tags, dimensions, and the values with proof. Use it when the standardized template hides a detail you need (an unusual line, a segment axis, a footnote-level item) or when you must quote the filer's own wording. Supports as_of for point-in-time replay.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL", "limit": 2, "period_type": "annual", "statement": "income_statement" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "history": { "default": false, "description": "Return every filing's version of each cell ({ versions }, oldest first) instead of the latest one.", "type": "boolean" }, "limit": { "default": 4, "description": "Maximum number of periods or items to return (default 4, at most 40).", "maximum": 40, "minimum": 1, "type": "integer" }, "period_type": { "default": "annual", "description": "Period basis: annual, quarterly or semi_annual (half years; as-reported facts are not derived into ltm or ytd).", "enum": [ "annual", "quarterly", "semi_annual" ], "type": "string" }, "statement": { "description": "Which financial statement.", "enum": [ "income_statement", "balance_sheet", "cash_flow" ], "type": "string" } }, "required": [ "company", "statement" ], "type": "object" }, "name": "financials_as_reported", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "The as-reported grid: periods (most recent first) and one row per filed line { taxonomy, tag, label, dims, unit, display_order, is_subtotal, concept_id, cells }.", "properties": { "currency": { "type": [ "string", "null" ] }, "period_type": { "type": "string" }, "periods": { "items": { "type": "object" }, "type": "array" }, "rows": { "items": { "properties": { "cells": { "items": { "anyOf": [ { "description": "A proven number: value, unit, currency, decimals, period, known interval, restated, method, calc_type, proof.", "properties": { "calc_type": { "type": "string" }, "currency": { "type": [ "string", "null" ] }, "decimals": { "type": [ "integer", "null" ] }, "known": { "properties": { "from": { "type": "string" }, "to": { "type": [ "string", "null" ] } }, "type": "object" }, "method": { "type": "string" }, "period": { "type": "object" }, "proof": { "description": "Where a value comes from: filing accession, form, filing date, taxonomy and tag, source URL, page and anchor.", "properties": { "accession": { "type": "string" }, "anchor": { "type": [ "string", "null" ] }, "dims": {}, "filed": { "type": "string" }, "form": { "type": "string" }, "id": { "type": "string" }, "inputs": { "description": "For derived values (ratios): the proof ids of the inputs.", "items": { "type": "string" }, "type": "array" }, "page": { "type": [ "integer", "null" ] }, "source_url": { "type": "string" }, "tag": { "type": [ "string", "null" ] }, "taxonomy": { "type": [ "string", "null" ] } }, "type": "object" }, "restated": { "type": "boolean" }, "unit": { "type": "string" }, "value": { "type": [ "number", "null" ] } }, "type": "object" }, { "type": "null" }, { "properties": { "versions": { "items": { "description": "A proven number: value, unit, currency, decimals, period, known interval, restated, method, calc_type, proof.", "properties": { "calc_type": { "type": "string" }, "currency": { "type": [ "string", "null" ] }, "decimals": { "type": [ "integer", "null" ] }, "known": { "properties": { "from": { "type": "string" }, "to": { "type": [ "string", "null" ] } }, "type": "object" }, "method": { "type": "string" }, "period": { "type": "object" }, "proof": { "description": "Where a value comes from: filing accession, form, filing date, taxonomy and tag, source URL, page and anchor.", "properties": { "accession": { "type": "string" }, "anchor": { "type": [ "string", "null" ] }, "dims": {}, "filed": { "type": "string" }, "form": { "type": "string" }, "id": { "type": "string" }, "inputs": { "description": "For derived values (ratios): the proof ids of the inputs.", "items": { "type": "string" }, "type": "array" }, "page": { "type": [ "integer", "null" ] }, "source_url": { "type": "string" }, "tag": { "type": [ "string", "null" ] }, "taxonomy": { "type": [ "string", "null" ] } }, "type": "object" }, "restated": { "type": "boolean" }, "unit": { "type": "string" }, "value": { "type": [ "number", "null" ] } }, "type": "object" }, "type": "array" } }, "required": [ "versions" ], "type": "object" } ], "description": "A value object, null when the concept has no value for the period, or { versions: [...] } oldest first with history=true." }, "type": "array" }, "concept_id": { "type": [ "string", "null" ] }, "dims": { "type": [ "object", "null" ] }, "display_order": { "type": "integer" }, "fiscal_alias": { "deprecated": true, "description": "Deprecated twin of metric_alias, served for one more release.", "type": [ "string", "null" ] }, "formula": { "type": [ "string", "null" ] }, "is_subtotal": { "type": "boolean" }, "label": { "type": "string" }, "metric_alias": { "type": [ "string", "null" ] }, "metric_format": { "type": "string" }, "tag": { "type": "string" }, "taxonomy": { "type": "string" }, "unit": { "type": "string" } }, "required": [ "cells" ], "type": "object" }, "type": "array" }, "statement": { "type": "string" }, "view": { "enum": [ "current", "as_of", "original", "history" ], "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return one standardized statement (income statement, balance sheet, cash flow, or the supplemental statement with share counts and per-share figures) for a company, mapped to the FinancialMD concept template so line items are comparable across companies. Choose annual, quarterly, ltm or ytd periods and how many. Every cell is a value object with unit, currency, period, the known interval (when FinancialMD first and last knew this value), a restated flag and a proof that points at the filing, page and XBRL tag. as_of replays the statement as it was known on a date; original=true returns the first-reported version of each period; history=true returns every knowledge version of each period, oldest first, so restatements are visible. Use it for comparable statement numbers, trends over periods and the inputs of a model.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL", "limit": 5, "period_type": "annual", "statement": "income_statement" }, { "as_of": "2024-12-31", "company": "cik:320193", "period_type": "quarterly", "statement": "balance_sheet" }, { "company": "ticker:MSFT", "history": true, "limit": 3, "period_type": "annual", "statement": "cash_flow" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "history": { "default": false, "description": "Return every knowledge version of each period (oldest first). Mutually exclusive with original.", "type": "boolean" }, "limit": { "default": 10, "description": "Maximum number of periods or items to return (default 10, at most 200).", "maximum": 200, "minimum": 1, "type": "integer" }, "original": { "default": false, "description": "Return the first-reported value of each period instead of the current one.", "type": "boolean" }, "period_type": { "default": "annual", "description": "Period basis: annual (fiscal years), quarterly, semi_annual (half years: foreign filers that report on Form 20-F and furnish half-year figures on Form 6-K), ltm (last twelve months) or ytd (year to date). When a grid is empty, data.notes says why and meta.remedies names the calls that have rows.", "enum": [ "annual", "quarterly", "semi_annual", "ltm", "ytd" ], "type": "string" }, "statement": { "description": "Which financial statement. supplemental carries share counts (outstanding, weighted average) and per-share figures.", "enum": [ "income_statement", "balance_sheet", "cash_flow", "supplemental" ], "type": "string" } }, "required": [ "company", "statement" ], "type": "object" }, "name": "financials_standardized", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "The standardized statement grid: periods (most recent first) and rows with cells aligned to them.", "properties": { "currency": { "type": [ "string", "null" ] }, "period_type": { "type": "string" }, "periods": { "items": { "type": "object" }, "type": "array" }, "rows": { "items": { "properties": { "cells": { "items": { "anyOf": [ { "description": "A proven number: value, unit, currency, decimals, period, known interval, restated, method, calc_type, proof.", "properties": { "calc_type": { "type": "string" }, "currency": { "type": [ "string", "null" ] }, "decimals": { "type": [ "integer", "null" ] }, "known": { "properties": { "from": { "type": "string" }, "to": { "type": [ "string", "null" ] } }, "type": "object" }, "method": { "type": "string" }, "period": { "type": "object" }, "proof": { "description": "Where a value comes from: filing accession, form, filing date, taxonomy and tag, source URL, page and anchor.", "properties": { "accession": { "type": "string" }, "anchor": { "type": [ "string", "null" ] }, "dims": {}, "filed": { "type": "string" }, "form": { "type": "string" }, "id": { "type": "string" }, "inputs": { "description": "For derived values (ratios): the proof ids of the inputs.", "items": { "type": "string" }, "type": "array" }, "page": { "type": [ "integer", "null" ] }, "source_url": { "type": "string" }, "tag": { "type": [ "string", "null" ] }, "taxonomy": { "type": [ "string", "null" ] } }, "type": "object" }, "restated": { "type": "boolean" }, "unit": { "type": "string" }, "value": { "type": [ "number", "null" ] } }, "type": "object" }, { "type": "null" }, { "properties": { "versions": { "items": { "description": "A proven number: value, unit, currency, decimals, period, known interval, restated, method, calc_type, proof.", "properties": { "calc_type": { "type": "string" }, "currency": { "type": [ "string", "null" ] }, "decimals": { "type": [ "integer", "null" ] }, "known": { "properties": { "from": { "type": "string" }, "to": { "type": [ "string", "null" ] } }, "type": "object" }, "method": { "type": "string" }, "period": { "type": "object" }, "proof": { "description": "Where a value comes from: filing accession, form, filing date, taxonomy and tag, source URL, page and anchor.", "properties": { "accession": { "type": "string" }, "anchor": { "type": [ "string", "null" ] }, "dims": {}, "filed": { "type": "string" }, "form": { "type": "string" }, "id": { "type": "string" }, "inputs": { "description": "For derived values (ratios): the proof ids of the inputs.", "items": { "type": "string" }, "type": "array" }, "page": { "type": [ "integer", "null" ] }, "source_url": { "type": "string" }, "tag": { "type": [ "string", "null" ] }, "taxonomy": { "type": [ "string", "null" ] } }, "type": "object" }, "restated": { "type": "boolean" }, "unit": { "type": "string" }, "value": { "type": [ "number", "null" ] } }, "type": "object" }, "type": "array" } }, "required": [ "versions" ], "type": "object" } ], "description": "A value object, null when the concept has no value for the period, or { versions: [...] } oldest first with history=true." }, "type": "array" }, "concept_id": { "type": [ "string", "null" ] }, "dims": { "type": [ "object", "null" ] }, "display_order": { "type": "integer" }, "fiscal_alias": { "deprecated": true, "description": "Deprecated twin of metric_alias, served for one more release.", "type": [ "string", "null" ] }, "formula": { "type": [ "string", "null" ] }, "is_subtotal": { "type": "boolean" }, "label": { "type": "string" }, "metric_alias": { "type": [ "string", "null" ] }, "metric_format": { "type": "string" }, "tag": { "type": "string" }, "taxonomy": { "type": "string" }, "unit": { "type": "string" } }, "required": [ "cells" ], "type": "object" }, "type": "array" }, "statement": { "type": "string" }, "view": { "enum": [ "current", "as_of", "original", "history" ], "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return forward valuation ratios for the next one or two fiscal years: forward P/E, P/S, EV/EBIT, earnings yield and free cash flow yield. The denominators are FinancialMD's own model-based estimates (method fmd-baseline-1, computed only from the company's SEC filings and its own guidance); the numerator is the market capitalisation or enterprise value at the newest end-of-day close held (one venue). Each ratio carries the estimate, its interval and the estimate's track record. These are model output: not consensus, not analyst or Street figures, not advice. When you repeat a value, say it is FinancialMD's model-based forward ratio. A company with no estimate or no price basis answers not_found with the reason. Use it when asked for a forward multiple.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "ticker": { "description": "One listing of the company; default the primary listing.", "maxLength": 12, "type": "string" } }, "required": [ "company" ], "type": "object" }, "name": "forward_ratios", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ generated_by \"model\", label, method { version, estimates, docs, summary }, price_session, listing, fiscal_years, items: [{ ratio_id, label, formula, fiscal_year, generated_by, model, value, interval { low, high, level }, unavailable, basis { id, value }, estimate { metric, value, interval, anchor, track_record } }], disclaimer }", "properties": { "disclaimer": { "type": "string" }, "fiscal_years": { "type": "array" }, "generated_by": { "type": "string" }, "items": { "type": "array" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return the mutual funds and ETFs (Form N-PORT series) holding a company in their latest report, largest position first: value in USD, shares, percent of the fund's net assets (a fraction), report month end, with the filing as proof. Complements institutional_holders (13F managers). Only the latest report per fund in each quarterly SEC data set is loaded. Use it when asked which funds hold a company.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:MSFT" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "limit": { "default": 20, "description": "Maximum number of periods or items to return (default 20, at most 500).", "maximum": 500, "minimum": 1, "type": "integer" }, "period": { "description": "Report window ending on or before (default the newest) (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, "required": [ "company" ], "type": "object" }, "name": "fund_holders", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ items: [{ fund, company, report_period, security, value, balance, percent_of_net_assets }], next_cursor, note }", "properties": { "items": { "items": { "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "note": { "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return one fund's Form N-PORT portfolio: give a series id (S000002277) or a fund name, which is searched first. Positions are largest first with value in USD, balance, percent of net assets and the company when the CUSIP maps to one; data.periods lists other report months. Use it when asked what a fund holds.", "inputSchema": { "additionalProperties": false, "examples": [ { "fund": "Vanguard 500 Index", "limit": 10 } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "fund": { "description": "Series id S000... or a fund name such as \"Vanguard 500 Index\".", "maxLength": 80, "minLength": 2, "type": "string" }, "limit": { "default": 25, "description": "Maximum number of periods or items to return (default 25, at most 1000).", "maximum": 1000, "minimum": 1, "type": "integer" }, "period": { "description": "Report month end; default the newest (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, "required": [ "fund" ], "type": "object" }, "name": "fund_holdings", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ fund, period, periods, items: [holdings], next_cursor, note }", "properties": { "fund": { "type": "object" }, "items": { "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "period": { "type": [ "string", "null" ] }, "periods": { "type": "array" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return the companies named across indexed fund letters, most letters first, each with the number of letters and writers that name it and a count by stated stance (new_position, added, held, trimmed, exited, short, watching, mentioned). Narrow with investor (a registrant CIK), stance and a publication date range. It is an index with links: no letter text is returned. Stances and counts are FinancialMD's reading of the letters (by rule or by a named model), not the manager's statement and not advice. Use it to see which companies fund managers are writing about; then call fund_letters with company for the letters that name one.", "inputSchema": { "additionalProperties": false, "examples": [ { "from": "2026-01-01", "stance": "new_position" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "from": { "description": "Published on or after (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "investor": { "description": "Only letters filed by this registrant CIK.", "pattern": "^[0-9]{1,10}$", "type": "string" }, "limit": { "default": 10, "description": "Maximum number of periods or items to return (default 10, at most 100).", "maximum": 100, "minimum": 1, "type": "integer" }, "stance": { "description": "Only mentions with this stance.", "enum": [ "new_position", "added", "held", "trimmed", "exited", "short", "watching", "mentioned" ], "type": "string" }, "to": { "description": "Published on or before (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, "required": [], "type": "object" }, "name": "fund_letter_companies", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ items: [{ company { fmd_id, cik, name, ticker }, letters, investors, first_published, latest_published, stances { <stance>: letters }, links }], next_cursor, note }", "properties": { "items": { "items": { "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "note": { "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return who writes the fund letters in the index. Without cik: the SEC registrants (usually fund trusts) whose N-CSR and N-CSRS reports hold indexed letters, newest letter first, each with letter, fund and named-company counts; q searches the registrant, manager or fund name. With cik: one writer's profile, its ten newest letters with links and the companies its letters name most, with stance counts. It is an index with links: no letter text is returned. Stances and counts are FinancialMD's reading of the letters (by rule or by a named model), not the manager's statement and not advice. Use it to find a fund family's letters or what companies a writer discusses; then call fund_letters with cik for the letters themselves.", "inputSchema": { "additionalProperties": false, "examples": [ { "q": "Sequoia" }, { "cik": "89043" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "cik": { "description": "Registrant CIK for one writer's profile; omit to list writers.", "pattern": "^[0-9]{1,10}$", "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "limit": { "default": 10, "description": "Maximum number of periods or items to return (default 10, at most 100).", "maximum": 100, "minimum": 1, "type": "integer" }, "q": { "description": "List only: part of the registrant, manager or fund name.", "maxLength": 80, "minLength": 2, "type": "string" } }, "required": [], "type": "object" }, "name": "fund_letter_investors", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "List: { items: [{ id, registrant_cik, name, manager, manager_slug, filer_cik, letters, funds, companies_named, first_published, latest_published, links }], next_cursor, note }. With cik: the same fields for one writer plus recent_letters: [{ id, kind, title, fund, period_end, published, source_url }] and companies: [{ company, letters, investors, stances }].", "properties": { "items": { "items": { "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "note": { "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return fund shareholder letters and performance discussions found inside SEC N-CSR and N-CSRS filings, newest first: the fund, the manager, the period, the link to the document on EDGAR, where the section is and its hash, the returns the letter states for the fund, and the companies it names with a stance (new_position, added, held, trimmed, exited, short, watching or mentioned), topic tags and at most one short attributed quote. It is an index, not an archive: no letter text is returned, so follow source.url to read the letter. Mentions are FinancialMD's rule-based reading (generated_by, method_version, confidence), not the manager's statement and not advice. Use it to find which funds wrote about a company, or what one fund or manager wrote in a period.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL", "limit": 10 }, { "manager": "Ruane", "period": "2025" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "cik": { "description": "CIK of the registrant that filed the report, or of the manager's 13F filer.", "pattern": "^[0-9]{1,10}$", "type": "string" }, "company": { "description": "Optional: only letters that name this company. 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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "from": { "description": "Published on or after (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "fund": { "description": "A fund series id (S000012345) or part of the fund or registrant name.", "maxLength": 80, "minLength": 2, "type": "string" }, "kind": { "description": "Only sections of this kind. A performance_discussion is the short management discussion in a tailored shareholder report.", "enum": [ "shareholder_letter", "performance_discussion", "manager_letter" ], "type": "string" }, "limit": { "default": 10, "description": "Maximum number of periods or items to return (default 10, at most 100).", "maximum": 100, "minimum": 1, "type": "integer" }, "manager": { "description": "Part of the manager, adviser or signatory name.", "maxLength": 80, "minLength": 2, "type": "string" }, "period": { "description": "Report period: a year (2025) or the exact period end date (2025-12-31).", "pattern": "^[0-9]{4}(-[0-9]{2}-[0-9]{2})?$", "type": "string" }, "stance": { "description": "With company: only letters where the mention has this stance.", "enum": [ "new_position", "added", "held", "trimmed", "exited", "short", "watching", "mentioned" ], "type": "string" }, "to": { "description": "Published on or before (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, "required": [], "type": "object" }, "name": "fund_letters", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ items: [{ id, kind, title, fund, manager, period_end, published, filing, source: { url, basis, retrieved_at, text_hosted: false }, section: { char_start, char_end, sha256 }, performance: [], mentions: [{ company, name_in_letter, stance, topics, quote, confidence, generated_by, method_version, model }] }], next_cursor, note }", "properties": { "items": { "items": { "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "note": { "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return what a fund's SEC filings state about its value: net assets at each Form N-PORT report month, each share class's monthly total return as reported, our own return index compounded from those months (base 100, not a NAV per share), and for closed-end funds the NAV per share and market price reported on Form N-CEN with the premium or discount. Where we hold a price for the class ticker it is shown as a market price on one venue, not NAV. Daily NAV per share is not served: no public filing carries it. Give a series id (S000002839) or a class ticker (VOO). Use it for a fund's size over time, monthly performance, or a closed-end fund's discount.", "inputSchema": { "additionalProperties": false, "examples": [ { "fund": "VOO", "limit": 12 } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "class": { "description": "Class id C000... to return one class only.", "pattern": "^[Cc]\\d{9}$", "type": "string" }, "from": { "description": "First month end (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "fund": { "description": "Series id or share-class ticker.", "maxLength": 12, "minLength": 1, "pattern": "^[A-Za-z0-9.\\-]{1,12}$", "type": "string" }, "limit": { "default": 36, "description": "Maximum number of periods or items to return (default 36, at most 240).", "maximum": 240, "minimum": 1, "type": "integer" }, "to": { "description": "Last month end (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, "required": [ "fund" ], "type": "object" }, "name": "fund_nav", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ fund, matched_class, net_assets: [{ report_period, net_assets }], classes: [{ class_id, ticker, months: [{ month_end, total_return, index }] }], index, nav_per_share: [{ nav_per_share, market_price_per_share, premium_discount }], market_price, not_served, note }", "properties": { "classes": { "type": "array" }, "fund": { "type": "object" }, "market_price": { "type": [ "object", "null" ] }, "nav_per_share": { "type": "array" }, "net_assets": { "type": "array" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return a fund's type from its latest Form N-CEN (ETF, index, money market, interval, fund of funds...), closed-end fees and tracking difference where filed, and every share class with its prospectus fee table (expense ratio, management fee, 12b-1, waivers) as fractions of net assets (0.0003 is 0.03 percent). Give a series id (S000002839) or a class ticker (VOO). Use it when asked what kind of fund this is or what it charges.", "inputSchema": { "additionalProperties": false, "examples": [ { "fund": "VOO" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "fund": { "description": "Series id or share-class ticker.", "maxLength": 12, "minLength": 1, "pattern": "^[A-Za-z0-9.\\-]{1,12}$", "type": "string" } }, "required": [ "fund" ], "type": "object" }, "name": "fund_profile", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ fund { series_id, name, kind }, matched_class, census { flags, management_fee, net_operating_expenses, tracking_difference }, classes: [{ ticker, expense_ratio, expense_ratio_basis, fees }] }", "properties": { "census": { "type": [ "object", "null" ] }, "classes": { "type": "array" }, "fund": { "type": "object" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Use this to convert an amount between currencies or to read a daily reference exchange rate. The only source is the European Central Bank's euro foreign exchange reference rates, set once each working day around 14:15 CET. data.rates[X] is units of X for one unit of base; a rate between two currencies other than the euro is computed through the euro from the same day. date answers with the latest reference day on or before it (data.date says which), so weekends and holidays return the working day before. A currency with no rate that day is left out of rates and listed in not_served. These are reference rates for information, not tradable quotes: no bid, ask or intraday value. Name the ECB and the reference day when you quote one.", "inputSchema": { "additionalProperties": false, "examples": [ { "base": "USD", "quotes": "EUR,GBP,JPY" }, { "base": "EUR", "date": "2024-06-28", "quotes": "USD" } ], "properties": { "base": { "description": "ISO 4217 code of the base currency; default USD.", "pattern": "^[A-Za-z]{3}$", "type": "string" }, "date": { "description": "Latest reference day on or before this date; default today (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "quotes": { "description": "Comma-separated ISO 4217 codes to quote, for example EUR,GBP,JPY; default every currency published that day.", "maxLength": 400, "pattern": "^[A-Za-z]{3}(,[A-Za-z]{3})*$", "type": "string" } }, "required": [], "type": "object" }, "name": "fx_rates", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ base, date, requested_date, rates { <currency>: units of it for one unit of base }, not_served: [currency], source { id, name, url, attribution, licence }, method (ecb_reference_rate | cross_rate_through_eur), retrieved_at, as_of_note }", "properties": { "as_of_note": { "type": "string" }, "base": { "type": "string" }, "date": { "type": "string" }, "not_served": { "type": "array" }, "rates": { "type": "object" }, "source": { "type": "object" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Given one identifier (ticker, SEC CIK, LEI, FIGI, SEC fund series or class id, FinancialMD id, or a CUSIP or ISIN you already hold), return the company or fund it names and the other open identifiers we hold for it, each with its source and licence. A CUSIP or ISIN is matched only against values that filers reported in public SEC filings, and the answer names the filing; CUSIP and ISIN values are not returned, because those numbering systems are licensed. Check digits are not computed and missing identifiers are never filled in from a vendor source. Use it to join FinancialMD data to another system or to find out what an identifier refers to.", "inputSchema": { "additionalProperties": false, "examples": [ { "id": "BBG000B9XRY4" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "id": { "description": "The identifier, e.g. AAPL, 0000320193, HWUPKR0MPOU8FGXBT394, BBG000B9XRY4, S000002839.", "maxLength": 40, "minLength": 1, "type": "string" }, "kind": { "description": "What the identifier is; omit to detect it from its shape.", "enum": [ "fmd_id", "cik", "ticker", "lei", "figi", "series", "class", "cusip", "isin" ], "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "identifier_xref", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ query { kind, value, detected }, matched_on, matches: [{ type, company, fund, identifiers: [{ kind, value, basis, source { id, licence, terms_url } }], withheld }], note }", "properties": { "matched_on": { "type": [ "object", "null" ] }, "matches": { "type": "array" }, "query": { "type": "object" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return a company's CIK, LEI and FIGI identifiers with their evidence: LEI accepted only when Form N-PORT filers agree and GLEIF has the record; FIGI from OpenFIGI by ticker (public domain). Use it to join FinancialMD data to another system by CIK, LEI or FIGI.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "company" ], "type": "object" }, "name": "identifiers", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ cik, lei, items: [{ kind, value, listing, status, source, evidence, dissent, verified_name, proof }] }", "properties": { "cik": { "type": [ "integer", "null" ] }, "items": { "type": "array" }, "lei": { "type": [ "string", "null" ] } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return what each director and officer owned after their latest reported transaction (shares_owned_after on Forms 4 and 5), per security and direct or indirect ownership, largest first: the later of the balance after their latest transaction and their latest holding line (a Form 3 initial statement, or a Form 4 or 5 holdings table); source says which. Say \"as last reported\" with the date. Use it when asked how much a company's directors and officers own.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "limit": { "default": 25, "description": "Maximum number of periods or items to return (default 25, at most 500).", "maximum": 500, "minimum": 1, "type": "integer" } }, "required": [ "company" ], "type": "object" }, "name": "insider_holders", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ items: [{ owner, relationship, officer_title, security_title, ownership_nature, as_of_date, shares }], note }", "properties": { "items": { "items": { "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "note": { "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "List the transactions a company's officers, directors and ten percent owners reported on SEC Forms 3, 4 and 5, newest first: transaction date, the owner and their relationship and title, the security, the SEC transaction code as filed (P purchase, S sale, A grant, M exercise, F tax withholding, G gift), acquired or disposed, shares, price and shares owned after. Every number carries a proof that opens the ownership form on sec.gov. as_of limits the list to forms accepted by a date; cursor pages. Use it when asked what a company's insiders bought or sold.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL", "limit": 20 }, { "as_of": "2025-01-01", "company": "cik:320193" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "limit": { "default": 50, "description": "Maximum number of periods or items to return (default 50, at most 500).", "maximum": 500, "minimum": 1, "type": "integer" } }, "required": [ "company" ], "type": "object" }, "name": "insider_transactions", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ items: [{ transaction_date, owner: { cik, name }, relationship, officer_title, security_title, is_derivative, code, acquired_disposed, ownership_nature, shares, price, shares_owned_after }], next_cursor }; shares, price and shares_owned_after are value objects.", "properties": { "items": { "items": { "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "List the investment managers that reported a position in a company on SEC Form 13F for one quarter, largest reported value first: the manager, shares, market value as the manager reported it, the same manager's shares one quarter earlier, the change, whether the position is new, increased, decreased or unchanged, and the share of the company's reported shares outstanding. data.periods lists the quarters on file. Only positions that an SEC filing ties to the company are listed, so coverage is partial and the list is not a full register. Every number carries a proof that opens the 13F on sec.gov. Use it when asked which institutions hold a company and how their positions changed.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL", "limit": 20 }, { "company": "cik:320193", "period": "2026-06-30" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "limit": { "default": 50, "description": "Maximum number of periods or items to return (default 50, at most 500).", "maximum": 500, "minimum": 1, "type": "integer" }, "period": { "description": "Optional calendar quarter end (YYYY-03-31, -06-30, -09-30 or -12-31). Default: the newest quarter on file.", "examples": [ "2026-06-30" ], "pattern": "^\\d{4}-(03-31|06-30|09-30|12-31)$", "type": "string" } }, "required": [ "company" ], "type": "object" }, "name": "institutional_holders", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ period, periods, items: [{ holder: { cik, name }, issuer_name, class_title, company, put_call, share_type, shares, value, prior_shares, shares_change, position_change, percent_of_shares_outstanding }], next_cursor }.", "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Read the portfolio an investment manager reported on SEC Form 13F for one quarter, largest reported value first: issuer and class as the manager wrote them, the company the security resolves to when an SEC filing ties them together (null otherwise, never guessed), shares, market value, the prior quarter's shares and the change. data.filings carries the filing with the manager's own summary totals and whether the loaded table adds up to them; data.periods lists the quarters on file. Pass holder as cik:<n>, or pass a manager name: one match returns its portfolio, several return the matching managers with their CIKs so you can pick. Use it when asked what a manager owns, or what it bought and sold in a quarter.", "inputSchema": { "additionalProperties": false, "examples": [ { "holder": "cik:1067983", "limit": 50 }, { "holder": "Berkshire Hathaway", "period": "2026-06-30" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "holder": { "description": "The manager: \"cik:<n>\" or a bare SEC CIK, or part of the manager's name as filed, such as \"Berkshire Hathaway\".", "examples": [ "cik:1067983", "Berkshire Hathaway" ], "maxLength": 120, "minLength": 1, "type": "string" }, "limit": { "default": 100, "description": "Maximum number of periods or items to return (default 100, at most 1000).", "maximum": 1000, "minimum": 1, "type": "integer" }, "period": { "description": "Optional calendar quarter end (YYYY-03-31, -06-30, -09-30 or -12-31). Default: the newest quarter on file.", "examples": [ "2026-06-30" ], "pattern": "^\\d{4}-(03-31|06-30|09-30|12-31)$", "type": "string" } }, "required": [ "holder" ], "type": "object" }, "name": "institutional_holdings", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "For one manager: { holder: { cik, name }, period, periods, filings: [{ accession, form, report_period, filed, amendment_type, source_url, entry_total, value_total, totals_match }], items: [position], next_cursor }. For a name with several matches: { items: [{ cik, name, latest }], next_cursor }.", "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return releases companies publish about themselves, newest first: press releases and earnings releases filed as SEC exhibits (source edgar; read the text with call_material), and the headline, link and time from issuers' own investor-relations feeds (source issuer_site; no article body is stored, follow the link). No wire-service or publisher content. Use it for a company's own announcements in its own words.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL", "limit": 10 }, { "from": "2026-11-01", "source": "edgar" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "Optional: one company. 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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "from": { "description": "Published on or after (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "limit": { "default": 20, "description": "Maximum number of periods or items to return (default 20, at most 200).", "maximum": 200, "minimum": 1, "type": "integer" }, "source": { "description": "edgar: exhibits filed with the SEC. issuer_site: headline and link from the issuer's own feed.", "enum": [ "edgar", "issuer_site" ], "type": "string" }, "to": { "description": "Published on or before (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, "required": [], "type": "object" }, "name": "issuer_releases", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ items: [{ id, company, source, kind, headline, published_at, link, accession, passages_url, body_stored, source_url, retrieved_at }], next_cursor, note }", "properties": { "items": { "items": { "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "note": { "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Find one line of a company's own reporting by its name and period, when the standardized statements do not carry it: detail lines of the income statement, balance sheet and cash flow statement (for example interest expense on debt, deferred revenue, purchases of intangibles), segment and geographic figures, company-defined metrics and the company's own guidance. label is matched by words against XBRL tag names, segment members, metric names and guidance metrics; no model is used. Give period_end, or fiscal_year with fiscal_period (FY, Q1 to Q4); without a period each line answers with its newest value. dataset narrows the search to as_reported, segment, kpi or guidance. original true returns the first-reported figure instead of the latest filed. Each item carries its dataset, the label matched, a score (1 = the label is the whole name) and a value with its proof. Check the label and score before you repeat a number, and name the line as the company tagged it. Lines a filer tagged with its own extension tag are not held; an empty answer means not found here, not zero.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL", "fiscal_year": 2024, "label": "interest expense" }, { "company": "ticker:HOOD", "label": "net cash used in investing activities", "original": true, "period_end": "2021-12-31", "period_type": "quarterly" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "dataset": { "description": "Comma-separated: as_reported, segment, kpi, guidance. Default all four.", "maxLength": 60, "pattern": "^[a-z_]+(,[a-z_]+)*$", "type": "string" }, "fiscal_period": { "description": "Default FY when fiscal_year is given.", "enum": [ "FY", "Q1", "Q2", "Q3", "Q4" ], "type": "string" }, "fiscal_year": { "description": "Fiscal year as the company numbers it; use with fiscal_period, not with period_end.", "maximum": 2100, "minimum": 1990, "type": "integer" }, "label": { "description": "The line as a report would name it, for example \"interest expense\" or \"cloud revenue\".", "maxLength": 120, "minLength": 2, "type": "string" }, "limit": { "description": "Items to return, best match first; default 10.", "maximum": 50, "minimum": 1, "type": "integer" }, "original": { "description": "true = the first-reported figure; default the latest filed.", "type": "boolean" }, "period_end": { "description": "Period end date; a few days of slack cover 52/53-week years (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "period_type": { "description": "Length of the period; default annual for FY and quarterly for a fiscal quarter.", "enum": [ "annual", "quarterly", "semi_annual", "ytd" ], "type": "string" } }, "required": [ "company", "label" ], "type": "object" }, "name": "line_item", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ query { q, words, period_end, fiscal_year, fiscal_period, period_type, datasets, original }, items: [{ dataset, label, score, period_end, period_start, tag, standardized_as, value: value object with proof (as_reported and segment) | metric fields with value (kpi) | low, mid, high with source sentence (guidance) }], matched, next_cursor, note }", "properties": { "items": { "type": "array" }, "matched": { "type": "integer" }, "next_cursor": { "type": [ "string", "null" ] }, "note": { "type": "string" }, "query": { "type": "object" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "List the standardized concepts (metrics) available for a company's template, with display order, statement, label, unit and the formula for derived concepts (for example free_cash_flow = cash_from_operations - capital_expenditure). Use it to learn the exact concept ids before calling verify_value or compare_versions, and to see which rows a statement will contain. Optionally filter to one statement.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL" }, { "company": "ticker:JPM", "statement": "income_statement" } ], "properties": { "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "statement": { "description": "Optional: only concepts of this statement (or supplemental).", "enum": [ "income_statement", "balance_sheet", "cash_flow", "supplemental" ], "type": "string" } }, "required": [ "company" ], "type": "object" }, "name": "metrics_list", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ template, concepts: [{ concept_id, statement, template, label, display_order, is_subtotal, formula, metric_format, metric_alias }] }.", "properties": { "concepts": { "type": "array" }, "template": { "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return the newest 8-K filings across all companies (or one), each with its items, event types (earnings, acquisition_disposition, leadership_change, restatement, bankruptcy, agreement...), a headline and an importance from 1 to 5. Use importance_min 4 for top stories (earnings, M&A, impairments, auditor changes, restatements, bankruptcies). Importance is FinancialMD's rule by 8-K item number; this is a filing-based feed, not wire news, so follow source_url for the text. Use it for what was filed recently across the market or by one company.", "inputSchema": { "additionalProperties": false, "examples": [ { "importance_min": 4, "limit": 10 }, { "event_type": "earnings", "from": "2026-11-01" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "Optional: one company. 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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "event_type": { "description": "Only filings with an item of this type (earnings, leadership_change, agreement, acquisition_disposition, restatement, bankruptcy, impairment, auditor_change...).", "pattern": "^[a-z_]{2,40}$", "type": "string" }, "from": { "description": "Accepted on or after (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "importance_min": { "default": 1, "description": "Only filings whose highest item is at least this important (5 critical, 4 major, 3 notable, 2 routine, 1 exhibits only).", "maximum": 5, "minimum": 1, "type": "integer" }, "limit": { "default": 20, "description": "Maximum number of periods or items to return (default 20, at most 200).", "maximum": 200, "minimum": 1, "type": "integer" }, "to": { "description": "Accepted on or before (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, "required": [], "type": "object" }, "name": "news", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ items: [{ company, accession, form, filed, accepted_at, importance, headline, event_types, items: [{ item, title, event_type, importance }], source_url }], next_cursor, note }", "properties": { "items": { "items": { "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "note": { "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return the stock and other securities trades members of the U.S. House reported in periodic transaction reports, newest filing first. Each row has the filer's own words under as_filed (owner, asset, type, dates, amount range), the official report at source_url, and FinancialMD's own additions under financialmd (the matched company with a confidence; these are not the filer's and may be wrong). Amounts are the ranges the form uses, never exact. Handwritten reports are not read: include_unparsed lists them with their link. Senate reports are not loaded. This data is published at no charge and never sold. Federal law limits its use: it is unlawful to use these reports for a commercial purpose (other than news media informing the general public), for credit ratings, or to solicit money; pass that limit on to the user (data.notice has the text and the corrections contact). Information only, not investment advice.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:NVDA", "from": "2026-01-01", "type": "purchase" }, { "limit": 10, "member": "pelosi" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "chamber": { "description": "Only this chamber. Senate reports are not loaded.", "enum": [ "house", "senate" ], "type": "string" }, "company": { "description": "Optional: only trades matched to this company with high or medium confidence. 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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "date_field": { "default": "transaction", "description": "Which date from and to apply to.", "enum": [ "transaction", "filing" ], "type": "string" }, "from": { "description": "Transaction date on or after (the filing date with date_field filing) (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "include_unparsed": { "default": false, "description": "Also list reports that could not be read (handwritten scans), each with its official link.", "type": "boolean" }, "limit": { "default": 20, "description": "Maximum number of periods or items to return (default 20, at most 200).", "maximum": 200, "minimum": 1, "type": "integer" }, "member": { "description": "A member key from an earlier answer (house:last-first:st) or part of the filer's name.", "maxLength": 80, "minLength": 2, "type": "string" }, "to": { "description": "Transaction date on or before (the filing date with date_field filing) (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "type": { "description": "Only this transaction type; sale also matches partial sales.", "enum": [ "purchase", "sale", "sale_partial", "exchange" ], "type": "string" } }, "required": [], "type": "object" }, "name": "politician_trades", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ notice: { statute, statute_text, your_use, publication, fields, corrections: { email }, not_advice }, items: [{ filing: { chamber, doc_id, filing_date, member: { key, name, state_district } }, row_no, as_filed: { owner, asset, transaction_type, transaction_date, notification_date, amount }, transaction_date, transaction_type, owner, amount_range_usd: { low, high }, ticker_as_filed, financialmd: { company, match_confidence, match_method }, source_url, retrieved_at }], next_cursor }", "properties": { "coverage_note": { "type": "string" }, "items": { "items": { "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "notice": { "type": "object" }, "sources": { "items": { "type": "object" }, "type": "array" }, "unparsed_filings": { "items": { "type": "object" }, "type": "array" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "List companies with a registration statement on file at the SEC for a first public offering (Form S-1 or F-1), newest filing first. Each item carries the registrant CIK, name, industry code, form, a status (filed, effective, priced, listed, withdrawn, stale) with the rule that set it, the first and latest filing dates, the number of amendments, and the proposed ticker and exchange when the prospectus names them. Filter by name or proposed ticker (q), status, form, blank check companies, and the date of the latest filing. These registrants are not yet listed, so company_lookup does not find them; pass the CIK to pre_ipo_company for figures and offering terms. Confidential draft submissions are not public and are not here.", "inputSchema": { "additionalProperties": false, "examples": [ { "blank_check": false, "status": "filed" }, { "from": "2026-01-01", "q": "robotics" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "blank_check": { "description": "true = only blank check companies (SIC 6770); false = leave them out.", "type": "boolean" }, "cursor": { "description": "next_cursor from the previous page.", "maxLength": 512, "type": "string" }, "form": { "description": "S-1 = domestic registrant, F-1 = foreign private issuer.", "enum": [ "S-1", "F-1" ], "type": "string" }, "from": { "description": "Latest filing on or after (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "limit": { "description": "Items per page; default 25.", "maximum": 100, "minimum": 1, "type": "integer" }, "q": { "description": "Part of the registrant name, or the proposed ticker.", "maxLength": 80, "minLength": 2, "type": "string" }, "status": { "description": "Comma-separated: filed, effective, priced, listed, withdrawn, stale. Default all.", "maxLength": 60, "pattern": "^[a-z]+(,[a-z]+)*$", "type": "string" }, "to": { "description": "Latest filing on or before (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, "required": [], "type": "object" }, "name": "pre_ipo_companies", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ items: [{ id, cik, name, sic_code, sic_description, registration_form, status, status_rule, first_filed, latest_filed, amendments, proposed_ticker, proposed_exchange, is_blank_check, company, known, links }], next_cursor, statuses, note }", "properties": { "items": { "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "note": { "type": "string" }, "statuses": { "type": "array" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Use this for one company that has filed to go public, by SEC CIK (from pre_ipo_companies): status and its rule, every registration filing with links, the financial figures tagged in the prospectus (revenue, net income, cash, total assets and others, each with its period and XBRL tag), and the offering terms read from the prospectus by rule (offer range, shares offered, exchange, underwriters, use of proceeds), each with the sentence it came from, its position in the document and a confidence. For each figure the newest filing that states it wins; as_of shows the registration as it stood on a past date. Offering terms are rule-extracted, not human-checked: quote the sentence and the filing when you repeat one. An empty financials list means the prospectus carries no tagged figures, not that the company has none.", "inputSchema": { "additionalProperties": false, "examples": [ { "cik": "2137779" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "cik": { "description": "SEC CIK of the registrant, digits only.", "pattern": "^\\d{1,10}$", "type": "string" } }, "required": [ "cik" ], "type": "object" }, "name": "pre_ipo_company", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ company { id, cik, name, registration_form, status, status_rule, first_filed, latest_filed, amendments, proposed_ticker, proposed_exchange, company }, filings: [{ accession, form, role, filed, accepted_at, source_url, document_url }], facts: [{ kind (financial | offering), label, value, value_text, unit, period_end, period_months, method (xbrl | rule), tag, rule, quote, span, confidence, document_url, accession, form, filed, known }], note }", "properties": { "company": { "type": "object" }, "facts": { "type": "array" }, "filings": { "type": "array" }, "note": { "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return a company's price return, total return and maximum drawdown over standard windows (1m, 3m, 6m, ytd, 1y, 3y, 5y, max), computed by us from end-of-day bars built from trades at IEX only and from the splits and dividends in the company's SEC filings. Each value lists the bars and filing facts it used. Prices are end of day, published the day after the session: not real time, not the consolidated tape, not the official close. A window that starts before our first session is null. Use it when asked how a stock has performed or how far it fell from a peak.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL", "windows": "ytd,1y" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "ticker": { "description": "One listing of the company; default the primary listing.", "maxLength": 12, "type": "string" }, "to": { "description": "Last session to use; default the newest (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "windows": { "description": "Comma-separated windows from 1m, 3m, 6m, ytd, 1y, 3y, 5y, max; default all.", "maxLength": 40, "pattern": "^[a-z0-9,]+$", "type": "string" } }, "required": [ "company" ], "type": "object" }, "name": "price_returns", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ listing, range, windows: [{ window, start, end, sessions, price_return, total_return, annualised_total_return, max_drawdown, drawdown { peak, trough } }], source { venue, consolidated, delay }, generated_by, method_version, note }", "properties": { "range": { "type": "object" }, "source": { "type": "object" }, "windows": { "type": "array" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return the full proof behind a value: the proof itself (filing accession, form and filing date, XBRL taxonomy, tag and dimensions, source URL, page and anchor), the kind (std for a standardized value, ar for a raw as-reported fact), the value object, the concept it maps to, the company, the filing summary, the raw as-reported facts the standardized value derives from, and the derivation (method, calc_type and the pipeline run). For a ratio (kind \"ratio\") it also returns the formula and the standardized input values, each with its own proof. Every value object carries proof.id; pass it here when a person asks \"where does this number come from\" or before quoting a figure in a report. A human page exists at meta.proof_base + proof_id.", "inputSchema": { "additionalProperties": false, "examples": [ { "proof_id": "p_01JCA4Q7Z3K8M2N5R9T1V6X0Y2" } ], "properties": { "proof_id": { "description": "The proof id from a value object, for example p_01JC....", "examples": [ "p_01JCA4Q7Z3K8M2N5R9T1V6X0Y2" ], "pattern": "^[A-Za-z0-9][A-Za-z0-9_\\-]{2,200}$", "type": "string" } }, "required": [ "proof_id" ], "type": "object" }, "name": "proof_get", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ proof, kind (std or ar), value, concept { concept_id, label, statement } or null, company, filing, derived_from (raw facts), derivation { method, calc_type, run } or null }.", "properties": { "company": { "type": "object" }, "concept": { "type": [ "object", "null" ] }, "derivation": { "type": [ "object", "null" ] }, "derived_from": { "type": "array" }, "filing": { "type": "object" }, "kind": { "type": "string" }, "proof": { "description": "Where a value comes from: filing accession, form, filing date, taxonomy and tag, source URL, page and anchor.", "properties": { "accession": { "type": "string" }, "anchor": { "type": [ "string", "null" ] }, "dims": {}, "filed": { "type": "string" }, "form": { "type": "string" }, "id": { "type": "string" }, "inputs": { "description": "For derived values (ratios): the proof ids of the inputs.", "items": { "type": "string" }, "type": "array" }, "page": { "type": [ "integer", "null" ] }, "source_url": { "type": "string" }, "tag": { "type": [ "string", "null" ] }, "taxonomy": { "type": [ "string", "null" ] } }, "type": "object" }, "value": { "description": "A proven number: value, unit, currency, decimals, period, known interval, restated, method, calc_type, proof.", "properties": { "calc_type": { "type": "string" }, "currency": { "type": [ "string", "null" ] }, "decimals": { "type": [ "integer", "null" ] }, "known": { "properties": { "from": { "type": "string" }, "to": { "type": [ "string", "null" ] } }, "type": "object" }, "method": { "type": "string" }, "period": { "type": "object" }, "proof": { "description": "Where a value comes from: filing accession, form, filing date, taxonomy and tag, source URL, page and anchor.", "properties": { "accession": { "type": "string" }, "anchor": { "type": [ "string", "null" ] }, "dims": {}, "filed": { "type": "string" }, "form": { "type": "string" }, "id": { "type": "string" }, "inputs": { "description": "For derived values (ratios): the proof ids of the inputs.", "items": { "type": "string" }, "type": "array" }, "page": { "type": [ "integer", "null" ] }, "source_url": { "type": "string" }, "tag": { "type": [ "string", "null" ] }, "taxonomy": { "type": [ "string", "null" ] } }, "type": "object" }, "restated": { "type": "boolean" }, "unit": { "type": "string" }, "value": { "type": [ "number", "null" ] } }, "type": "object" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return the ratios FinancialMD computes from a company's standardized facts: gross, operating, net and free cash flow margins, revenue growth year over year, return on equity and on assets, asset turnover, current ratio, debt to equity, interest coverage, basic and diluted EPS; for banks net interest income to average loans and securities (not the bank's reported NIM), efficiency ratio and loans to deposits; for insurers loss and acquisition cost ratios; and valuation at each period end (market cap, EV, P/E, P/S, P/B, EV/EBITDA, EV/EBIT, FCF and dividend yield) from the last IEX close on or before the period end (data.price_basis says which close, or why valuation is empty: several share classes, an ADR, no prices). The result has the statement grid shape (periods most recent first, one row per ratio, cells aligned with periods); margins and growth are fractions (0.462 is 46.2 percent). Every cell is a value object whose proof lists the proof ids of its inputs (proof.inputs) and whose method is derived_lineitem; proof_get on a ratio proof returns the inputs and the formula. A cell is null when an input is missing (a bank has no gross margin) or a denominator is zero: never NaN. as_of computes from the facts known on that date. For valuation on every trading day use ratios_daily. Use it when the question is about margins, returns, leverage, growth or valuation at period ends.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL", "limit": 5, "period_type": "annual" }, { "as_of": "2024-12-31", "company": "ticker:JPM", "period_type": "quarterly", "ratios": [ "roe", "net_margin" ] } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "limit": { "default": 10, "description": "Maximum number of periods or items to return (default 10, at most 200).", "maximum": 200, "minimum": 1, "type": "integer" }, "period_type": { "default": "annual", "description": "Period basis: annual (fiscal years), quarterly, ltm (last twelve months) or ytd (year to date).", "enum": [ "annual", "quarterly", "ltm", "ytd" ], "type": "string" }, "ratios": { "description": "Optional: only these ratio ids (the grid is trimmed client-side; the call costs the same).", "items": { "enum": [ "gross_margin", "operating_margin", "net_margin", "fcf_margin", "revenue_growth_yoy", "roe", "roa", "asset_turnover", "current_ratio", "debt_to_equity", "interest_coverage", "eps_basic", "eps_diluted", "nii_to_avg_loans_securities", "efficiency_ratio", "loans_to_deposits", "loss_ratio", "acquisition_cost_ratio", "market_cap", "enterprise_value", "pe_ttm", "ps_ttm", "pb", "ev_ebitda_ttm", "ev_ebit_ttm", "fcf_yield", "dividend_yield" ], "type": "string" }, "maxItems": 27, "minItems": 1, "type": "array", "uniqueItems": true } }, "required": [ "company" ], "type": "object" }, "name": "ratios", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "The ratio grid: statement \"ratios\", period_type, view, currency, periods (most recent first) and one row per ratio id with cells aligned to periods.", "properties": { "currency": { "type": [ "string", "null" ] }, "period_type": { "type": "string" }, "periods": { "items": { "type": "object" }, "type": "array" }, "rows": { "items": { "properties": { "cells": { "items": { "anyOf": [ { "description": "A proven number: value, unit, currency, decimals, period, known interval, restated, method, calc_type, proof.", "properties": { "calc_type": { "type": "string" }, "currency": { "type": [ "string", "null" ] }, "decimals": { "type": [ "integer", "null" ] }, "known": { "properties": { "from": { "type": "string" }, "to": { "type": [ "string", "null" ] } }, "type": "object" }, "method": { "type": "string" }, "period": { "type": "object" }, "proof": { "description": "Where a value comes from: filing accession, form, filing date, taxonomy and tag, source URL, page and anchor.", "properties": { "accession": { "type": "string" }, "anchor": { "type": [ "string", "null" ] }, "dims": {}, "filed": { "type": "string" }, "form": { "type": "string" }, "id": { "type": "string" }, "inputs": { "description": "For derived values (ratios): the proof ids of the inputs.", "items": { "type": "string" }, "type": "array" }, "page": { "type": [ "integer", "null" ] }, "source_url": { "type": "string" }, "tag": { "type": [ "string", "null" ] }, "taxonomy": { "type": [ "string", "null" ] } }, "type": "object" }, "restated": { "type": "boolean" }, "unit": { "type": "string" }, "value": { "type": [ "number", "null" ] } }, "type": "object" }, { "type": "null" }, { "properties": { "versions": { "items": { "description": "A proven number: value, unit, currency, decimals, period, known interval, restated, method, calc_type, proof.", "properties": { "calc_type": { "type": "string" }, "currency": { "type": [ "string", "null" ] }, "decimals": { "type": [ "integer", "null" ] }, "known": { "properties": { "from": { "type": "string" }, "to": { "type": [ "string", "null" ] } }, "type": "object" }, "method": { "type": "string" }, "period": { "type": "object" }, "proof": { "description": "Where a value comes from: filing accession, form, filing date, taxonomy and tag, source URL, page and anchor.", "properties": { "accession": { "type": "string" }, "anchor": { "type": [ "string", "null" ] }, "dims": {}, "filed": { "type": "string" }, "form": { "type": "string" }, "id": { "type": "string" }, "inputs": { "description": "For derived values (ratios): the proof ids of the inputs.", "items": { "type": "string" }, "type": "array" }, "page": { "type": [ "integer", "null" ] }, "source_url": { "type": "string" }, "tag": { "type": [ "string", "null" ] }, "taxonomy": { "type": [ "string", "null" ] } }, "type": "object" }, "restated": { "type": "boolean" }, "unit": { "type": "string" }, "value": { "type": [ "number", "null" ] } }, "type": "object" }, "type": "array" } }, "required": [ "versions" ], "type": "object" } ], "description": "A value object, null when the concept has no value for the period, or { versions: [...] } oldest first with history=true." }, "type": "array" }, "concept_id": { "type": [ "string", "null" ] }, "dims": { "type": [ "object", "null" ] }, "display_order": { "type": "integer" }, "fiscal_alias": { "deprecated": true, "description": "Deprecated twin of metric_alias, served for one more release.", "type": [ "string", "null" ] }, "formula": { "type": [ "string", "null" ] }, "is_subtotal": { "type": "boolean" }, "label": { "type": "string" }, "metric_alias": { "type": [ "string", "null" ] }, "metric_format": { "type": "string" }, "tag": { "type": "string" }, "taxonomy": { "type": "string" }, "unit": { "type": "string" } }, "required": [ "cells" ], "type": "object" }, "type": "array" }, "statement": { "type": "string" }, "view": { "enum": [ "current", "as_of", "original", "history" ], "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return one ratio as a series, most recent first. For a valuation ratio (market_cap, enterprise_value, pe_ttm, ps_ttm, pb, ev_ebitda_ttm, ev_ebit_ttm, fcf_yield, dividend_yield) there is one point per trading session: the IEX close of that day times the standardized facts known that evening (trailing twelve months for flows, the latest balance sheet), so a P/E series never uses a filing accepted later. Points are withheld after a split-sized move until split data exists; data.price_basis says which listing was used and why a company is not priced (several share classes such as BRK-A and BRK-B, an ADR, no prices). Each point is a value object whose proof.inputs lists the close first, then the facts; proof_get recomputes it. For a fundamentals ratio (gross_margin, roe, nii_to_avg_loans_securities...) there is one point per fiscal period of period_type. IEX is a single venue and its last trade is not the official close; say so when quoting. Use it for the history of one ratio, such as a P/E series or a margin trend.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL", "limit": 30, "ratio_id": "pe_ttm" }, { "company": "ticker:JPM", "period_type": "quarterly", "ratio_id": "efficiency_ratio" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "from": { "description": "Valuation only: first session date, inclusive (YYYY-MM-DD).", "examples": [ "2025-01-02" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "limit": { "default": 30, "description": "Maximum number of periods or items to return (default 30, at most 1000).", "maximum": 1000, "minimum": 1, "type": "integer" }, "period_type": { "default": "annual", "description": "Period basis: annual (fiscal years), quarterly, ltm (last twelve months) or ytd (year to date).", "enum": [ "annual", "quarterly", "ltm", "ytd" ], "type": "string" }, "ratio_id": { "description": "Ratio id. Valuation ids give a daily series; the others one point per period.", "enum": [ "gross_margin", "operating_margin", "net_margin", "fcf_margin", "revenue_growth_yoy", "roe", "roa", "asset_turnover", "current_ratio", "debt_to_equity", "interest_coverage", "eps_basic", "eps_diluted", "nii_to_avg_loans_securities", "efficiency_ratio", "loans_to_deposits", "loss_ratio", "acquisition_cost_ratio", "market_cap", "enterprise_value", "pe_ttm", "ps_ttm", "pb", "ev_ebitda_ttm", "ev_ebit_ttm", "fcf_yield", "dividend_yield" ], "type": "string" }, "ticker": { "description": "Valuation only: the listing whose close is used (default the primary listing with bars).", "pattern": "^[A-Za-z0-9][A-Za-z0-9.\\-/]{0,11}$", "type": "string" }, "to": { "description": "Valuation only: last session date, inclusive (YYYY-MM-DD).", "examples": [ "2025-01-02" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, "required": [ "company", "ratio_id" ], "type": "object" }, "name": "ratios_daily", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ ratio_id, label, formula, metric_format, period_type (\"daily\" for valuation), view, items: [value objects], next_cursor, price_basis?: { listing, source, unavailable } }", "properties": { "formula": { "type": "string" }, "items": { "items": { "type": "object" }, "type": "array" }, "label": { "type": "string" }, "metric_format": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "period_type": { "type": "string" }, "price_basis": { "type": "object" }, "ratio_id": { "type": "string" }, "view": { "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "The status of a data request filed with FinancialMD: new (received), triaged (reviewed), planned, done (with the endpoint or tool that now serves it) or wontfix (with a note, for example data that only licensed feeds carry). Pass the request_id returned when the request was filed. Use it to follow a request until it ships. Also gives how many requests and distinct requesters the item has.", "inputSchema": { "additionalProperties": false, "examples": [ { "request_id": "0b8f6a52-6f0e-4a8e-9a43-3c0f6b2d1e11" } ], "properties": { "request_id": { "description": "The request_id returned when the request was filed (a uuid). A demand item id works too.", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$", "type": "string" } }, "required": [ "request_id" ], "type": "object" }, "name": "request_status", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ item_id, title, status, public_note, served_by, requests, requesters, ... }: the demand item the request belongs to.", "properties": { "done_at": { "type": [ "string", "null" ] }, "first_seen": { "type": "string" }, "item_id": { "type": "string" }, "kind": { "type": "string" }, "last_seen": { "type": "string" }, "public_note": { "type": [ "string", "null" ] }, "request_id": { "type": [ "string", "null" ] }, "requesters": { "type": "integer" }, "requests": { "type": "integer" }, "served_by": { "type": [ "string", "null" ] }, "status": { "enum": [ "new", "triaged", "planned", "done", "wontfix" ], "type": "string" }, "title": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return one DeepValues Research report in full as clean Markdown (images and front matter removed) with its sections and their character offsets, tickers and companies, date, the links it cites, the version (content hash and repository commit), the summary and a licence block with a ready citation (cite_as). The reports are licensed CC BY 4.0 and readable free on research.deepvalues.ai: when you quote one, credit \"DeepValues Research (research.deepvalues.ai)\" and link its source_url and the licence. It is research and education, not investment advice; a stance in a report is a dated view. An unknown or withdrawn report answers not_found. Use it after research_search when you need to read or quote the report.", "inputSchema": { "additionalProperties": false, "examples": [ { "id": "dvr_181b78646e4f0de6" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "id": { "description": "Report id from research_search, e.g. dvr_181b78646e4f0de6.", "pattern": "^dvr_[0-9a-f]{16}$", "type": "string" } }, "required": [ "id" ], "type": "object" }, "name": "research_report", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ id, title, collection, kind, language, published, tickers, companies, summary, stance, source_url, licence, version, markdown, sections: [{ id, level, heading, char_start, char_end }], sources: [{ url, title }], images_removed, cite_as, note } from GET /v1/research/{id}.", "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Search DeepValues Research reports, newest first: Deep Value Intelligence company reports (with the stance each states), company research notes, investor studies, insights, market memos, value-investing principles and personal finance notes. Each item has the id, title, collection, kind, language, date, tickers and companies, the report's page on research.deepvalues.ai, the licence and a summary that is an extract of the report's own words chosen by rule (never model-written). The reports are licensed CC BY 4.0 and readable free on research.deepvalues.ai: when you quote one, credit \"DeepValues Research (research.deepvalues.ai)\" and link its source_url and the licence. Use it to find research on a company or topic; then call research_report with an id for the whole text, structured.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL", "limit": 5 }, { "collection": "value_investing_principles", "q": "owner earnings" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "collection": { "description": "Only this collection.", "enum": [ "business_research", "guru_attention", "insights", "market_vibes", "personal_finance", "value_investing_principles" ], "type": "string" }, "company": { "description": "Optional: only reports filed under or tagged with this company. A ticker FinancialMD does not cover still matches. 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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "from": { "description": "Published on or after (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "kind": { "description": "Only this kind of report.", "enum": [ "deep_value_intelligence", "company_research", "business_note", "investor_study", "insight", "market_memo", "principle", "personal_finance" ], "type": "string" }, "language": { "description": "Only reports written in this language, e.g. en or zh.", "pattern": "^[a-z]{2}(-[A-Za-z]{2,4})?$", "type": "string" }, "limit": { "default": 10, "description": "Maximum number of periods or items to return (default 10, at most 100).", "maximum": 100, "minimum": 1, "type": "integer" }, "q": { "description": "Words that must all appear in the title or the summary.", "maxLength": 80, "minLength": 2, "type": "string" }, "to": { "description": "Published on or before (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, "required": [], "type": "object" }, "name": "research_search", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ items: [{ id, title, collection, kind, language, published, tickers, companies, summary: { text, method, generated_by: \"rule\" }, stance, source_url, licence: { id, url, attribution, free_at }, version }], next_cursor, licence_note }", "properties": { "items": { "items": { "type": "object" }, "type": "array" }, "licence_note": { "type": "string" }, "next_cursor": { "type": [ "string", "null" ] }, "note": { "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Screen every covered company on its latest period: range filters on metrics, a sort and paging, all applied on the server over the whole universe. A metric is a standardized concept id (from metrics_list, for example income_statement_total_revenues) or a ratio id (gross_margin, operating_margin, net_margin, fcf_margin, revenue_growth_yoy, roe, roa, asset_turnover, current_ratio, debt_to_equity, interest_coverage, eps_basic, eps_diluted, bank and insurer ratios) or a valuation id (market_cap, enterprise_value, pe_ttm, ps_ttm, pb, ev_ebitda_ttm, ev_ebit_ttm, fcf_yield, dividend_yield: the latest IEX close times the screened period, so use period_type ltm for trailing multiples) or a multi-year growth id (revenue_cagr_3y, revenue_cagr_5y, revenue_cagr_10y, net_income_cagr_3y, net_income_cagr_5y: compound annual growth from annual figures, the start matched by year, null when that year is missing or the figures are not positive). Filter bounds are raw values: 0.2 is 20 percent, amounts are in the reporting currency. A company with no value for a filtered metric does not match; when sorting, missing values come last. Each item has the company (with sector and industry), the period screened and one value object with proof per metric, so every number can be cited. data.total is the size of the whole match and data.next_cursor pages through it. as_of screens on what was known on a date. Use it to find or rank companies by fundamentals or valuation instead of calling each company in turn.", "inputSchema": { "additionalProperties": false, "examples": [ { "filters": [ { "metric": "net_margin", "min": 0.2 } ], "limit": 20, "sort_by": "roe", "sort_dir": "desc" }, { "filters": [ { "metric": "income_statement_total_revenues", "min": 1000000000 }, { "max": 1, "metric": "revenue_growth_yoy", "min": 0.1 } ], "metrics": [ "income_statement_total_revenues", "revenue_growth_yoy" ], "period_type": "ltm" }, { "filters": [ { "metric": "revenue_cagr_5y", "min": 0.15 } ], "limit": 20, "metrics": [ "revenue_cagr_5y", "net_income_cagr_5y" ], "sort_by": "revenue_cagr_5y", "sort_dir": "desc" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "country": { "description": "Optional ISO 3166-1 alpha-2 country code.", "pattern": "^[A-Za-z]{2}$", "type": "string" }, "currency": { "description": "Reporting currency (ISO 4217), e.g. JPY. Amounts are never compared across currencies: a sort or filter on a money column without this screens the currency most companies of the screen report in (USD across the whole universe).", "pattern": "^[A-Za-z]{3}$", "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "filters": { "description": "Range filters, all of which must hold. Give min, max or both (inclusive, raw values).", "items": { "additionalProperties": false, "anyOf": [ { "required": [ "min" ] }, { "required": [ "max" ] } ], "properties": { "max": { "description": "Inclusive upper bound.", "type": "number" }, "metric": { "description": "Concept id or ratio id.", "pattern": "^[a-z][a-z0-9_]{1,80}$", "type": "string" }, "min": { "description": "Inclusive lower bound.", "type": "number" } }, "required": [ "metric" ], "type": "object" }, "maxItems": 12, "minItems": 1, "type": "array" }, "include_stale": { "default": false, "description": "Keep companies whose latest period ended more than 18 months before as_of (left out by default; each item carries stale).", "type": "boolean" }, "industry": { "description": "Optional exact industry (case-insensitive).", "maxLength": 120, "minLength": 1, "type": "string" }, "limit": { "default": 25, "description": "Maximum number of periods or items to return (default 25, at most 200).", "maximum": 200, "minimum": 1, "type": "integer" }, "metrics": { "description": "Columns to return: concept ids or ratio ids (default: revenue, net income, the three margins, revenue growth, return on equity).", "items": { "pattern": "^[a-z][a-z0-9_]{1,80}$", "type": "string" }, "maxItems": 12, "minItems": 1, "type": "array", "uniqueItems": true }, "period_type": { "default": "annual", "description": "Which latest period to screen: annual (default), quarterly or ltm.", "enum": [ "annual", "quarterly", "ltm" ], "type": "string" }, "query": { "description": "Optional name or ticker search to narrow the universe.", "maxLength": 64, "minLength": 1, "type": "string" }, "sector": { "description": "Optional exact sector (case-insensitive).", "maxLength": 80, "minLength": 1, "type": "string" }, "sort_by": { "description": "A metric id, \"name\" or \"ticker\" (default name).", "pattern": "^[a-z][a-z0-9_]{1,80}$", "type": "string" }, "sort_dir": { "default": "asc", "description": "Sort direction (default asc).", "enum": [ "asc", "desc" ], "type": "string" } }, "required": [], "type": "object" }, "name": "screen", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ items: [{ company { fmd_id, cik, name, country, reporting_template, primary_ticker, primary_mic, sector, industry }, period, stale, currency, values: { <metric id>: value object or null; a ratio over a zero or negative denominator has value null and withheld_reason } }], next_cursor, period_type, metrics: [{ id, kind, label, metric_format, formula }], sort, total, universe, currency (the one reporting currency screened, or null), stale_after_days, excluded { stale, other_currency }, notes }.", "properties": { "items": { "items": { "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Turn a plain-language question into screen filters and run the screen over every covered company. The filters are parsed from the question by an AI model, or by fixed rules when no model is set up; data.generated_by and data.label say which. The model only picks filters. The results are computed from filings by the same code as the screen tool, and every value carries its proof. data.parsed lists the filters used, data.equivalent_request is the same screen as a structured request, and data.unparsed lists the parts of the question that were not understood, so check both before relying on the list. It knows sectors, industries, and metrics with bounds such as gross margin above 40%, P/E below 15 or revenue over 1 billion. Use it when the user describes the companies they want in words; use the screen tool when you already know the metric ids.", "inputSchema": { "additionalProperties": false, "examples": [ { "limit": 20, "question": "technology companies with gross margin above 40% and revenue over 1 billion" } ], "properties": { "limit": { "default": 50, "description": "Maximum number of periods or items to return (default 50, at most 200).", "maximum": 200, "minimum": 1, "type": "integer" }, "question": { "description": "What to screen for. Plain English, 3 to 300 characters, no links. Example: technology companies with gross margin above 40% and revenue over 1 billion.", "maxLength": 300, "minLength": 3, "type": "string" } }, "required": [ "question" ], "type": "object" }, "name": "screen_natural_language", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ question, parsed { filter, metrics, sort, period_type, sector, industry, country, limit }, equivalent_request, unparsed: [string], generated_by (\"model\" or \"rules\"), label, model, method_version, cached, result { the screen: metrics, items: [{ company, period, values { <metric>: value object } }], total, next_cursor } }", "properties": { "cached": { "type": "boolean" }, "equivalent_request": { "type": "string" }, "generated_by": { "enum": [ "model", "rules" ], "type": "string" }, "label": { "type": "string" }, "method_version": { "type": "string" }, "model": { "type": [ "string", "null" ] }, "parsed": { "type": "object" }, "question": { "type": "string" }, "result": { "type": "object" }, "unparsed": { "type": "array" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return 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). Use it when asked for revenue or profit by business line, geography or product.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL", "kind": "geography", "tag": "RevenueFromContractWithCustomerExcludingAssessedTax" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "kind": { "description": "Segment axis kind.", "enum": [ "business", "geography", "product", "mixed" ], "type": "string" }, "limit": { "default": 2, "description": "Maximum number of periods or items to return (default 2, at most 20).", "maximum": 20, "minimum": 1, "type": "integer" }, "period_type": { "default": "annual", "description": "Annual (four-quarter) or quarterly facts.", "enum": [ "annual", "quarterly" ], "type": "string" }, "tag": { "description": "Only this XBRL tag.", "pattern": "^[A-Za-z0-9_]{2,200}$", "type": "string" } }, "required": [ "company" ], "type": "object" }, "name": "segments", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ period_type, items: [{ tag, taxonomy, kind, member, dims, period_end, value }], note }", "properties": { "items": { "items": { "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "note": { "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "One call that returns the income statement, balance sheet and cash flow statement of a company exactly as FinancialMD knew them on a date: no later restatements, no periods filed afterwards. This is the tool for point-in-time work: backtests, \"what did an investor know on the day\", reproducing a past model, or checking whether a decision was made on numbers that were later restated. Each statement carries its own meta; a statement the company does not have is reported as an error inside the snapshot rather than failing the whole call. The ratios computed from the same facts as known on that date ride along under `ratios`.", "inputSchema": { "additionalProperties": false, "examples": [ { "as_of": "2023-06-30", "company": "ticker:AAPL", "limit": 4, "period_type": "annual" } ], "properties": { "as_of": { "description": "The knowledge date to replay (YYYY-MM-DD or RFC 3339). Required.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "limit": { "default": 5, "description": "Maximum number of periods or items to return (default 5, at most 200).", "maximum": 200, "minimum": 1, "type": "integer" }, "period_type": { "default": "annual", "description": "Period basis: annual (fiscal years), quarterly, ltm (last twelve months) or ytd (year to date).", "enum": [ "annual", "quarterly", "ltm", "ytd" ], "type": "string" } }, "required": [ "company", "as_of" ], "type": "object" }, "name": "snapshot_as_of", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "as_of plus one grid per key (income_statement, balance_sheet, cash_flow and ratios: { statement, period_type, view, currency, periods, rows, meta }), or { error } for a grid that is not available.", "properties": { "as_of": { "type": "string" }, "balance_sheet": { "type": "object" }, "cash_flow": { "type": "object" }, "income_statement": { "type": "object" }, "ratios": { "type": "object" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Daily open, high, low, close and volume of one listing of a company, newest session first, built from trades executed at IEX only. IEX is a single exchange with a small share of US volume: this is not the consolidated tape, close is the last IEX trade of the session and not the official closing price, volume is IEX volume only, and nothing is adjusted for splits or dividends. Say so when you quote a number, and show the citation in meta.attribution. For P/E, market capitalisation and other multiples use ratios_daily, which pairs each close with the facts known that day and withholds points after a likely split. ticker picks another listing of the company; from and to bound the session dates; as_of replays what was known on a date; cursor pages. Every number carries a proof naming the IEX session file it was read from.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL", "limit": 5 }, { "company": "cik:320193", "from": "2025-01-02", "limit": 250, "to": "2025-03-31" } ], "properties": { "adjust": { "default": "none", "description": "splits: each bar also carries split_adjusted values (confirmed splits after the session only); total_return: also total_return values, dividends reinvested at the IEX close before each ex-date (only dividends with an ex-date in the filings).", "enum": [ "none", "splits", "total_return" ], "type": "string" }, "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "from": { "description": "First session date, inclusive (YYYY-MM-DD).", "examples": [ "2025-01-02" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "limit": { "default": 30, "description": "Maximum number of periods or items to return (default 30, at most 1000).", "maximum": 1000, "minimum": 1, "type": "integer" }, "ticker": { "description": "Optional ticker of another listing of the same company (BRK.B). Default: the ticker in company, else the primary listing.", "examples": [ "BRK.B" ], "pattern": "^[A-Za-z0-9][A-Za-z0-9.\\-/]{0,11}$", "type": "string" }, "to": { "description": "Last session date, inclusive (YYYY-MM-DD).", "examples": [ "2025-01-02" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, "required": [ "company" ], "type": "object" }, "name": "stock_prices", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ items: [{ date, open, high, low, close, volume, has_broken_print }], next_cursor, listing: { ticker, mic, currency, is_primary } | null, listings, source: { id, venue, consolidated: false, adjusted: false, attribution, attribution_url, notes }, range: { from, to, sessions } }; open, high, low, close and volume are value objects. meta.attribution carries the citation the venue requires.", "properties": { "items": { "items": { "type": "object" }, "type": "array" }, "listing": { "type": [ "object", "null" ] }, "listings": { "items": { "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "range": { "type": "object" }, "source": { "type": "object" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Return technical indicators of a company's listing: simple and exponential moving averages, RSI, MACD, Bollinger bands, average true range and the close range. Computed by us from split-adjusted end-of-day bars built from trades at IEX only, with splits from the company's SEC filings. indicators takes ids such as sma_50, ema_20, rsi_14, macd, bollinger_20, atr_14, range_252 (period 2 to 400, at most 12 ids). data.latest holds the newest session as values with proofs; data.items is the series, newest first. Prices are end of day, published the day after the session: not real time, not the consolidated tape. The values are descriptive statistics, not buy or sell signals and not advice. Use it when asked for a moving average, RSI, MACD or a 52-week range.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL", "indicators": "sma_50,sma_200,rsi_14" } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "cursor": { "description": "Opaque cursor from a previous page (data.next_cursor).", "maxLength": 512, "type": "string" }, "from": { "description": "Oldest session to return (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "indicators": { "description": "Comma-separated indicator ids; default sma_20, sma_50, sma_200, ema_12, ema_26, rsi_14, macd, bollinger_20.", "maxLength": 200, "pattern": "^[a-z0-9_,]+$", "type": "string" }, "limit": { "description": "Sessions per page, newest first; default 30.", "maximum": 500, "minimum": 1, "type": "integer" }, "ticker": { "description": "One listing of the company; default the primary listing.", "maxLength": 12, "type": "string" }, "to": { "description": "Last session to use; default the newest (YYYY-MM-DD).", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } }, "required": [ "company" ], "type": "object" }, "name": "technical_indicators", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ listing, source { venue, consolidated, delay }, range, adjust, indicators: [{ id, kind, period, outputs, unit, warmup_sessions, ready, method }], latest { date, close, values { <output>: value object or null } }, items: [{ date, close, values, proof }], next_cursor, generated_by, method_version, note }", "properties": { "indicators": { "type": "array" }, "items": { "type": "array" }, "latest": { "type": [ "object", "null" ] }, "next_cursor": { "type": [ "string", "null" ] } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } }, { "description": "Check a number you have (from a model, a news story, a spreadsheet or memory) against what the company filed. Give the company, the concept (a concept_id or fiscal alias from metrics_list, for example income_statement_total_revenues or income_statement_net_income), the period (fiscal_year plus fiscal_period, or a period string such as \"FY2024\", \"Q4 2024\" or a period end date) and the value in whole currency units; FinancialMD returns the filed value object with its proof, the delta (absolute and percent), the tolerance (half a unit at the filed precision), a scale_hint when the number would match after a power-of-ten scale (millions given as units), and a verdict: matches, differs, or unknown (company and concept exist but no fact matches the period). Optionally name the source so the audit trail records it, and as_of to verify against what was known on a date. Use it before repeating a figure that came from a model, an article or memory.", "inputSchema": { "additionalProperties": false, "examples": [ { "company": "ticker:AAPL", "concept": "income_statement_total_revenues", "fiscal_period": "FY", "fiscal_year": 2024, "source": "analyst note", "value": 391035000000 }, { "company": "ticker:AAPL", "concept": "income_statement_net_income", "period": "Q4 2024", "value": 14736000000 } ], "properties": { "as_of": { "description": "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.", "examples": [ "2024-11-15", "2025-02-01T00:00:00Z" ], "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:\\d{2}))?$", "type": "string" }, "company": { "description": "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. An issuer on an EU or UK regulated market that does not file with the SEC has no CIK: pass its LEI (\"lei:IOG4E947OATN0KJYSD45\") or its fmd_ id.", "examples": [ "ticker:AAPL", "cik:320193", "fmd_01HZX8Q3K9W2M4N6P8R0T2V4X6" ], "maxLength": 64, "minLength": 1, "type": "string" }, "concept": { "description": "Concept id or fiscal alias from metrics_list, for example income_statement_total_revenues, income_statement_net_income, balance_sheet_total_assets, cash_flow_free_cash_flow.", "examples": [ "income_statement_total_revenues", "income_statement_net_income", "cash_flow_free_cash_flow" ], "pattern": "^[A-Za-z][A-Za-z0-9_.\\-]{0,127}$", "type": "string" }, "fiscal_period": { "description": "Fiscal period label: FY, Q1 to Q4 (or H1, H2). Defaults to FY when fiscal_year is given alone.", "enum": [ "FY", "Q1", "Q2", "Q3", "Q4", "H1", "H2" ], "type": "string" }, "fiscal_year": { "description": "Fiscal year of the period to check (use with fiscal_period, or give period instead).", "maximum": 2100, "minimum": 1990, "type": "integer" }, "period": { "description": "Alternative to fiscal_year and fiscal_period: \"FY2024\", \"Q4 2024\", \"2024Q4\", or a period end date \"2024-09-28\".", "examples": [ "FY2024", "Q4 2024", "2024-09-28" ], "maxLength": 24, "type": "string" }, "source": { "description": "Optional: where your number came from, recorded in the audit trail.", "maxLength": 256, "type": "string" }, "value": { "description": "The number to check, in the concept's base unit (whole currency units, not millions).", "type": "number" } }, "required": [ "company", "concept", "value" ], "type": "object" }, "name": "verify_value", "outputSchema": { "anyOf": [ { "required": [ "data", "meta" ] }, { "required": [ "error" ] } ], "description": "The FinancialMD envelope (docs/API.md section 2): data plus meta (request_id, as_of knowledge time, matched company, coverage, pipeline_version, licence, terms, proof_base). Every numeric value inside data is an object with value, unit, currency, period, known interval, restated flag, method and a proof pointing at the filing. On failure the result is isError with an error object instead.", "properties": { "data": { "description": "{ verdict, submitted { value, source }, filed (value object with proof) or null, delta { absolute, percent } or null, tolerance, scale_hint, concept { concept_id, label } }.", "properties": { "concept": { "properties": { "concept_id": { "type": "string" }, "label": { "type": "string" } }, "type": [ "object", "null" ] }, "delta": { "properties": { "absolute": { "type": "number" }, "percent": { "type": [ "number", "null" ] } }, "type": [ "object", "null" ] }, "filed": { "anyOf": [ { "description": "A proven number: value, unit, currency, decimals, period, known interval, restated, method, calc_type, proof.", "properties": { "calc_type": { "type": "string" }, "currency": { "type": [ "string", "null" ] }, "decimals": { "type": [ "integer", "null" ] }, "known": { "properties": { "from": { "type": "string" }, "to": { "type": [ "string", "null" ] } }, "type": "object" }, "method": { "type": "string" }, "period": { "type": "object" }, "proof": { "description": "Where a value comes from: filing accession, form, filing date, taxonomy and tag, source URL, page and anchor.", "properties": { "accession": { "type": "string" }, "anchor": { "type": [ "string", "null" ] }, "dims": {}, "filed": { "type": "string" }, "form": { "type": "string" }, "id": { "type": "string" }, "inputs": { "description": "For derived values (ratios): the proof ids of the inputs.", "items": { "type": "string" }, "type": "array" }, "page": { "type": [ "integer", "null" ] }, "source_url": { "type": "string" }, "tag": { "type": [ "string", "null" ] }, "taxonomy": { "type": [ "string", "null" ] } }, "type": "object" }, "restated": { "type": "boolean" }, "unit": { "type": "string" }, "value": { "type": [ "number", "null" ] } }, "type": "object" }, { "type": "null" } ] }, "scale_hint": { "type": [ "integer", "null" ] }, "submitted": { "properties": { "source": { "type": [ "string", "null" ] }, "value": { "type": "number" } }, "type": "object" }, "tolerance": { "type": [ "number", "null" ] }, "verdict": { "enum": [ "matches", "differs", "unknown" ], "type": "string" } }, "type": "object" }, "error": { "description": "Present only on isError results: the API error code and message plus remedy hints.", "properties": { "available_datasets": { "items": { "type": "string" }, "type": "array" }, "code": { "type": "string" }, "docs": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" }, "retry_after": { "type": [ "integer", "string" ] }, "status": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" }, "meta": { "description": "Request metadata: request_id, as_of, company resolution, coverage, pipeline_version, licence, terms, proof_base.", "properties": { "as_of": { "type": "string" }, "attribution": { "description": "Citations a source requires on anything shown from the answer.", "items": { "properties": { "source": { "type": "string" }, "text": { "type": "string" }, "url": { "type": "string" } }, "type": "object" }, "type": "array" }, "company": { "properties": { "cik": { "type": [ "integer", "null" ] }, "fmd_id": { "type": "string" }, "matched_by": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "coverage": { "properties": { "from": { "type": "string" }, "periods": { "type": "integer" }, "to": { "type": "string" } }, "type": "object" }, "licence": { "items": { "type": "string" }, "type": "array" }, "pipeline_version": { "type": "string" }, "proof_base": { "type": "string" }, "request_id": { "type": "string" }, "terms": { "type": "string" } }, "type": "object" } }, "type": "object" } } ] }
Verify it yourselfcurl -s https://api.teppi.xyz/v1/evidence/sha256:42b18cb17c2136a95af10bf4d400780b8ff08424561a139185d5e1605f6f43ff | sha256sum