Skip to content

GET /v3/financials/frames

One concept and period across companies: each company's latest incarnation known at as_of (one per CIK, unit and dimension set), from one index range per filing year, the period being the filed dates. With frame instead of period, a CALENDAR frame (layer L3): CY2024Q4 (durations of 91 +/- 30 days whose midpoint is in the quarter), CY2024 (365 +/- 30 days, midpoint in the year) or CY2024Q4I (instants nearest the quarter's end), one value per company as known at as_of -- reported before derived (a derived Q4 = FY - 9M); a derived quarter refused as basis_mismatch is never a number in the frame, only counted in refused.basis_mismatch. Frames hold facts without dimensions only. Deleted (SEC-withdrawn) filings are left out (each company's latest remaining incarnation) and named in excluded.

API key: required. See Authentication.

Group: Financial data (XBRL)

Parameters

NameInTypeRequiredDefaultDescription
conceptquerystringyesprefix:LocalName, e.g. us-gaap:Assets. Required.
periodquerystringnoYYYY-MM-DD: the instant; YYYY-MM-DD/YYYY-MM-DD: the duration (the filed dates). Required unless frame is given.
framequerystringnoA calendar frame instead of period: CY2024Q4, CY2024 or CY2024Q4I.
unitquerystringnoOnly this unit as stored: iso4217:USD, shares, iso4217:USD/shares, ...
dimsquerystringnonone (default: no dimensions), any, or a dims_hash (32 hex digits) for one exact dimension set.
as_ofquerystringnoInclusive: YYYY-MM-DDTHH:MM:SSZ (UTC, through the end of that second), YYYY-MM-DDTHH:MM:SS.ffffffZ (exact) or YYYY-MM-DD (the whole UTC day). Against each incarnation's filing acceptance time.
limitqueryintegerno500Page size, 1..50000: rows in CIK, unit and dimension order.
cursorquerystringnoOpaque cursor from a previous page's next_cursor; bound to the other parameters.

Responses

StatusBodyDescription
200XbrlFrame (application/json)OK
400Problem (application/problem+json)Invalid or unknown parameter.
401Problem (application/problem+json)Missing, invalid or inactive API key (code unauthorized), or a refused access token (code invalid_token: malformed, unknown key, bad signature, expired, wrong issuer or audience, revoked grant). WWW-Authenticate names the protected-resource metadata (RFC 9728).
503Problem (application/problem+json)Database unavailable; retry after the Retry-After delay.
defaultProblem (application/problem+json)Any other error (405, 500, 504).

Response body

A 200 carries a XbrlFrame object.

FieldTypeRequiredDescription
as_ofstring | nullyes
conceptstringyes
dataarray of objectyes
data[].accepted_atstringno
data[].accessionstringno
data[].decimalsstring | nullno
data[].derived_keystring | nullno
data[].dims_hashstring | nullno
data[].entity_cikstringno
data[].fact_seqinteger | nullno
data[].from_accessionstringno
data[].periodobjectnoWith frame only: the fact's own start and end.
data[].sourcestringnoWith frame only. One of: reported, derived.
data[].unit_normstringno
data[].valid_fromstringno
data[].valueNullableDecimalno
data[].value_rawstring | nullno
dimsstringyes
excludedExcludedno
excluded_totalintegerno
framestringnoWith frame only: CY2024Q4, CY2024 or CY2024Q4I.
has_morebooleanyes
next_cursorstring | nullyesPass as cursor for the next page; null on the last.
periodstringyesAs requested; with frame, the calendar period's dates (YYYY-MM-DD/YYYY-MM-DD, or the instant).
refusedobjectnoWith frame only: basis_mismatch, the number of companies whose only value for the frame is a derived quarter refused as basis_mismatch (no number in the frame).
rulestringno
rule_versionstringno
unitstring | nullno

Example request

Shell
curl -sS -H "Authorization: Bearer $SECBLAST_API_KEY" \
  'https://api.secblast.com/v3/financials/frames'

Open this route in the console

More in Financial data (XBRL)

Previous: GET /v3/financials/facts · Next: GET /v3/financials/series

Markdown version: /docs/reference/get-financials-frames.md