cursor | string | No | Archive continuation token; reuse with snapshot ID/hash, as_of and unchanged filters. max length 4096 |
ticker | string | Yes | |
as_of | string | No | Availability cutoff, separate from event/period filters. Historical reads never refresh. |
snapshot_id | string | No | Pin continuation to the returned snapshot ID; reuse with snapshot_hash and as_of. |
snapshot_hash | string | No | |
filters_sha256 | string | No | Reuse the returned filter hash unchanged with continuation pages. |
offset | integer | No | min 0; max 10000000 |
limit | integer | No | Matching typed observations per page; default32. min 1; max 100 |
max_snapshot_age_hours | number | No | Requested verification-age tolerance: default1hour for retained archives,24hours for closing-price references. Record dates and publication cadence are separate. max 87600 |
date_from | string | No | Inclusive native date lower bound, selected by date_field. |
date_to | string | No | Inclusive native date upper bound, selected by date_field. |
date_field | ”period” | “report” | No | Date meaning; defaults to period for facts/macro/holdings/returns, event for insider trades, observation for options/short volume, scheduled for calendar. |
metrics | array of string | No | |
taxonomy | string | No | max length 128 |
unit | string | No | max length 64 |
family | ”financial” | “market_reference” | No | |
period_start | string | No | Exact reported fact period start; distinguish quarterly and annual facts with the same end date. |
reported_quarters | integer | No | min 0; max 4 |
record_type | ”financial_fact” | “financial_statement” | “company_reference” | “segment_metric” | “operating_kpi” | “management_guidance” | No | Select financial_fact, financial_statement, company_reference, segment_metric, operating_kpi or management_guidance. Issuer metrics use selected admitted SEC disclosures, not complete history; guidance is a forecast, not an actual result. |
basis | ”GAAP” | “IFRS” | “non_gaap” | “operational” | “unknown” | No | Accounting or operating basis; requires an issuer-metric record_type. |
dimension | string | No | Issuer-reported segment, product or geography label substring; requires an issuer-metric record_type. max length 128 |
period_label | string | No | Exact returned fiscal period label; requires an issuer-metric record_type. Use for guidance targets whose calendar dates are unknown; date_field=report instead filters issuance dates. max length 128 |
fiscal_year | integer | No | Issuer’s stated fiscal year; requires an issuer-metric record_type. Does not imply calendar-year dates. min 1900; max 2200 |
fiscal_quarter | integer | No | Issuer’s stated fiscal quarter, 1 through 4; use with fiscal_year for requested fiscal periods. min 1; max 4 |