Skip to main content
POST

Authorizations

Authorization
string
header
required

API key starting with sk_case_

Body

application/json

XBRL query parameters. The fields used depend on type.

type
enum<string>
required

concept: one line item for one company over time. facts: all concepts for one company (catalog, or values for the concepts you list). frames: one concept across all companies for one period.

Available options:
concept,
facts,
frames
cik
string

Company CIK, padded or unpadded (concept and facts). Provide exactly one of cik or ticker.

ticker
string

Company ticker (concept and facts). Provide exactly one of cik or ticker.

taxonomy
enum<string>
default:us-gaap

XBRL taxonomy. For facts it only filters the catalog and has no default.

Available options:
us-gaap,
ifrs-full,
dei,
srt
tag
string

XBRL element name such as NetIncomeLoss (required for concept and frames)

concepts
string[]

facts only. "taxonomy:tag" strings or bare tags (default us-gaap). Omit to get the concept catalog, which has no values.

unit
string

Unit such as USD, shares, or USD/shares. Optional filter for concept; defaults to USD for frames (the SEC URL form USD-per-shares is also accepted).

period
string

frames only, required. CY2024 = annual duration, CY2024Q1 = quarterly duration, CY2024Q1I = instantaneous (balance sheet items).

Pattern: ^CY\d{4}(Q[1-4]I?)?$
ciks
string[]

frames only. Restrict results to these CIKs (peer set).

tickers
string[]

frames only. Restrict results to these tickers (peer set).

sort
enum<string>
default:value_desc

frames only. Sort order by value.

Available options:
value_desc,
value_asc
formTypes
string[]

concept and facts. Filter by SEC form type such as 10-K or 10-Q.

fiscalPeriods
enum<string>[]

concept and facts. Filter by fiscal period.

Available options:
FY,
Q1,
Q2,
Q3
dateAfter
string<date>

concept and facts. Only facts whose period end date is on or after this date (YYYY-MM-DD).

dateBefore
string<date>

concept and facts. Only facts whose period end date is on or before this date (YYYY-MM-DD).

dedupe
boolean
default:true

concept and facts. When true, keep only facts the SEC assigned a calendar frame (its canonical fact per period), dropping prior-period comparatives re-reported in later filings. When false, return every reported fact.

limit
integer
default:25

Maximum rows to return

Required range: 1 <= x <= 100
offset
integer
default:0

Result offset for pagination

Required range: x >= 0

Response

XBRL data retrieved successfully

type
enum<string>
Available options:
concept,
facts,
frames
cik
string

Padded CIK (concept and facts)

ticker
string | null
entityName
string | null
taxonomy
string | null
tag
string

concept and frames

unit
string | null
period
string

frames only

sort
string

frames only

label
string | null
description
string | null
dedupe
boolean

concept and facts with concepts

formTypes
string[]
fiscalPeriods
string[]
dateAfter
string<date> | null
dateBefore
string<date> | null
limit
integer
offset
integer
total
integer

Rows matching before pagination

facts
object[]

concept, and facts when concepts is provided

concepts
object[]

facts without concepts: the catalog of concepts the company reports

data
object[]

frames: one row per reporting company