/data/filing-statements
Discovery — list every statement block in a filing with its block_index, statement_type (array of canonical statement-type labels; more than one when the block combines several statements; null for non-financial blocks such as the cover page), and role_label (filer-specific XBRL string). Use this to find out which statement_type / role_label / block_index values a specific filing exposes before calling POST /data/statement or the convenience endpoints.
POST/api/v1/data/filing-statements
Credits10 per successful debitRate limit120 per minute
Filing selection: standard (filing_id or ticker + fiscal_year + form_type + optional quarter).
Request:
filing_idintegerconditionaltickerstringconditionalform_typestringDefault 10-K.
fiscal_yearintegerconditionalquarterstringResponse:
ticker, form_type, fiscal_year, quarterFiling identity.
statementsArray of {block_index, statement_type, role_label}, ordered by block_index.
credits_usedAlways 10 when successful.
Errors:
| HTTP | error_code | When |
|---|---|---|
| 400 | DATA_FILING_QUARTER_REQUIRED | Ambiguous quarterly filings (charged). |
| 404 | DATA_FILING_NOT_FOUND | Filing not found. Still charged 10 credits. |
| 403 | PLAN_TIER_INSUFFICIENT_HISTORY | The filing, named by ticker and fiscal_year, is before your plan's history window. Not charged. |
| 403 | PLAN_TIER_INSUFFICIENT, PLAN_TIER_INSUFFICIENT_COVERAGE | The filing (by filing_id) or the company (by ticker) is outside your plan. Charged 10. |
| 402 | CREDITS_INSUFFICIENT | Insufficient credits. |
| 422 | — | Validation. |