Skip to content

Schemas

The objects the routes take and return. Fields of nested objects are written with dots; [] marks the items of an array.

Schema: Addresses

FieldTypeRequiredDescription
businessobject | nullno{street1, street2, city, state, zip, phone} as filed.
mailobject | nullno

Schema: CallbackAttempt

FieldTypeRequiredDescription
atdate-time (RFC 3339, UTC)yes
duration_msinteger | nullyes
error_classstring | nullyesOne of: timeout, connect, tls, dns, blocked_address, redirect, http, too_large, null.
http_statusinteger | nullyesNull when no status line was received.
nintegeryes1 for the first attempt.
remote_ipstring | nullyesThe address connected to.
response_excerptstring | nullyesThe first 512 bytes of the endpoint's answer.

Schema: CallbackDelivery

One delivery of a webhook event to one endpoint.

FieldTypeRequiredDescription
accessionstring | nullyesThe filing's accession number, for filing events.
attempt_countintegeryesAttempts made so far; a manual retry or a replay continues the count.
billed_bytesintegeryesThe payload bytes billed: the payload size once the endpoint answered 2xx, else 0. Failed attempts, test events and endpoint verification are not billed.
created_atdate-time (RFC 3339, UTC)yes
delivered_atdate-time (RFC 3339, UTC) | nullyes
endpoint_idstringyescbe_ and 24 hex digits.
held_reasonstring | nullyesOnly while state is held. One of: quota_exceeded, plan_required, endpoint_disabled, endpoint_unverified, digest, null.
idstringyesdlv_ and 24 hex digits.
last_attempt_atdate-time (RFC 3339, UTC) | nullyesWhen the newest attempt was made; null before the first.
last_errorstring | nullyesWhy the last attempt failed (an error class such as timeout, or gone, quota_exceeded, plan_required, hold_expired, endpoint_inactive, superseded: a verification challenge replaced by a newer one before it was sent).
last_statusinteger | nullyesThe HTTP status of the last attempt that got one.
next_attempt_atdate-time (RFC 3339, UTC) | nullyesWhen the next attempt is due; only while state is pending.
statestringyespending: waiting for its next attempt. held: waiting for a condition (held_reason). delivering: an attempt is in flight. delivered: the endpoint answered 2xx. failed: every attempt failed, or the endpoint answered 410, or a hold ran out (last_error says which). dropped: the endpoint was inactive or the hold on an unverified or disabled endpoint ran out, or (a verification) a newer challenge replaced it. One of: pending, held, delivering, delivered, failed, dropped.
subscription_idstring | nullyessub_ and 24 hex digits; null for an event that belongs to no subscription.
typestringyesThe event type, for example filing.new.

Schema: CallbackDeliveryDetail

FieldTypeRequiredDescription
accessionstring | nullyesThe filing's accession number, for filing events.
attempt_countintegeryesAttempts made so far; a manual retry or a replay continues the count.
billed_bytesintegeryesThe payload bytes billed: the payload size once the endpoint answered 2xx, else 0. Failed attempts, test events and endpoint verification are not billed.
created_atdate-time (RFC 3339, UTC)yes
delivered_atdate-time (RFC 3339, UTC) | nullyes
endpoint_idstringyescbe_ and 24 hex digits.
held_reasonstring | nullyesOnly while state is held. One of: quota_exceeded, plan_required, endpoint_disabled, endpoint_unverified, digest, null.
idstringyesdlv_ and 24 hex digits.
last_attempt_atdate-time (RFC 3339, UTC) | nullyesWhen the newest attempt was made; null before the first.
last_errorstring | nullyesWhy the last attempt failed (an error class such as timeout, or gone, quota_exceeded, plan_required, hold_expired, endpoint_inactive, superseded: a verification challenge replaced by a newer one before it was sent).
last_statusinteger | nullyesThe HTTP status of the last attempt that got one.
next_attempt_atdate-time (RFC 3339, UTC) | nullyesWhen the next attempt is due; only while state is pending.
statestringyespending: waiting for its next attempt. held: waiting for a condition (held_reason). delivering: an attempt is in flight. delivered: the endpoint answered 2xx. failed: every attempt failed, or the endpoint answered 410, or a hold ran out (last_error says which). dropped: the endpoint was inactive or the hold on an unverified or disabled endpoint ran out, or (a verification) a newer challenge replaced it. One of: pending, held, delivering, delivered, failed, dropped.
subscription_idstring | nullyessub_ and 24 hex digits; null for an event that belongs to no subscription.
typestringyesThe event type, for example filing.new.
attemptsarray of CallbackAttemptyesEvery attempt, oldest first; empty before the first.
payloadobjectyesThe event as sent, the body of the request.

Schema: CallbackDeliveryList

FieldTypeRequiredDescription
dataarray of CallbackDeliveryyes
next_cursorstring | nullyesPass it as cursor for the next page; null on the last page.

Schema: CallbackEndpoint

A webhook endpoint of the caller's organization. The signing secret is never part of it.

FieldTypeRequiredDescription
activebooleanyes
created_atdate-time (RFC 3339, UTC)yes
descriptionstring | nullyes
event_typesarray of stringyes
healthobjectyes
health.consecutive_failuresintegerno
health.disabled_atdate-time (RFC 3339, UTC) | nullno
health.disabled_reasonstring | nullno
health.failing_sincedate-time (RFC 3339, UTC) | nullno
health.last_success_atdate-time (RFC 3339, UTC) | nullno
health.statestringyesOne of: unverified, active, failing, disabled.
health.verified_atdate-time (RFC 3339, UTC) | nullno
idstringyescbe_ and 24 hex digits.
last_24hobjectyesDeliveries of the last 24 hours by state.
last_24h.deliveredintegerno
last_24h.droppedintegerno
last_24h.failedintegerno
last_24h.heldintegerno
updated_atdate-time (RFC 3339, UTC)yes
urlstringyesAs stored: https, the host in lower case, no :443, / for an empty path.

Schema: CallbackEndpointCreate

FieldTypeRequiredDescription
descriptionstring | nullnoAt most 800 bytes.
event_typesarray of stringyes
urlstringyeshttps only, port 443 only, no user name or password, a public DNS name (not an IP address, localhost, .local or .internal) of letters, digits and hyphens (an international name in its xn-- form) that resolves to a public address; at most 2,048 characters.

Schema: CallbackEndpointCreated

FieldTypeRequiredDescription
activebooleanyes
created_atdate-time (RFC 3339, UTC)yes
descriptionstring | nullyes
event_typesarray of stringyes
healthobjectyes
health.consecutive_failuresintegerno
health.disabled_atdate-time (RFC 3339, UTC) | nullno
health.disabled_reasonstring | nullno
health.failing_sincedate-time (RFC 3339, UTC) | nullno
health.last_success_atdate-time (RFC 3339, UTC) | nullno
health.statestringyesOne of: unverified, active, failing, disabled.
health.verified_atdate-time (RFC 3339, UTC) | nullno
idstringyescbe_ and 24 hex digits.
last_24hobjectyesDeliveries of the last 24 hours by state.
last_24h.deliveredintegerno
last_24h.droppedintegerno
last_24h.failedintegerno
last_24h.heldintegerno
updated_atdate-time (RFC 3339, UTC)yes
urlstringyesAs stored: https, the host in lower case, no :443, / for an empty path.
secretstringyeswhsec_ and the standard base64 (with padding) of 32 random bytes: the Standard Webhooks signing secret. Shown only in this answer.

Schema: CallbackEndpointList

FieldTypeRequiredDescription
dataarray of CallbackEndpointyes
has_morebooleanyes
limitsobjectyes
limits.endpointsobjectno
limits.endpoints.limitinteger | nullnoThe plan's limit; 0 without callbacks.
limits.endpoints.usedintegernoActive endpoints.
next_cursorstring | nullyes

Schema: CallbackEndpointPatch

FieldTypeRequiredDescription
activebooleannotrue on an inactive endpoint counts against the plan's limit.
descriptionstring | nullnonull clears it.
event_typesarray of stringno
urlstringno

Schema: CallbackEndpointTestRequest

FieldTypeRequiredDescription
typestringyesOne of the endpoint's event_types. The sample event has this type and test: true in its envelope; there is no separate test type. One of: filing.new, filing.updated, filing.corrected, filing.deleted, search.match, search.digest, filing.digest, search.export.completed.

Schema: CallbackEndpointTestResult

FieldTypeRequiredDescription
deliveredbooleanno200 only: the endpoint answered 2xx.
duration_msinteger | nullno200 only: the attempt's duration.
error_classstring | nullno200 only. One of: timeout, connect, tls, dns, blocked_address, redirect, http, too_large, null.
http_statusinteger | nullno200 only: the endpoint's status; null when no HTTP answer came.
idstringyesThe test delivery's id (dlv_ and 24 hex digits), in the delivery log.
statestringyes200: delivered, failed or dropped (the attempt's outcome is final: a test send is attempted once). 202: still pending, delivering or held when the 12 seconds ran out; the delivery is still made, and its outcome is in the delivery log. One of: pending, delivering, held, delivered, failed, dropped.

Schema: CallbackReplayRequest

FieldTypeRequiredDescription
fromstringyesStart of the window of created_at, inclusive: YYYY-MM-DDTHH:MM:SSZ, or YYYY-MM-DD for midnight UTC.
statesarray of stringnoDefault both.
tostringnoEnd of the window, exclusive, same forms; default now. The window is at most 30 days.
typesarray of stringnoOnly deliveries of these event types; default every type.

Schema: CallbackReplayResult

FieldTypeRequiredDescription
last_created_atdate-time (RFC 3339, UTC) | nullyesWhen truncated: the created_at (whole seconds) of the last delivery requeued; replay again with the same to, states and types and from set to it.
replayedintegeryesDeliveries requeued.
truncatedbooleanyestrue when more than 10,000 deliveries matched; the oldest 10,000 were requeued.

Schema: CallbackRetryRequest

No members; the body is optional.

An object with no fixed fields.

Schema: CallbackRotateSecret

FieldTypeRequiredDescription
expire_previous_in_sintegernoHow long the previous secret still signs beside the new one; 0: not at all.

Schema: CallbackVerifyRequest

No members; the body is optional. The challenge goes to the endpoint's stored url.

An object with no fixed fields.

Schema: Coverage

FieldTypeRequiredDescription
computed_atdate-time (RFC 3339, UTC)noWhen data (the per-day part) was computed, UTC. The value is served until a later computation replaces it.
dataarray of CoverageDayyesPer feed day, the latest non-superseded ingest run; newest day first. At most window.max_days days: the newest ones of the window. The default window is recomputed in the background every few minutes, an explicit one by a request at most once a minute; computed_at says when.
liveobject | nullnoLive ingest: the daemon's last heartbeat (it writes one every 10 s). Null when there is none or live ingest is not enabled. It can be old: live_check says what to make of it. Only the members listed here are given, each checked: a number outside 0..10^15, a time that is not one, or a word outside its list is null, and no free text of the daemon is passed on.
live.covered_untildate-time (RFC 3339, UTC) | nullnoSEC's list of new filings has been read without a gap up to here.
live.endedstring | nullnoHow the session ended; null while it runs. The reason is in the daemon's log, not here. One of: clean, failed, null.
live.fetchobjectnorequests, http_404, http_429, http_5xx, network, integrity, too_large, bytes, and recent {requests, failed}.
live.filingsobjectnoCounts since the session started: seen, listed, documents, failed, skipped_known, and per_min_1, per_min_5, per_min_peak.
live.heartbeat_atdate-time (RFC 3339, UTC) | nullno
live.items_unmappednumber | nullno8-K item descriptions seen without an item code.
live.last_new_accessionstring | nullno
live.last_new_filing_atdate-time (RFC 3339, UTC) | nullno
live.latency_msobjectnorecent (the last window_s seconds) and day: n, and p50 / p95 of accept_to_seen, seen_to_listed, seen_to_documents.
live.limiterobjectnoThe shared SEC request limiter as the daemon sees it: priority (on, off, unavailable), wait_ms {p50, p95}, waits_over_1s, refused.
live.modestring | nullnoOne of: live, dry_run, null.
live.paused_untildate-time (RFC 3339, UTC) | nullno
live.pauses_24hnumber | nullno
live.pollobjectnoCounts of polls and sweeps of SEC's list; rtt_ms and skew_ms in milliseconds.
live.poll.below_page0number | nullno
live.poll.failednumber | nullno
live.poll.last_ok_atdate-time (RFC 3339, UTC) | nullno
live.poll.last_poll_failedbooleannoWhether the last poll failed. The error text stays in the daemon's log.
live.poll.oknumber | nullno
live.poll.out_of_ordernumber | nullno
live.poll.overflowsnumber | nullno
live.poll.pages_sweptnumber | nullno
live.poll.rtt_msobjectno
live.poll.skew_msnumber | nullno
live.poll.sweepsobjectno
live.poll.sweeps_abandonednumber | nullno
live.poll.sweeps_exhaustednumber | nullno
live.poll.uncoveredarray of objectnoSpans of SEC's list a sweep could not cover (the nightly feed covers those filings); at most 50.
live.poll.uncovered[].atdate-time (RFC 3339, UTC) | nullno
live.poll.uncovered[].fromdate-time (RFC 3339, UTC) | nullno
live.poll.uncovered[].reasonstring | nullnoOne of: max_start, page_unanswered, null.
live.poll.uncovered[].untildate-time (RFC 3339, UTC) | nullno
live.poll_interval_msnumber | nullno
live.queueobjectnofetch_fresh, fetch_backlog, build, retry, oldest_age_s, behind_since.
live.roles_unmappedintegernoRole strings of SEC's list that have no v3 role (how many, not which).
live.schemanumber | nullno
live.started_atdate-time (RFC 3339, UTC) | nullno
live.statestring | nullnoOne of: ok, idle, catching_up, paused, cautious, sec_unreachable, db_down, disk_low, halted, stopping, stopped, failed, null.
live.window_openboolean | nullno
live_checkstringnoAs checks.live of /v3/health. One of: ok, paused, degraded, down, disabled.
snapshotobjectyesThe snapshot store and the snapshot it serves.
snapshot.accessionsinteger | nullnoDistinct filings in the snapshot.
snapshot.age_daysinteger | nullno
snapshot.availablebooleanno
snapshot.datedate (YYYY-MM-DD) | nullno
snapshot.fallbackboolean | nullnoA newer snapshot exists but could not be loaded.
snapshot.filersinteger | nullno
snapshot.filingsinteger | nullnoFiling listings in the snapshot (a filing listed by two filers counts twice).
snapshot.loaded_atdate-time (RFC 3339, UTC) | nullno
snapshot.reloadingboolean | nullnoA newer snapshot is being loaded; the current one keeps serving.
snapshot.staleboolean | nullnoThe snapshot is more than 3 days old.
snapshot.statestringnoOne of: ok, stale, loading, unavailable, disabled.
snapshot.tickers_datedate (YYYY-MM-DD) | nullnoNewest copy of SEC's ticker file.
snapshot.tickers_fromdate (YYYY-MM-DD) | nullnoOldest copy kept.
totalsobjectyesTable-wide totals, whatever the window; recomputed in the background every few minutes (5 by default). They are served until a later computation replaces them: when one fails, the previous totals stay, and computed_at shows their age.
totals.accepted_at_storedintegernoFilings with an acceptance time stored in v3 (any source: a header time, or SEC's from the snapshot sync).
totals.amendmentsintegernoAmendments, deleted ones excluded.
totals.amendments_resolvedintegernoOf those amendments, the ones linked to their original.
totals.computed_atdate-time (RFC 3339, UTC)noWhen the totals were computed, UTC.
totals.deleted_filingsintegerno
totals.documentsintegerno
totals.filingsintegerno
totals.max_feed_datedate (YYYY-MM-DD) | nullno
totals.max_filing_datedate (YYYY-MM-DD) | nullno
totals.min_feed_datedate (YYYY-MM-DD) | nullno
totals.min_filing_datedate (YYYY-MM-DD) | nullno
truncatedbooleanyesTrue when the window holds more feed days than max_days: the older ones are left out. Ask for them with from / to.
windowobjectyesThe window of feed days this answer covers.
window.defaultbooleannoTrue when neither from nor to was given: the last 90 feed days.
window.fromdate (YYYY-MM-DD) | nullnoThe from that was asked for; without one, the oldest day listed (null when no day is listed).
window.max_daysintegernoThe most days one answer lists: 90 for the default window, 366 when from or to is given.
window.todate (YYYY-MM-DD) | nullnoThe to that was asked for; without one, the newest day listed (null when no day is listed).

Schema: CoverageCount

FieldTypeRequiredDescription
as_ofdate-time (RFC 3339, UTC)yesWhen these figures were read, UTC (every few seconds; 5 by default).
deletedintegeryesFilings SEC deleted (status deleted), now. Not counted in filings; they are still served.
documentsintegeryesCurrent documents, counted as documents of /v3/coverage/summary (one per document of each filing, deleted filings included) plus those of filings registered since. Never goes down within a running server.
filingsintegeryesFilings in v3 that are not deleted: final and provisional (filings_basis). Never goes down between two answers of a running server except after a deletion. A filing registered with an old acceptance time (a backfill) is added at the next computation of /v3/coverage/summary, at most about 20 minutes later; right after that computation filings equals its filings.final + filings.provisional.
filings_basisstringyesWhat filings counts: final and provisional filings; deleted filings are not counted. One of: final_and_provisional.
latest_accepted_atdate-time (RFC 3339, UTC) | nullyesThe newest SEC acceptance time of a filing that is not deleted.
liveobject | nullyesLive ingest latency over the daemon's current New York day, from its own status, read with the counts. "seen" is when SEC Blast's poll of SEC's list of new filings first saw the filing. SEC publishes no time at which a filing appears in that list, so the time from SEC publishing a filing to it being seen is not measured; it is bounded by poll_interval_ms. Null when this deployment has no live ingest.
live.accept_to_seen_msobjectnoSEC's acceptance time to seen, milliseconds.
live.accept_to_seen_ms.p50number | nullno
live.accept_to_seen_ms.p95number | nullno
live.checkstringnoAs checks.live of /v3/health. One of: ok, paused, degraded, down.
live.ninteger | nullnoFilings whose documents live ingest stored that day.
live.poll_interval_msnumber | nullnoThe daemon's current interval between two polls of SEC's list.
live.seen_to_documents_msobjectnoSeen to the filing's documents being stored and registered, milliseconds.
live.seen_to_documents_ms.p50number | nullno
live.seen_to_documents_ms.p95number | nullno
live.seen_to_stored_msobjectnoSeen to the filing being registered in the database (from then on the API lists it, provisional), milliseconds.
live.seen_to_stored_ms.p50number | nullno
live.seen_to_stored_ms.p95number | nullno
live.windowstringnoThe figures cover the daemon's current New York day. One of: day.
live.window_openboolean | nullnoThe daemon is in its business-hours window (fast polling).
provisionalintegeryesFilings registered by live ingest and not yet confirmed by SEC's nightly feed (status provisional), now.
summary_computed_atdate-time (RFC 3339, UTC) | nullyescomputed_at of the /v3/coverage/summary counts these figures add to.

Schema: CoverageDay

FieldTypeRequiredDescription
daydate (YYYY-MM-DD)no
filingsintegernoFilings whose feed_date is this day.
finished_atdate-time (RFC 3339, UTC) | nullno
members_failedintegerno
members_okintegerno
members_skippedintegerno
members_totalintegerno
realtimeobject | nullnoLive ingest activity, from the daemon's session records of this New York calendar day that ran in mode live (dry runs are left out); null when there is none or live ingest is not enabled. Not the live view of this feed day's filings: a filing accepted after 17:30 belongs to the next feed day, weekend sessions fall on no feed day, and today's activity is in the top-level live until the nightly feed has run.
realtime.documentsintegernoFilings whose documents were registered (on the day that happened, which can be the day after the filing was seen).
realtime.failedintegernoFilings whose documents could not be fetched; the feed supplies them.
realtime.latency_msobject | nullnoThe newest session's latency figures for its day: n, and p50 / p95 of accept_to_seen, seen_to_listed, seen_to_documents, in milliseconds.
realtime.listedintegernoFilings registered from their header (visible in the API).
realtime.seenintegernoSightings in SEC's list of new filings. Not distinct filings: one in flight across a restart of the daemon is counted again.
realtime.sessionsintegernoSessions of the daemon that day (a restart starts a new one). The counts are summed over them.
realtime.skippedintegernoSightings of filings v3 already had; every restart's catch-up adds to it.
reconciliationobject | nullnoThe newest complete reconcile run of the day (a later partial run does not replace it); null when the day has none.
reconciliation.chains_deferredintegernoFilings whose version chain was still waiting to be re-ordered with snapshot acceptance times when the run ended; 0 when none.
reconciliation.finished_atdate-time (RFC 3339, UTC) | nullno
reconciliation.outcomesobjectnocheck name → outcome → row count. Checks: feed_vs_daily_index, feed_vs_submissions, and, for a day live ingest covered, feed_vs_realtime (what the feed's copy changed against the live one: equal_after_normalization, header_changed, docs_added, docs_changed; realtime_missed: in the feed, never seen live; realtime_only: seen live, never delivered by the feed).
reconciliation.run_idintegerno
reconciliation.statusstringnoBoth comparisons (SEC daily index, submissions snapshot) ran. It does not say that the order of version chains is final: see chains_deferred. One of: complete.
run_idintegerno
started_atdate-time (RFC 3339, UTC) | nullno
statusstringnoOne of: running, complete, partial, source_invalid, failed.

Schema: CoverageSummary

FieldTypeRequiredDescription
amendmentsobjectyesAmendment links by link status; amendments of deleted filings are not counted. link_rate is resolved / total, rounded to 4 decimals; null when total is 0.
amendments.ambiguousintegerno
amendments.link_ratenumber | nullno
amendments.resolvedintegerno
amendments.target_not_publicintegerno
amendments.target_not_yet_ingestedintegerno
amendments.totalintegerno
amendments.unresolvedintegerno
before_1993objectyesFilings whose by_year_basis date is before 1993, deleted filings not counted: paper records keyed in later, and dates SEC mistyped. Not years of coverage, so not in by_year.
before_1993.filingsintegerno
before_1993.first_yearinteger | nullnoThe earliest year counted; null when filings is 0.
before_1993.paperintegernoPaper filing records among filings (is_paper).
by_yeararray of objectyesFilings per calendar year of by_year_basis from 1993 (EDGAR's first year), oldest year first; deleted filings are not counted. Filings dated earlier are counted in before_1993.
by_year[].filingsintegerno
by_year[].paperintegernoPaper filing records among filings (is_paper).
by_year[].yearintegerno
by_year_basisstringyesThe date by_year groups by. One of: filing_date.
callbacksobject | nullyesWebhook delivery, computed with the counts. Null when this deployment has no webhook delivery.
callbacks.computed_atdate-time (RFC 3339, UTC)noWhen the callbacks block was computed, UTC.
callbacks.latencyobjectno
callbacks.latency.first_attempt_from_acceptedobjectnoSeconds from SEC's acceptance to the first delivery attempt, over the first attempts of the last 24 hours of filing.new and search.match deliveries of live filings (test sends and filings first seen in the nightly feed are left out; nearest-rank percentiles; n is the number of first attempts).
callbacks.latency.first_attempt_from_accepted.nintegerno
callbacks.latency.first_attempt_from_accepted.p50number | nullnoNull when n is 0.
callbacks.latency.first_attempt_from_accepted.p95number | nullnoNull when n is 0.
computed_atdate-time (RFC 3339, UTC)yesWhen the counts were computed, UTC. They are served until a later computation replaces them.
document_versionsintegeryesStored document versions, every delivery of every document.
documentsintegeryesCurrent documents (one per document of each filing).
feed_daysobjectyesFeed days with a complete or partial ingest run (targeted repair runs not counted).
feed_days.countintegerno
feed_days.firstdate (YYYY-MM-DD) | nullno
feed_days.lastdate (YYYY-MM-DD) | nullno
filingsobjectyesFilings in v3 by status; total counts every status.
filings.deletedintegerno
filings.finalintegerno
filings.provisionalintegerno
filings.totalintegerno
gapsobject | nullyesKnown coverage gaps, from a list maintained by hand and read when the server starts: feed days absent from the archive, feed days SEC delivered truncated, and filings no feed delivers. Null when this deployment has no list.
liveobject | nullyesLive ingest, read per request from the daemon's newest session (at most once every 2 s for the whole process). Null when this deployment has no live ingest.
live.checkstringnoAs checks.live of /v3/health. One of: ok, paused, degraded, down.
live.covered_untildate-time (RFC 3339, UTC) | nullnoSEC's list of new filings has been read without a gap up to here.
live.last_new_filing_atdate-time (RFC 3339, UTC) | nullnoWhen the newest filing was first seen.
live.median_lag_secondsinteger | nullnoMedian seconds from SEC's acceptance to the filing being seen, over the daemon's current New York day; null with fewer than 5 filings that day, and when the figure is negative or absurd.
live.modestring | nullnoOne of: live, dry_run, null.
live.statestring | nullnoThe daemon's own state in its last heartbeat, as live.state of /v3/health without the dry_run substitution.
streamobject | nullyesThe filing stream, computed with the counts. Null when this deployment has no stream.
stream.computed_atdate-time (RFC 3339, UTC)noWhen the stream block was computed, UTC.
stream.head_seqinteger | nullnoThe last stream seq the sequencer assigned; null before its first pass.
stream.latencyobjectno
stream.latency.from_acceptedobjectnoSeconds from SEC's acceptance to the filing.new event, over live filings of the last 24 hours (nearest-rank percentiles; n is the number of filings, zeros when it is 0).
stream.latency.from_accepted.nintegerno
stream.latency.from_accepted.p50number | nullnoNull when n is 0.
stream.latency.from_accepted.p95number | nullnoNull when n is 0.

Schema: Dataset

FieldTypeRequiredDescription
coverageobjectnoA range, not a statement that every filing in it is parsed.
coverage.basisstringno
coverage.fromdate (YYYY-MM-DD) | nullno
coverage.todate (YYYY-MM-DD) | nullno
datasetstringno
derive_stepsarray of objectno
derive_steps[].stepstringno
derive_steps[].versionstringno
descriptionstring | nullno
extractorstringno
filingsobjectnoOnly when the server is configured to publish it (owner default: off).
filings.by_statusobjectno
filings.totalintegerno
formsarray of stringno
latest_parsed_atdate-time (RFC 3339, UTC) | nullno
linksobjectno
queueobjectnoThe queue of the extractor's active version: its depth. failed (filings the worker gave up on) only with the server option datasets_status_counts.
queue.failedintegerno
queue.oldest_queued_atdate-time (RFC 3339, UTC) | nullno
queue.queuedintegerno
rows_estimatedobjectnoEstimated rows per table (the planner's statistics); null when never analysed.
statusstringnoOne of: available, in_preparation.
tablesarray of stringno
versionstringnoThe deployed extractor version.

Schema: DatasetList

FieldTypeRequiredDescription
computed_atdate-time (RFC 3339, UTC)yes
dataarray of Datasetyes
has_morebooleanyes
next_cursorstring | nullyes

Schema: DocTableCell

FieldTypeRequiredDescription
colintegerno
col_spanintegerno
currencystring | nullno
dashbooleanno
fact_idsarray of stringno
footnotesarray of stringno
headerbooleanno
idstringno
negativebooleanno
numericbooleanno
percentbooleanno
punctuationbooleanno
rowintegerno
row_spanintegerno
scaleinteger | nullnoThe power of ten that applies to this value (0 for per-share amounts and percents).
span_endintegerno
span_startintegerno
textstringno
text_endintegerno
text_startintegerno
valuestring | nullnoThe number as displayed (Decimal string, sign applied, not scaled).
value_rawstring | nullno

Schema: DocTableOutline

FieldTypeRequiredDescription
block_idstringno
block_ordinalintegerno
captionstring | nullno
column_headersarray of stringno
extractor_versionstringno
fact_cellsintegerno
header_rowsintegerno
kindstringnoOne of: data, layout.
kind_reasonstringnoOne of: values, too_small, few_values, text, contents.
n_colsintegerno
n_rowsintegerno
pageintegerno
per_share_exceptbooleanno
scaleinteger | nullnoThe power of ten the table states (in thousands: 3); null when it states none.
scale_sourcestring | nullnoOne of: header, caption, continued, document, null.
scale_textstring | nullno
span_endintegerno
span_startintegerno
text_cellsintegerno
text_endintegerno
text_startintegerno
value_cellsintegerno

Schema: DocTables

FieldTypeRequiredDescription
accessionstringno
cellsarray of DocTableCell | nullno
cells_reasonstring | nullnoOne of: model_changed, bytes_unavailable, rules_changed, null.
cells_statusstringnoOne of: current, from_version, reparse_pending.
dataarray of DocTableOutlineno
documentobject | nullno
extractionobjectno
filingFilingRefno
has_morebooleanno
next_cursorstring | nullno
rules_versionstringno
tableDocTableOutlineno

Schema: Document

FieldTypeRequiredDescription
decode_statusstringnoOne of: ok, repaired, failed.
descriptionstring | nullno
encodingstringnoOne of: text, uu, base64.
filenamestringno
is_primarybooleanno
mimestringno
seqintegerno
sha256string | nullnoHex SHA-256 of the stored bytes; also the ETag.
size_bytesinteger | nullno
typestringno
urlstringno

Schema: DocumentList

FieldTypeRequiredDescription
dataarray of Documentyes
has_morebooleanno
next_cursorstring | nullno

Schema: EightKEvent

FieldTypeRequiredDescription
confidencenumberno
event_nointegerno
event_typestringno
exhibitsarray of objectno
exhibits[].doc_seqinteger | nullno
exhibits[].numberstringno
exhibits[].typestring | nullno
exhibits[].urlstring | nullno
extracted_atstringno
extractor_versionstringno
fieldsarray of EightKEventFieldno
flagsarray of stringno
item_codestringno
item_text_endintegerno
item_text_startintegerno
rulesstringno
rules_versionstringno

Schema: EightKEventField

FieldTypeRequiredDescription
confidencenumbernorule confidence
doc_seqintegerno
fiscal_year_endstringno2.02 period_kind from the fiscal calendar: the fiscal year end used, --MM-DD.
fiscal_year_end_sourcestringnoOne of: xbrl, sec_header.
namestringno
period_kind_sourcestringno2.02 period_kind only: derived from period_end and the company's fiscal year end (q1, q2, q3, year_and_q4, other), or the text's reading. One of: fiscal_calendar, text.
rule_idstringno
span_endintegerno
span_exactbooleannoTrue: span_start..span_end are exactly the filed characters; false: the enclosing element.
span_startintegerno
text_endintegerno
text_startintegerno
valueanynoTyped by value_type: a string, an array of strings, YYYY-MM-DD, a boolean, or a Decimal string for a number.
value_as_foundstringnoThe filed characters the value was read from.
value_typestringnoOne of: text, text_list, date, boolean, number.

Schema: EightKEventList

FieldTypeRequiredDescription
accuracyobjectnoItems 1.01 and 2.01 only (served with a field list): served_fields_version, served_fields, event_type_served, holdout, holdout_filings, and per served field (and event_type when served) precision, recall, tp, fp, fn, n on the item's holdout (static). 1.01 serves event_type, cash_per_share, exchange_ratio, price_per_share; 2.01 serves cash_per_share, exchange_ratio, price_per_share, closing_date, with event_type transaction_completed.
as_ofstring | nullno
dataarray of objectno
data[].eventsarray of EightKEventno
data[].filingFilingRefno
data[].item_codestringno
data[].linksobjectno
has_morebooleanno
itemstringno
next_cursorstring | nullno
snapshotobjectno

Schema: EightKExhibit

FieldTypeRequiredDescription
block_idstringno
confidencenumber | nullno
descriptionstring | nullno
found_instringno
item_codestring | nullno
link_hrefstring | nullno
number_as_filedstringno
row_nointegerno
span_endintegerno
span_startintegerno

Schema: EightKFiling

FieldTypeRequiredDescription
accessionstringno
documentobject | nullno
exhibitsarray of EightKExhibitno
extractionExtractionno
filingFilingRefno
header_body_agreeboolean | nullno
item_setsobject | nullno
item_sets.bodyarray of anyno
item_sets.headerarray of anyno
item_sets.unionarray of anyno
itemsarray of EightKItemno
linksobjectno
mismatch_kindstring | nullnoOne of: none, header_omits_901, differs, null.
snapshotSnapshotno

Schema: EightKItem

FieldTypeRequiredDescription
body_statusstringnoOne of: heading, combined_heading, not_applicable, not_found.
confidencenumber | nullnoRule confidence by heading kind (not a probability).
flagsarray of stringno
in_bodybooleanno
in_headerbooleanno
item_codestringno
item_legacystring | nullno
linksobjectno
mappingstringnoOne of: none, legacy_2004.
sectionstringno
sourcestringnoOne of: header, body, both.
span_endinteger | nullno
span_startinteger | nullno
text_endinteger | nullno
text_startinteger | nullno
titlestring | nullno

Schema: EightKItemSearchList

FieldTypeRequiredDescription
as_ofstring | nullno
dataarray of objectno
data[].filingFilingRefno
data[].itemEightKItemno
data[].linksobjectno
data[].mismatch_kindstringno
has_morebooleanno
itemstringno
next_cursorstring | nullno
snapshotSnapshotno

Schema: Entity

Most recent as-filed attributes of a CIK, plus SEC's current entity record. When the snapshot store is unavailable and v3 has no filing for the CIK, nothing can be said about it: the body is then only {cik, data: null, snapshot}.

FieldTypeRequiredDescription
addressesAddressesno
as_ofobject | nullnoThe filing the as-filed attributes come from; null when v3 has no filing for the CIK.
as_of.accessionstringno
as_of.filing_datedate (YYYY-MM-DD)no
as_of.rolestringno
cikstringno
currentEntityCurrentno
datanullnoPresent (null) only in the {cik, data, snapshot} body described above.
filingsintegernoFilings in v3 that name the entity.
first_filing_datedate (YYYY-MM-DD) | nullno
fiscal_year_endstring | nullno
former_namesarray of objectno
irs_numberstring | nullno
last_filing_datedate (YYYY-MM-DD) | nullno
linksobjectno
links.filingsstringno
links.sec_filingsstringno
links.selfstringno
namestring | nullno
role_countsobjectno
rolesarray of stringno
sicstring | nullno
snapshotSnapshotno
spacSpacno
state_of_incstring | nullno

Schema: EntityCurrent

SEC's entity record from the submissions snapshot; null when the snapshot has no such CIK or is unavailable (see snapshot.available).

FieldTypeRequiredDescription
addressesAddressesno
categorystring | nullno
cikstringno
einstring | nullno
entity_typestring | nullno
exchangesarray of stringno
filingsintegernoFilings in SEC's list for the entity.
first_filing_datedate (YYYY-MM-DD) | nullno
fiscal_year_endstring | nullno
flagsstring | nullno
former_namesarray of objectno
last_filing_datedate (YYYY-MM-DD) | nullno
leistring | nullno
listedarray of objectnoThe entity's rows in SEC's ticker file: {ticker, exchange}.
listed_as_ofdate (YYYY-MM-DD) | nullno
namestringno
phonestring | nullno
sicstring | nullno
sic_descriptionstring | nullno
state_of_incstring | nullno
ticker_exchangesarray of objectno
tickersarray of stringno

Schema: EntityList

FieldTypeRequiredDescription
dataarray of EntityMatchyes
has_morebooleanno
next_cursorstring | nullno
snapshotSnapshotyesavailable is true when the snapshot was searched; false when the list is names as filed.

Schema: EntityMatch

FieldTypeRequiredDescription
cikstringno
filingsintegernoFilings in v3 that name the entity.
matchedstringnoWhat the query matched. Snapshot search results only. One of: cik, ticker, name, former_name.
namestring | nullnoSEC's current name (snapshot search) or the most recent name as filed.
sec_filingsintegernoFilings in SEC's list for the entity. Snapshot search results only.
tickersarray of stringnoSnapshot search results only.

Schema: Event

FieldTypeRequiredDescription
atdate-time (RFC 3339, UTC)no
detailsobjectno
eventstringno
seqintegerno
sourcestringno

Schema: EventList

FieldTypeRequiredDescription
dataarray of Eventyes
has_morebooleanno
next_cursorstring | nullno

Schema: Excluded

The deleted (SEC-withdrawn) filings this current or aggregate answer left out (owner ruling 2026-10-27: the remaining filings make the answer), at most 20, by accession; excluded_total counts them all. Empty when nothing was left out.

An object with no fixed fields.

Schema: Extraction

The parse state of the filing for one extractor (contract §1.3).

FieldTypeRequiredDescription
active_versionstringyesThe version the deployed parser runs.
datasetstringyes13f, 8k_items, sections.
extractorstringyes
first_parsed_atdate-time (RFC 3339, UTC) | nullno
methodstring | nullnoOne of: header, xml, xbrl, table, rule, null.
parsed_atdate-time (RFC 3339, UTC) | nullnoThe last write of the result.
reparseobject | nullyesA parse of the deployed version queued, running or given up while a result stands; null otherwise.
reparse.attemptsinteger | nullno
reparse.queued_atdate-time (RFC 3339, UTC) | nullno
reparse.statestringnoOne of: queued, running, failed.
reparse.versionstringno
rows_stalebooleannoA later parse could not read the filing and left the rows of an earlier good parse in place.
statusstringyesOne of: ok, ok_with_warnings, partial, unparseable, not_applicable, pending, failed, not_parsed.
versionstring | nullyesThe extractor version that last verified the filing; null without a result.
warningsarray of ParseWarningyesAt most 100, in order.
warnings_totalintegeryes
warnings_truncatedbooleanyes

Schema: F13fCover

Cover page as filed; contact fields limited to city, state or country and ZIP code; the signer without the phone.

FieldTypeRequiredDescription
amendment_nointeger | nullno
amendment_typestring | nullno
confidencenumber | nullnoRule confidence (not a probability).
is_amendmentbooleanno
manager_addressobject | nullno
manager_address.cityanyno
manager_address.state_or_countryanyno
manager_address.zip_codeanyno
manager_cikstringno
manager_namestring | nullno
perioddate (YYYY-MM-DD) | nullno
report_typestring | nullno
signatureobject | nullno
signature.cityanyno
signature.nameanyno
signature.signatureanyno
signature.signature_dateanyno
signature.state_or_countryanyno
signature.titleanyno

Schema: F13fEffectiveHoldingList

FieldTypeRequiredDescription
as_ofstring | nullno
confidential_omittedbooleanno
dataarray of F13fHolding + objectno
effectiveobjectno
effective.reported_13f_long_value_usdNullableDecimalno
effective.rowsinteger | nullno
excludedExcludednoview=effective only.
excluded_totalintegernoview=effective only.
has_morebooleanno
has_noticebooleanno
ledgerarray of LedgerStepno
limitsF13fLimitsno
manager_cikstringno
next_cursorstring | nullno
perioddate (YYYY-MM-DD)no
rebuild_pendingbooleannoA member filing was deleted since the group was built: its rows are not served and the total is null until the rebuild.
viewstringnoOne of: effective, as_filed.

Schema: F13fFiling

FieldTypeRequiredDescription
accessionstringno
coverF13fCoverno
extractionExtractionno
filingFilingRefno
ledgeranyno
linksobjectno
other_managersobjectno
other_managers.includedarray of F13fOtherManagerno
other_managers.reporting_for_filerarray of F13fOtherManagerno
snapshotSnapshotno
summaryF13fSummaryno
value_unitValueUnitno

Schema: F13fHolderList

FieldTypeRequiredDescription
as_ofstring | nullno
cusipstringno
dataarray of F13fHolding + objectno
excludedExcludedno
excluded_totalintegerno
has_morebooleanno
limitsF13fLimitsno
next_cursorstring | nullno
perioddate (YYYY-MM-DD)no

Schema: F13fHolding

One information-table row as filed; value_usd = value_reported x the unit decision's multiplier (null when the unit is ambiguous, untested with the flag unit_contradicted, or not decided).

FieldTypeRequiredDescription
accessionstringno
amount_typestring | nullno
confidencenumber | nullno
cusipstring | nullno
cusip_rawstring | nullno
cusip_statusstringno
flagsarray of stringno
name_of_issuerstring | nullno
observed_instringno
put_callstring | nullno
row_idstringno
row_nointegerno
shares_or_principalNullableDecimalno
title_of_classstring | nullno
value_rawstring | nullno
value_reportedNullableDecimalno
value_usdNullableDecimalno

Schema: F13fHoldingList

FieldTypeRequiredDescription
accessionstringno
dataarray of F13fHoldingno
extractionExtractionno
filingFilingRefno
has_morebooleanno
next_cursorstring | nullno
snapshotSnapshotno
value_unitValueUnitno

Schema: F13fLimits

What Form 13F does not report: filed up to 45 days after the quarter end; long positions only; Section 13(f) securities only; managers with over USD 100 million only; positions under confidential treatment can be omitted. Manager totals are reported 13F long values, never assets under management.

An object with no fixed fields.

Schema: F13fManagerPeriod

FieldTypeRequiredDescription
base_accessionstring | nullno
computed_atdate-time (RFC 3339, UTC) | nullno
confidential_omittedbooleanno
derive_versionstringno
flagsarray of stringno
has_noticebooleanno
latestobjectno
latest.accepted_atdate-time (RFC 3339, UTC) | nullno
latest.accepted_at_sourcestring | nullno
latest.accessionstringno
latest.filing_datedate (YYYY-MM-DD)no
linksobjectno
manager_cikstringno
perioddate (YYYY-MM-DD)no
rebuild_pendingbooleannoA member filing was deleted since the group was built: the total is null until the rebuild.
report_typestring | nullno
reported_13f_long_value_usdNullableDecimalno
rows_effectiveintegerno
stepsintegerno
unit_flagsarray of stringno

Schema: F13fManagerPeriodList

FieldTypeRequiredDescription
as_ofstring | nullno
dataarray of F13fManagerPeriodno
excludedExcludedno
excluded_totalintegerno
has_morebooleanno
limitsF13fLimitsno
manager_cikstringno
next_cursorstring | nullno

Schema: F13fOtherManager

FieldTypeRequiredDescription
cikstring | nullno
cik_rawstring | nullno
form13f_file_numberstring | nullno
namestring | nullno
row_nointegerno
sequence_numberinteger | nullno

Schema: F13fSummary

FieldTypeRequiredDescription
rows_parsedinteger | nullno
table_entry_totalinteger | nullno
table_value_totalNullableDecimalno
value_sum_reportedNullableDecimalno

Schema: F144Filing

FieldTypeRequiredDescription
accessionstringno
chainobject | nullno
extractionExtractionno
filingFilingRefno
header_entitiesarray of objectno
limitsarray of stringno
noticeF144Noticeno
snapshotSnapshotno

Schema: F144Notice

A Form 144 notice as filed. A notice is not a sale.

FieldTypeRequiredDescription
accessionstringno
acquisitionsarray of objectno
flagsarray of stringno
form_typestringno
issuerobjectno
nothing_sold_past_3_monthsboolean | nullno
notice_datestring | nullno
plan_adoption_datesarray of string | nullno
previous_accessionstring | nullno
sales_past_3_monthsarray of objectno
securitiesarray of objectno
sellerobjectno

Schema: FeedbackCreate

One feedback message to SEC Blast about the API, the MCP server or the data. Do not include personal data, API keys or other secrets.

FieldTypeRequiredDescription
categorystringyesbug: something failed or misbehaved; missing_data: SEC data expected but not there; missing_tool: no route or tool does what was needed; wrong_answer: a value or text is wrong; docs: a description or error message is unclear; other. One of: bug, missing_data, missing_tool, wrong_answer, docs, other.
clientobject | nullnoThe client program, e.g. the MCP client's name and version from its initialize request.
client.namestringyes
client.versionstring | nullno
contextobject | nullnoDetails such as accession, query and request_id: a JSON object of at most 16 KB as compact JSON.
messagestringyesWhat happened and what was expected: 1 to 4,000 characters after trimming, no NUL.
sourcestringnoWhere the feedback comes from; the MCP server sends mcp. One of: api, mcp.
toolstring | nullnoThe MCP tool or API route the feedback is about (at most 100 bytes).

Schema: FeedbackCreated

FieldTypeRequiredDescription
idinteger (int64)yesThe feedback's id.

Schema: Filing

FieldTypeRequiredDescription
accepted_atdate-time (RFC 3339, UTC) | nullnoThe acceptance time stored in v3. A time from the filing's own header (source realtime or archives_txt) always wins over SEC's; once stored a time does not move (a later SEC value goes to accepted_at_snapshot). Otherwise SEC's submissions value: for a filing new since the previous snapshot sync, SEC's value minus the New York UTC offset (SEC's values carry that offset), source submissions_corrected; for history, SEC's value as given, source submissions_unverified (it may carry 0, 1 or 2 such offsets). Null when no source has a time.
accepted_at_snapshotdate-time (RFC 3339, UTC)noPresent only when SEC's submissions value differs from accepted_at (at whole seconds): SEC's value as given.
accepted_at_sourcestring | nullnorealtime / archives_txt: from the filing's header (live ingest / SEC Archives). submissions_corrected, submissions_unverified: from SEC's submissions snapshot (see accepted_at). oldload and submissions are not written any more. One of: realtime, archives_txt, submissions_corrected, submissions_unverified, oldload, submissions, null.
accessionstringyes
base_formstringyes
deleted_atdate-time (RFC 3339, UTC) | nullnoWhen SEC deleted the filing: the TIMESTAMP of its DELETION notice (the notice's feed day at midnight New York time when it has none). Null unless status is deleted.
doc_countintegerno
feed_datedate (YYYY-MM-DD) | nullno
filing_datedate (YYYY-MM-DD)yes
first_seen_atdate-time (RFC 3339, UTC) | nullnoWhen v3 first saw the filing: for a live filing its entry in SEC's list of new filings; otherwise the moment v3 registered it, which for a backfilled filing is the day of the load, years after the filing. v3's time, never SEC's.
form_typestringyesForm type as filed.
header_in_filebooleannoSingle filing only. false: SEC's submission file of the filing has no SGML header (part of the 1994-1995 Archives files hold only their documents); its form type, filing date and filers are SEC's submissions index values, links.header is null and /header answers 404 with reason no_header_in_file.
is_amendmentbooleanyes
is_inline_xbrlboolean | nullnoSEC's isInlineXBRL; null as is_xbrl.
is_xbrlboolean | nullnoSEC's isXBRL; null when SEC does not say or the snapshot sync has not seen the filing.
itemsarray of stringno
items_unmappedarray of stringnoItem descriptions of the header that have no item code yet. In lists only when there are any; always on the single filing.
linksobjectyes
links.documentsstringno
links.eventsstringno
links.headerstring | nullnonull when header_in_file is false (single filing).
links.selfstringno
period_of_reportdate (YYYY-MM-DD) | nullnoSEC's reportDate (submissions snapshot) when it gives one, otherwise the value in the filing's header.
period_of_report_headerdate (YYYY-MM-DD) | nullnoSingle filing only, and only when SEC's reportDate replaced a different header period: the header's (null: the header has none).
period_of_report_sourcestring | nullnoOne of: submissions, header, null.
primary_cikstringyes
primary_namestring | nullnoName of the primary entity as filed (header_in_file false: the name SEC's submissions index gives for the filing date, or null).
provisionalbooleannostatus == provisional.
sec_itemsarray of string | nullnoSEC's 8-K items list (items is the header's); null when the snapshot sync has not seen the filing.
sec_primary_doc_descriptionstring | nullnoSingle filing only: SEC's primaryDocDescription.
sec_primary_documentstring | nullnoSEC's primaryDocument (file name).
sec_urlstring (URI)yes
snapshot_datedate (YYYY-MM-DD) | nullnoSingle filing only: the snapshot whose values were last written to the filing; null when none was.
sourcestringnorealtime: registered by live ingest; it becomes feed when the nightly feed delivers the filing. One of: feed, oldload, archives, realtime.
statusstringyesprovisional: registered by live ingest and not yet confirmed by the nightly feed, which makes it final (and may replace its documents). deleted: SEC deleted (withdrew) the filing; it is still served, with its documents when they were delivered (deleted_at, and the deletion block on the single filing). One of: provisional, final, deleted.
total_bytesintegerno

Schema: FilingDetail

FieldTypeRequiredDescription
accepted_atdate-time (RFC 3339, UTC) | nullnoThe acceptance time stored in v3. A time from the filing's own header (source realtime or archives_txt) always wins over SEC's; once stored a time does not move (a later SEC value goes to accepted_at_snapshot). Otherwise SEC's submissions value: for a filing new since the previous snapshot sync, SEC's value minus the New York UTC offset (SEC's values carry that offset), source submissions_corrected; for history, SEC's value as given, source submissions_unverified (it may carry 0, 1 or 2 such offsets). Null when no source has a time.
accepted_at_snapshotdate-time (RFC 3339, UTC)noPresent only when SEC's submissions value differs from accepted_at (at whole seconds): SEC's value as given.
accepted_at_sourcestring | nullnorealtime / archives_txt: from the filing's header (live ingest / SEC Archives). submissions_corrected, submissions_unverified: from SEC's submissions snapshot (see accepted_at). oldload and submissions are not written any more. One of: realtime, archives_txt, submissions_corrected, submissions_unverified, oldload, submissions, null.
accessionstringyes
base_formstringyes
deleted_atdate-time (RFC 3339, UTC) | nullno
doc_countintegerno
feed_datedate (YYYY-MM-DD) | nullno
filing_datedate (YYYY-MM-DD)yes
first_seen_atdate-time (RFC 3339, UTC) | nullno
form_typestringyesForm type as filed.
header_in_filebooleannoSingle filing only. false: SEC's submission file of the filing has no SGML header (part of the 1994-1995 Archives files hold only their documents); its form type, filing date and filers are SEC's submissions index values, links.header is null and /header answers 404 with reason no_header_in_file.
is_amendmentbooleanyes
is_inline_xbrlboolean | nullnoSEC's isInlineXBRL; null as is_xbrl.
is_xbrlboolean | nullnoSEC's isXBRL; null when SEC does not say or the snapshot sync has not seen the filing.
itemsarray of stringno
items_unmappedarray of stringno
linksobjectyes
links.documentsstringno
links.eventsstringno
links.headerstring | nullnonull when header_in_file is false (single filing).
links.selfstringno
period_of_reportdate (YYYY-MM-DD) | nullnoSEC's reportDate (submissions snapshot) when it gives one, otherwise the value in the filing's header.
period_of_report_headerdate (YYYY-MM-DD) | nullnoSingle filing only, and only when SEC's reportDate replaced a different header period: the header's (null: the header has none).
period_of_report_sourcestring | nullnoOne of: submissions, header, null.
primary_cikstringyes
primary_namestring | nullnoName of the primary entity as filed (header_in_file false: the name SEC's submissions index gives for the filing date, or null).
provisionalbooleannostatus == provisional.
sec_itemsarray of string | nullnoSEC's 8-K items list (items is the header's); null when the snapshot sync has not seen the filing.
sec_primary_doc_descriptionstring | nullnoSingle filing only: SEC's primaryDocDescription.
sec_primary_documentstring | nullnoSEC's primaryDocument (file name).
sec_urlstring (URI)yes
snapshot_datedate (YYYY-MM-DD) | nullnoSingle filing only: the snapshot whose values were last written to the filing; null when none was.
sourcestringnorealtime: registered by live ingest; it becomes feed when the nightly feed delivers the filing. One of: feed, oldload, archives, realtime.
statusstringyesprovisional: registered by live ingest and not yet confirmed by the nightly feed, which makes it final (and may replace its documents). deleted: SEC deleted (withdrew) the filing; it is still served, with its documents when they were delivered (deleted_at, and the deletion block on the single filing). One of: provisional, final, deleted.
total_bytesintegerno
date_of_changedate (YYYY-MM-DD) | nullno
deletedbooleannostatus == deleted.
deletionobject | nullnoOnly for a deleted filing (null otherwise): where the deletion came from. SEC's DELETION notice gives no reason.
deletion.feed_datedate (YYYY-MM-DD) | nullnoThe feed day whose archive held the notice.
deletion.noticestring | nullnoThe notice member, <archive>#<member>.
deletion.recorded_atdate-time (RFC 3339, UTC) | nullnoWhen v3 registered the deletion.
deletion.sourcestring | nullnoWhere the deletion notice came from, as the filing's events say it: feed (SEC's nightly feed, which carries the notices) for every deletion today.
documentsarray of Documentno
effectiveness_datedate (YYYY-MM-DD) | nullno
entitiesarray of FilingEntityno
eventsarray of Eventno
finalized_atdate-time (RFC 3339, UTC) | nullno
is_correctionbooleanno
is_paperbooleanno
is_private_releasebooleanno
liveobjectnoOnly while the filing is provisional and its source is realtime: where live ingest is with it. Gone once the filing is final.
live.documents_atdate-time (RFC 3339, UTC) | nullnoWhen its documents were registered; null until then.
live.listed_atdate-time (RFC 3339, UTC) | nullnoWhen the filing was listed.
live.statestringnolisted: the header is registered (entities, items, acceptance time, /header); doc_count is 0 and the documents are still being fetched. complete: the documents are registered. documents_failed: they could not be fetched; the nightly feed will supply them. One of: listed, complete, documents_failed.
previous_accessionstring | nullno
released_atdate-time (RFC 3339, UTC) | nullno
snapshotSnapshotno
versionsVersionsno

Schema: FilingEntity

FieldTypeRequiredDescription
addressesAddressesno
cikstringno
file_numberstring | nullno
film_numberstring | nullno
fiscal_year_endstring | nullno
namestring | nullno
rolestringnoOne of: filer, subject, filed_by, filed_for, reporting_owner, issuer, depositor, securitizer, issuing_entity, underwriter, serial_company.
sicstring | nullno
state_of_incstring | nullno

Schema: FilingList

FieldTypeRequiredDescription
dataarray of Filingyes
has_morebooleanyesTrue when another page follows (pages are complete for every sort).
next_cursorstring | nullyes
snapshotSnapshotyes

Schema: FilingRef

The filing a parsed result belongs to: a strict subset of Filing (same names, types and values).

FieldTypeRequiredDescription
accepted_atdate-time (RFC 3339, UTC) | nullnoThe acceptance time stored in v3. A time from the filing's own header (source realtime or archives_txt) always wins over SEC's; once stored a time does not move (a later SEC value goes to accepted_at_snapshot). Otherwise SEC's submissions value: for a filing new since the previous snapshot sync, SEC's value minus the New York UTC offset (SEC's values carry that offset), source submissions_corrected; for history, SEC's value as given, source submissions_unverified (it may carry 0, 1 or 2 such offsets). Null when no source has a time.
accepted_at_sourcestring | nullnorealtime / archives_txt: from the filing's header (live ingest / SEC Archives). submissions_corrected, submissions_unverified: from SEC's submissions snapshot (see accepted_at). oldload and submissions are not written any more. One of: realtime, archives_txt, submissions_corrected, submissions_unverified, oldload, submissions, null.
accessionstringno
base_formstringno
deletedbooleannostatus == deleted.
deleted_atdate-time (RFC 3339, UTC) | nullnoWhen SEC deleted the filing: the TIMESTAMP of its DELETION notice (the notice's feed day at midnight New York time when it has none). Null unless status is deleted.
deletionobject | nullnoPer-filing routes only (absent in lists): Only for a deleted filing (null otherwise): where the deletion came from. SEC's DELETION notice gives no reason.
deletion.feed_datedate (YYYY-MM-DD) | nullnoThe feed day whose archive held the notice.
deletion.noticestring | nullnoThe notice member, <archive>#<member>.
deletion.recorded_atdate-time (RFC 3339, UTC) | nullnoWhen v3 registered the deletion.
deletion.sourcestring | nullnoWhere the deletion notice came from, as the filing's events say it: feed (SEC's nightly feed, which carries the notices) for every deletion today.
filing_datedate (YYYY-MM-DD)no
form_typestringnoForm type as filed.
linksobjectno
links.selfstringno
period_of_reportdate (YYYY-MM-DD) | nullnoSEC's reportDate (submissions snapshot) when it gives one, otherwise the value in the filing's header.
period_of_report_sourcestring | nullnoOne of: submissions, header, null.
primary_cikstringno
primary_namestring | nullnoName of the primary entity as filed (header_in_file false: the name SEC's submissions index gives for the filing date, or null).
provisionalbooleannostatus == provisional.
statusstringnoprovisional: registered by live ingest and not yet confirmed by the nightly feed, which makes it final (and may replace its documents). deleted: SEC deleted (withdrew) the filing; it is still served, with its documents when they were delivered (deleted_at, and the deletion block on the single filing). One of: provisional, final, deleted.

Schema: FormCount

FieldTypeRequiredDescription
base_formstringno
countintegerno
form_typestringno
is_amendmentbooleanno

Schema: FormDFiling

FieldTypeRequiredDescription
accessionstringyes
chainobject | nullyesThe offering chain: chain_id, members [{accession, chain_seq, link_method root | previous_accession | issuer_file_number, form_type, filing_date, accepted_at, flags, filing_status}], effective_accession (the latest member: its rows are the offering), steps, flags, derive_version, computed_at.
extractionobjectyes
filingobjectyes
header_entitiesarray of objectyes
issuersarray of objectyes
offeringanyyes
recipientsarray of objectyes
related_personsarray of objectyes
snapshotobjectyes

Schema: FormDOffering

One Form D notice as filed (v3_formd_offerings): form_type (D | D/A, from the filing), submission_type_xml, schema_version, is_amendment (from the form type; is_amendment_xml as filed), previous_accession, industry_group_type, investment_fund_type, is_40_act, revenue_range and nav_range (filed text, e.g. Decline to Disclose), federal_exemptions, date_of_first_sale (+_raw), first_sale_yet_to_occur, more_than_one_year, types_of_securities (as filed), minimum_investment, the three amounts total_offering_amount, total_amount_sold, total_remaining (whole dollars or null, each with _raw and _indefinite: Indefinite is a filed value, never a number), investors, commissions, finders' fees, proceeds to related persons (each with _raw and estimate flags), signature_block, n_issuers, n_related_persons, n_recipients, flags (amount_indefinite, amounts_do_not_add, remaining_inconsistent, amendment_flag_mismatch, previous_accession_missing, first_sale_yet_to_occur, size_declined).

An object with no fixed fields.

Schema: FormDOfferings

FieldTypeRequiredDescription
as_ofstring | nullyes
cikstring | nullyes
dataarray of objectyes
excludedExcludedno
excluded_totalintegerno
has_morebooleanyes
next_cursorstring | nullyes
viewstringyesOne of: as_filed, effective.

Schema: FormList

FieldTypeRequiredDescription
computed_atdate-time (RFC 3339, UTC)noWhen the list was computed, UTC. It is served until a later computation replaces it.
dataarray of FormCountyes
has_morebooleanno
next_cursorstring | nullno

Schema: Health

FieldTypeRequiredDescription
checksobjectyes
checks.callbacksstringnoWebhook delivery, judged per organization: the lateness of the least late organization among those with a first attempt due or one made in the last minute (one organization's own backlog does not count while others are served on time). ok: at most 60 s past due. degraded: up to 5 minutes. down: more, or the delivery table cannot be read (also while the database is down). degraded and down make the status degraded at any hour, never an outage. disabled: this deployment has no webhook delivery. One of: ok, degraded, down, disabled.
checks.dbstringnoOne of: ok, fail.
checks.docs_rootstringnoOne of: ok, missing.
checks.livestringnoLive ingest (the daemon that registers filings seconds after SEC accepts them). ok: its heartbeat is at most 45 s old and it is polling, idle outside the window, or catching up. paused: SEC refused a request; nothing is sent until live.paused_until, and the 30 careful minutes after. degraded: SEC unreachable, database down, disk low, or halted after repeated pauses. down: no heartbeat (not running, stopping, or its status could not be read). disabled: this deployment has no live ingest. One of: ok, paused, degraded, down, disabled.
checks.mcpstringnoThe MCP server sb_mcp_v3 (its /healthz, probed at most every 5 s). disabled: this deployment does not name one. Informational: it never changes status. One of: ok, down, disabled.
checks.storestringnoThe snapshot store. stale: its snapshot is more than 3 days old (still used). loading: no snapshot served yet. disabled: not configured. One of: ok, stale, loading, unavailable, disabled.
checks.streamstringnoThe filing stream (the sequencer that writes the log behind /v3/stream). ok: it wrote its cursor at most 30 s ago. stale: the cursor is older, or there is none; the status is then degraded, never an outage. stale also when the database cannot be read. disabled: this deployment has no stream. One of: ok, stale, disabled.
liveobjectnoPresent only when live ingest is enabled. Counts and the full heartbeat are on /v3/coverage, which needs a key.
live.lag_secondsinteger | nullnoMedian seconds from SEC's acceptance to the filing being seen, over the last 15 minutes; null with fewer than 5 filings, and when the figure is negative or absurd.
live.last_new_filing_atdate-time (RFC 3339, UTC) | nullnoWhen the newest filing was first seen.
live.last_poll_atdate-time (RFC 3339, UTC) | nullnoThe last successful poll of SEC's list of new filings.
live.paused_untildate-time (RFC 3339, UTC) | nullnoEnd of a pause in force; null otherwise.
live.statestring | nullnoThe daemon's own state in its last heartbeat (ok, idle, catching_up, paused, cautious, sec_unreachable, db_down, disk_low, halted, stopping, stopped, failed), or dry_run when the daemon that answers is a dry run (it registers no filings; checks.live is then never ok); null without a heartbeat or when it is none of these. It is the daemon's last word, so a daemon that died still shows its last state: checks.live is the judgement, which also knows how old the heartbeat is and whether the session ended.
meteringobjectnoOnly when the API runs with a metering switches file (one in force, or one that was refused): the mode of each feature; config (ok | refused: the file cannot be read or is invalid, and the previous switches, or all off, stay), config_error and config_last_good (when a valid file was last taken); the usage flusher (last success, pending records, failures, events written and dropped, whether the month was read back); the age of the cached entitlements; entitlements_statement (unchecked | ok | insufficient_privilege | failed: whether this role can run the entitlements statement, which reads v3_acct_entitlements and v3_usage_rollup_state; updated by every entitlements read, and checked actively while a feature is enforced) and entitlements_error; limits_unknown (requests served without limits because their org's limits could not be read); and the refusal counters. It makes status degraded, never an outage, while the file is refused, or while a feature is enforced and entitlements_statement is insufficient_privilege.
statusstringyesdegraded unless every check is ok and the metering block (when present) is not degraded (a store that is not configured does not degrade; live ingest counts only when it is enabled, and only on a weekday between 06:00 and 22:00 New York time, when SEC accepts filings; the filing stream and webhook delivery count only when enabled, at any hour). The HTTP status is 503 only when the database is down. One of: ok, degraded.
storeobjectnoThe snapshot in use. Counts and load details are on /v3/coverage, which needs a key.
store.availablebooleanno
store.snapshot_datedate (YYYY-MM-DD) | nullno
store.staleboolean | nullno
timedate-time (RFC 3339, UTC)no
versionstringno

Schema: InsiderFootnoteRef

FieldTypeRequiredDescription
fieldstring | nullnoThe column the footnote is on; null when it is on a group of fields (transaction coding).
footnote_idstring | nullno
ref_seqintegerno
target_pathstring | nullno
textstring | nullno

Schema: InsiderRow

One row of Table I or II of a Form 3/4/5 as filed. Every amount is a Decimal beside its filed text (_raw). A price given only in a footnote is null with the flag price_in_footnote, never 0.

FieldTypeRequiredDescription
accessionstringno
acquired_disposedstring | nullno
confidencenumber | nullno
conversion_or_exercise_priceNullableDecimalno
deemed_execution_datestring | nullno
equity_swapboolean | nullno
exercise_datestring | nullno
expiration_datestring | nullno
extracted_atstringno
extractor_versionstringno
flagsarray of stringno
footnotesarray of InsiderFootnoteRefno
ownership_formstring | nullno
ownership_naturestring | nullno
priceNullableDecimalno
price_rawstring | nullno
row_idstringno
row_nointegerno
security_titlestring | nullno
sharesNullableDecimalno
shares_afterNullableDecimalno
shares_rawstring | nullno
tablestringnoOne of: non_derivative_transaction, non_derivative_holding, derivative_transaction, derivative_holding.
table_codestringnoOne of: NT, NH, DT, DH.
timelinessstring | nullno
total_valueNullableDecimalno
transaction_codestring | nullno
transaction_datestring | nullno
transaction_date_rawstring | nullno
transaction_form_typestring | nullno
underlying_sharesNullableDecimalno
underlying_titlestring | nullno
underlying_valueNullableDecimalno
value_afterNullableDecimalno

Schema: InsiderRowList

FieldTypeRequiredDescription
as_ofstring | nullno
dataarray of InsiderRow + objectno
excludedExcludednoview=effective only.
excluded_totalintegernoview=effective only.
has_morebooleanno
next_cursorstring | nullno
provisionalbooleannoTrue for view=effective: the row-level amendment view is provisional.
viewstringnoOne of: as_filed, effective.

Schema: LedgerStep

FieldTypeRequiredDescription
accepted_atdate-time (RFC 3339, UTC) | nullno
accepted_at_sourcestring | nullno
accessionstringno
applied_actionstringnoOne of: base, replace, add, notice, ignored_duplicate, no_table.
applied_rulestringno
computed_atdate-time (RFC 3339, UTC) | nullno
declared_typestring | nullno
derive_versionstringno
filing_datedate (YYYY-MM-DD)no
flagsarray of stringno
manager_cikstringno
perioddate (YYYY-MM-DD)no
rows_afterinteger | nullno
rows_beforeinteger | nullno
stepintegerno
value_usd_afterNullableDecimalno
value_usd_beforeNullableDecimalno

Schema: NportFiling

FieldTypeRequiredDescription
accessionstringyes
extractionobjectyes
filingobjectyes
has_morebooleanyes
holdingsarray of NportHoldingyes
ledgerobject | nullyesseries_id, report_date, step, applied_action base | replace | ignored_duplicate, applied_rule, flags, effective_accession, steps, is_effective.
limitsarray of stringyes
next_cursorstring | nullyes
reportanyyes

Schema: NportFundHoldings

FieldTypeRequiredDescription
dataarray of objectyes
has_morebooleanyes
id_typestringyes
id_valuestringyes
limitsarray of stringyes
next_cursorstring | nullyes
viewstringyesOne of: effective, as_filed.

Schema: NportHolding

One investment (v3_nport_holdings): row_no, name, lei, title, cusip_raw (as filed), cusip (null unless nine characters; a placeholder is never a CUSIP), cusip_status, identifiers [{type isin | ticker | other, value, other_desc}], balance, units, currency, exchange_rate, value_usd, pct_of_nav (Decimals with _raw), payoff_profile, asset_category, issuer_category (from the conditional element when the code is other, with its _desc), country, is_restricted, fair_value_level, debt_sec, repo_agreement, derivative_info, security_lending (as filed), flags.

An object with no fixed fields.

Schema: NportReport

One N-PORT filing as filed (v3_nport_filings): form_type, amended_accession, registrant {name, file_number, cik, lei, address, phone}, series_id, series_name, series_lei, class_ids, report_date, fiscal_year_end, is_final_filing, total_assets, total_liabilities, net_assets (Decimal strings, each with _raw), monthly [{month 1..3, sales, reinvestment, redemption, other_net_realized_gain, other_net_unrealized_appreciation}], returns [{class_id, rtn1, rtn2, rtn3 (+_raw)}], rows_parsed, flags.

An object with no fixed fields.

Schema: NportSeriesReports

FieldTypeRequiredDescription
dataarray of NportReportyes
has_morebooleanyes
next_cursorstring | nullyes
series_idstringyes
viewstringyesOne of: effective, as_filed.

Schema: NullableDecimal

An object with no fixed fields.

Schema: OpenApi

This document.

An object with no fixed fields.

Schema: OwnershipFiling

FieldTypeRequiredDescription
accessionstringno
amendment_chainobject | nullnoProvisional: the original with the amendments that name it, the steps, how each amendment was linked and its row links.
documentobject | nullno
extractionExtractionno
filingFilingRefno
footnotesarray of objectno
header_entitiesarray of objectnoThe SEC header's entities with every field, addresses and phone numbers included.
issuerobject | nullno
linksobjectno
other_footnote_referencesarray of objectno
ownersarray of objectnoEvery reporting owner, document order, with the whole address and relationship.
signaturesarray of objectno
snapshotSnapshotno
tablesobjectno
tables.derivative_holdingsarray of InsiderRowno
tables.derivative_transactionsarray of InsiderRowno
tables.non_derivative_holdingsarray of InsiderRowno
tables.non_derivative_transactionsarray of InsiderRowno

Schema: ParseWarning

FieldTypeRequiredDescription
codestringno
detailstring | nullnoText the extractor wrote.
pathstring | nullno
row_kindstring | nullno
row_nointeger | nullno
severitystringnoOne of: info, warning, error.
tablestring | nullno

Schema: ParsedChange

FieldTypeRequiredDescription
atdate-time (RFC 3339, UTC)yesWhen the old version was replaced (unit_decision: when it was decided).
extractorstring | nullnosuperseded only.
from_versionstring | nullno
group_keystring | nullnoreplaced: the group (e.g. <manager_cik>|<period>, <accession>|<extractor>).
idintegeryesThe row's id in its source (v3_parse_superseded, v3_derived_history, v3_13f_unit_decisions).
kindstringyesOne of: superseded, replaced, unit_decision.
oldanyyessuperseded: the old row (object); replaced: the old rows (array); unit_decision: the decision. Numbers are strings holding the stored value.
reasonstringyessuperseded: changed, removed, withdrawn; replaced: rebuilt, recomputed, reparsed, withdrawn; unit_decision: decided, redecided, revised, withdrawn.
row_keyobject | nullnosuperseded: the row's key columns, type-tagged as in the parse envelope ({"row_no":{"int":"3"}}).
tablestringyes
to_versionstring | nullnounit_decision: the derive version that decided.

Schema: ParsedChanges

FieldTypeRequiredDescription
accessionstringyes
dataarray of ParsedChangeyes
filingFilingRefyes
has_morebooleanyes
next_cursorstring | nullyes

Schema: ParsedItem

FieldTypeRequiredDescription
active_versionstringyesThe version the deployed parser runs.
datasetstringyes13f, 8k_items, sections.
extractorstringyes
first_parsed_atdate-time (RFC 3339, UTC) | nullno
methodstring | nullnoOne of: header, xml, xbrl, table, rule, null.
parsed_atdate-time (RFC 3339, UTC) | nullnoThe last write of the result.
reparseobject | nullyesA parse of the deployed version queued, running or given up while a result stands; null otherwise.
reparse.attemptsinteger | nullno
reparse.queued_atdate-time (RFC 3339, UTC) | nullno
reparse.statestringnoOne of: queued, running, failed.
reparse.versionstringno
rows_stalebooleannoA later parse could not read the filing and left the rows of an earlier good parse in place.
statusstringyesOne of: ok, ok_with_warnings, partial, unparseable, not_applicable, pending, failed, not_parsed.
versionstring | nullyesThe extractor version that last verified the filing; null without a result.
warningsarray of ParseWarningyesAt most 100, in order.
warnings_totalintegeryes
warnings_truncatedbooleanyes
derivedarray of objectyesThe dataset's derive steps for this filing (13F: units, ledger); version and computed_at null until the step has run for it.
derived[].computed_atdate-time (RFC 3339, UTC) | nullno
derived[].stepstringno
derived[].versionstring | nullno
inputsarray of objectyesThe documents the last parse read.
inputs[].filenamestring | nullno
inputs[].seqinteger | nullno
inputs[].sha256string | nullno
inputs[].typestring | nullno
linksobjectyes
links.datastring | nullnoThe dataset's route for this filing; null while this server does not answer it.
rows_totalintegeryes

Schema: ParsedList

FieldTypeRequiredDescription
accessionstringyes
dataarray of ParsedItemyesOne per extractor that covers the filing's form type; empty when none does.
filingFilingRefyes
has_morebooleanyes
next_cursorstring | nullyes
snapshotSnapshotyes

Schema: Problem

RFC 9457 problem details.

FieldTypeRequiredDescription
codestringyesOne of: invalid_parameter, unknown_parameter, unauthorized, invalid_token, forbidden, not_found, gone, method_not_allowed, rate_limited, timeout, internal, db_unavailable, range_not_satisfiable, request_too_large, warming_up, invalid_query, query_too_complex, prefix_too_broad, negative_only_query, unsupported_operator, invalid_cursor, search_timeout, search_busy, search_unavailable, ticker_resolution_unavailable, no_text, not_covered, conversion_timeout, document_too_large, unsupported_media_type, invalid_body, callbacks_unavailable, plan_required, limit_reached, conflict, quota_exceeded, blocked, invalid_state, replay_running, test_running, endpoint_unverified, endpoint_disabled.
detailstringyes
lengthintegernoSearch query errors: length in characters of the offending part of q.
parameterstringnoThe offending parameter, for 400 responses.
positionintegernoSearch query errors: character offset in q.
request_idstringyes
statusintegeryes
titlestringyes
typestring (URI)yes

Schema: ProposedSaleList

FieldTypeRequiredDescription
as_ofstring | nullno
dataarray of F144Notice + objectno
excludedExcludednoview=effective only.
excluded_totalintegernoview=effective only.
has_morebooleanno
limitsarray of stringno
next_cursorstring | nullno
provisionalbooleanno
viewstringnoOne of: as_filed, effective.

Schema: Report

FieldTypeRequiredDescription
amendedbooleannoTrue when any live member is an amendment.
base_formstringnoBase form of the chain's head.
cikstringno
first_filing_datedate (YYYY-MM-DD) | nullnoFiling date of the chain's head (the original, or the first ingested amendment when the original is absent).
head_is_amendmentbooleannoThe chain's first listed filing is an amendment: its original is not ingested, or it is unlinked, unresolved or ambiguous.
latestobjectno
latest.accepted_atdate-time (RFC 3339, UTC) | nullnoAs a filing's accepted_at.
latest.accepted_at_snapshotdate-time (RFC 3339, UTC)noAs on a filing: only when SEC's value differs from accepted_at.
latest.accepted_at_sourcestring | nullno
latest.accessionstringno
latest.filing_datedate (YYYY-MM-DD) | nullno
latest.form_typestring | nullno
link_statusstring | nullnoLink status of the head when it is an amendment.
linksobjectno
links.lateststringno
links.versionsstringno
original_ingestedbooleannoTrue only when the head is an ingested original (not an amendment).
period_of_reportdate (YYYY-MM-DD) | nullnoPeriod of the chain's head: SEC's reportDate when it gives one, otherwise its header's. The period filter compares this value.
period_of_report_sourcestring | nullnoOne of: submissions, header, null.
report_keystringno
versionsintegernoLive (not deleted) ingested members; /versions count also includes deleted and not-ingested items.

Schema: ReportList

FieldTypeRequiredDescription
dataarray of Reportyes
has_morebooleanyes
next_cursorstring | nullyes
snapshotSnapshotyes

Schema: ResolveMatch

FieldTypeRequiredDescription
cikstringno
exchangestring | nullno
linksobjectno
links.entitystringno
links.filingsstringno
namestring | nullno
tickerstringno

Schema: ResolveResult

FieldTypeRequiredDescription
as_ofdate (YYYY-MM-DD) | nullno
coverage_fromdate (YYYY-MM-DD) | nullnoThe oldest copy kept; earlier dates cannot be resolved.
dataarray of ResolveMatchyes
file_datedate (YYYY-MM-DD) | nullnoThe daily copy of SEC's ticker file that answered.
has_morebooleanno
next_cursorstring | nullno
snapshotSnapshotyesavailable is false when the store could not be asked, or had neither a ticker file nor a snapshot to consult: empty data then means unknown, not that no entity holds the ticker.
sourcestring | nullnoOne of: sec_company_tickers, submissions, null.
tickerstringyes

Schema: SearchDocument

A matching document (members as trimmed by fields).

FieldTypeRequiredDescription
descriptionstring | nullno
doc_classstring | nullno
doc_idstringno
doc_typestring | nullno
filenamestring | nullno
is_primaryboolean | nullno
scorenumberno
seqintegerno
snippetsarray of SearchSnippetno
urlstringno/v3/filings/{accession}/documents/{seq}

Schema: SearchFacetBucket

FieldTypeRequiredDescription
countintegerno
valueanynoAn integer for the year facet, a string for form, sic and state.

Schema: SearchFacets

Only the facets named in facets=. Counts are in the result unit (documents for group=document, filings for group=filing); a hit counts once under each of its values. At most facet_size buckets each, largest first.

FieldTypeRequiredDescription
formarray of SearchFacetBucketno
sicarray of SearchFacetBucketno
statearray of SearchFacetBucketno
yeararray of SearchFacetBucketnoFiling year; value is an integer.

Schema: SearchHit

group=document: one document with its filing members; group=filing: one filing with documents_matched, documents and collapsed. Members as trimmed by fields.

FieldTypeRequiredDescription
accepted_atdate-time (RFC 3339, UTC) | nullno
accepted_at_sourcestring | nullno
accessionstringno
collapsedobject | nullnoOnly with collapse=true: null, or {cluster_id, matched} for the best member of a template cluster standing for matched results.
descriptionstring | nullno
doc_classstring | nullno
doc_idstringno
doc_typestring | nullno
documentsarray of SearchDocumentno
documents_matchedintegerno
entitiesarray of objectno
filenamestring | nullno
filing_datedate (YYYY-MM-DD) | nullno
form_typestring | nullno
is_primaryboolean | nullno
provisionalbooleanno
scorenumberno
seqintegerno
snippetsarray of SearchSnippetno
statusstringnoThe filing's status as indexed: filings SEC deleted are searchable; status= narrows. One of: provisional, final, deleted.
urlstringno

Schema: SearchIndexInfo

The index that answered.

FieldTypeRequiredDescription
extractorstring | nullnoText extractor of the newest searched year; snippet offsets count characters of that extractor's text.
index_versionstring | nullnoBuild id of the newest searched year.
indexed_throughdate-time (RFC 3339, UTC) | nullnoAcceptance-time horizon of the live indexer.
ranking_versionintegerno
years_missingarray of integernoYears that cannot be searched now.

Schema: SearchParse

How a query is read; nothing is executed.

FieldTypeRequiredDescription
astobject | nullnoThe query tree under the requested syntax: sexpr and tree.
differsbooleannoThe two readings differ.
edgarobjectnoThe EDGAR reading: ast, echo (the query EDGAR would build) and error when it does not parse.
filtersobjectnoThe structured filters after alias mapping and ticker resolution.
matchstringnoOne of: exact, stem.
normalizedstringnoThe normalised query.
prefixesarray of objectno
prefixes[].cappedbooleanno
prefixes[].expansionsintegerno
prefixes[].in_spanbooleannoInside NEAR or a phrase (capped at 1,024 expansions).
prefixes[].prefixstringno
prefixes[].toparray of array of anynoUp to 20 [term, document frequency] pairs.
resolvedobjectno{tickers: {TICKER: [cik, ...]}}.
shardsarray of integernoThe index years the query would search.
syntaxstringnoOne of: sb, edgar.
warningsarray of SearchWarningno

Schema: SearchResults

FieldTypeRequiredDescription
dataarray of SearchHityes
facetsSearchFacetsno
has_morebooleanyes
indexSearchIndexInfoyes
next_cursorstring | nullyesPass back as cursor with the same query, filters, sort and group. Null when nothing follows, and always null with from > 0.
resolvedobjectyes{tickers: {TICKER: [cik, ...]}}: how tickers were resolved.
resolved.tickersobjectno
took_msintegeryes
totalSearchTotalsyes
warningsarray of SearchWarningyes

Schema: SearchSnippet

FieldTypeRequiredDescription
endintegernoCode-point offset of the end of the snippet (exclusive), as start.
highlightsarray of array of integerno[start, end) character offsets in text of the matched words.
startintegernoCode-point offset of the snippet in the text that /v3/filings/{accession}/documents/{document}/text returns, under the same extractor (see index.extractor); offsets can move when the extractor changes.
textstringnoPlain text, never HTML.

Schema: SearchStatus

Per year: document and filing counts, index_version, extractor, built at; the live indexer's lag and freshness; indexed_through; the years being rebuilt. Exactly these members.

FieldTypeRequiredDescription
damaged_yearsarray of integer | nullyesYears found damaged and dropped from the index until they are rebuilt; searches answer from the other years.
freshnessobject | nullyesSeconds from a filing's acceptance to its first searchable commit, over the last 15 minutes; null without a live indexer.
freshness.p50_snumber | nullno
freshness.p95_snumber | nullno
freshness.windowstring | nullno"15m".
indexed_throughdate-time (RFC 3339, UTC) | nullyesThe newest event time the live index has applied.
indexerobject | nullyes
indexer.indexed_throughdate-time (RFC 3339, UTC) | nullno
indexer.lag_eventsinteger | nullno
indexer.lag_secondsnumber | nullno
indexer_staleboolean | nullyesTrue when the live indexer has not updated its status for over 120 seconds, or reports none; null when the index service does not say.
lag_secondsnumber | nullyesHow far the live indexer is behind (0 when caught up).
partial_yearsarray of integer | nullyesYears the live indexer started (the current or next year) that no full build has replaced yet: searchable, but they hold only the filings indexed live since; state is degraded while any exist.
rebuildingarray of integer | nullyesYears being rebuilt.
statestring | nullyes
tickersobject | nullyes
tickers.file_datedate (YYYY-MM-DD) | nullno
yearsarray of objectyes
years[].built_atstring | nullno
years[].documentsinteger | nullno
years[].extractorstring | nullno
years[].filingsinteger | nullno
years[].index_versionstring | nullno
years[].yearintegerno
years_missingarray of integer | nullyesYears not searchable now: listed years that cannot be opened, and damaged_years.

Schema: SearchSubscription

A saved search of the caller's organization that delivers to one of its callback endpoints.

FieldTypeRequiredDescription
activebooleanyes
created_atdate-time (RFC 3339, UTC)yes
endpoint_idstringyescbe_ and 24 hex digits.
idstringyessub_ and 24 hex digits.
include_correctionsbooleanyes
kindstringyesFrom the query: search when q is not empty, or doctypes, primary_only=true or entityName is given; else filing when a filing-level filter is given (forms, form_types, form_families and their exclusions, ciks, tickers, sics, states, inc_states, locationCode, items); else firehose. filing and firehose deliver filing.new, search delivers search.match. A filing subscription counts against limits.filter. Text subscriptions (kind search) are not offered: a create or PATCH whose query has q, doctypes, primary_only=true or entityName is a 400 invalid_parameter naming that parameter. One of: filing, firehose, search.
min_interval_sinteger | nullyesDigest interval; null: every event is delivered alone.
namestringyes
queryobjectyesAs stored: q, syntax, match and the structured filters as /v3/search/parse normalises them, tickers resolved into ciks at save time (no tickers member), items as given, accepted_from and accepted_to always null.
query.filtersobjectyes
query.matchstringyesOne of: exact, stem.
query.qstringyes
query.syntaxstringyesOne of: sb, edgar.
updated_atdate-time (RFC 3339, UTC)yes

Schema: SearchSubscriptionCreate

FieldTypeRequiredDescription
endpoint_idstringyesOne of the organization's endpoints; it must list filing.new (filing, firehose) or search.match (search).
include_correctionsbooleanno
min_interval_sinteger | nullno
namestringyes1 to 800 bytes.
queryobjectyesThe query and filter parameters of /v3/search (q, syntax, match, forms, form_types, form_families, doctypes, ciks, tickers, sics, states, inc_states, primary_only, entityName, locationCode, ...) as JSON members (a list as a comma string or an array), plus items (8-K item codes). A filing-date window (filed_from, filed_to, startdt, enddt, or a dateRange preset) is a 400 naming it, and so is status (a subscription receives new filings); an acceptance window is not stored. An unknown ticker is a 400 naming tickers (q for a ticker: term in q).

Schema: SearchSubscriptionCreated

FieldTypeRequiredDescription
activebooleanyes
created_atdate-time (RFC 3339, UTC)yes
endpoint_idstringyescbe_ and 24 hex digits.
idstringyessub_ and 24 hex digits.
include_correctionsbooleanyes
kindstringyesFrom the query: search when q is not empty, or doctypes, primary_only=true or entityName is given; else filing when a filing-level filter is given (forms, form_types, form_families and their exclusions, ciks, tickers, sics, states, inc_states, locationCode, items); else firehose. filing and firehose deliver filing.new, search delivers search.match. A filing subscription counts against limits.filter. Text subscriptions (kind search) are not offered: a create or PATCH whose query has q, doctypes, primary_only=true or entityName is a 400 invalid_parameter naming that parameter. One of: filing, firehose, search.
min_interval_sinteger | nullyesDigest interval; null: every event is delivered alone.
namestringyes
queryobjectyesAs stored: q, syntax, match and the structured filters as /v3/search/parse normalises them, tickers resolved into ciks at save time (no tickers member), items as given, accepted_from and accepted_to always null.
query.filtersobjectyes
query.matchstringyesOne of: exact, stem.
query.qstringyes
query.syntaxstringyesOne of: sb, edgar.
updated_atdate-time (RFC 3339, UTC)yes
resolvedobjectyesThe tickers of the query and the CIKs they were resolved to at save time; in the answers of POST and of a PATCH with a query.
resolved.tickersobjectno

Schema: SearchSubscriptionList

FieldTypeRequiredDescription
dataarray of SearchSubscriptionyes
has_morebooleanyes
limitsobjectyesBy kind: filter (stored kind filing), firehose, search. limit: the plan's (0 without); used: active subscriptions of that kind.
limits.filterobjectno
limits.filter.limitintegerno
limits.filter.usedintegerno
limits.firehoseobjectno
limits.firehose.limitintegerno
limits.firehose.usedintegerno
limits.searchobjectno
limits.search.limitintegerno
limits.search.usedintegerno
next_cursorstring | nullyes

Schema: SearchSubscriptionPatch

FieldTypeRequiredDescription
activebooleannotrue on an inactive subscription counts against its kind's limit.
endpoint_idstringno
include_correctionsbooleanno
min_interval_sinteger | nullnonull clears it.
namestringno
queryobjectnoReplaces the stored query whole.

Schema: SearchSubscriptionTest

FieldTypeRequiredDescription
dataarray of objectyesThe payloads the subscription would have produced for filings accepted in the last 7 days, newest first, each the webhook envelope with test: true: filing.new (filing, firehose; id new:<subscription>:<accession>) or search.match (search; id match:<subscription>:<accession>). Nothing is delivered.

Schema: SearchSubscriptionTestRequest

No members; the body is optional.

An object with no fixed fields.

Schema: SearchTotals

Exact counts of the whole query (every page), in both units. All counts are null with totals=false.

FieldTypeRequiredDescription
collapsed_hiddeninteger | nullnoResults hidden by collapse=true; 0 without it. Totals and facets are never collapsed.
documentsinteger | nullnoMatching documents.
filingsinteger | nullnoFilings with at least one matching document.
relationstringnogte when a NEAR candidate budget was exhausted (warning near_budget_exhausted); eq otherwise. One of: eq, gte.

Schema: SearchWarning

FieldTypeRequiredDescription
codestringnoOne of ignored_parameter, unknown_ticker, snippet_truncated, near_budget_exhausted, leading_wildcard_dropped, no_searchable_text, cursor_generation_expired, cluster_table_changed.
detailstringno
doc_idstringnosnippet_truncated: the document whose snippet scan was cut short.
parameterstringnoignored_parameter: the parameter's name.
positioninteger | nullnoCharacter offset in q, when the warning concerns q.
tickerstringnounknown_ticker: the ticker the ticker file does not know.

Schema: SecFiling

One filing as SEC lists it for the entity.

FieldTypeRequiredDescription
accepted_atdate-time (RFC 3339, UTC) | nullno
accessionstringno
actstring | nullno
cikstringno
file_numberstring | nullno
filing_datedate (YYYY-MM-DD)no
film_numberstring | nullno
formstringno
in_v3booleannoWhether v3 has ingested this filing. A filing SEC deleted is in v3 too (status deleted).
is_inline_xbrlboolean | nullno
is_xbrlboolean | nullno
itemsarray of stringno
linksobjectno
links.filingstring | nullnoThe filing in v3; null when in_v3 is false.
primary_doc_descriptionstring | nullno
primary_documentstring | nullno
report_datedate (YYYY-MM-DD) | nullno
sizeinteger | nullno
statusstring | nullnoThe filing's status in v3; null when in_v3 is false. One of: provisional, final, deleted, null.

Schema: SecFilingList

FieldTypeRequiredDescription
dataarray of SecFilingyes
has_morebooleanno
next_cursorstring | nullnoAlways null: this list is paged with offset; use next_offset.
next_offsetinteger | nullnoThe offset of the next page; null on the last page (and when the snapshot store is unavailable).
offsetintegerno
snapshotSnapshotyes
totalinteger | nullnoRows matching the filters; null when the snapshot store is unavailable.

Schema: Section

FieldTypeRequiredDescription
absence_basisstringnoOne of: none, form_optional, bracketed, amendment_scope.
confidencenumber | nullnoRule confidence (not a probability).
flagsarray of stringno
incorporationobject | nullno
item_codestringno
item_orderintegerno
labelstring | nullno
linksobjectno
partstringno
sectionstringnoThe key: 10k.1a, 10q.p1i2, 20f.3d.
statusstringnoOne of: ok, incorporated_by_reference, combined_with, omitted, reserved, not_found.
text_endinteger | nullno
text_startinteger | nullno

Schema: SectionMapOfFiling

GET /v3/filings/{accession}/sections for S-4, S-4/A, F-4, F-4/A, DEFM14A, PREM14A, DEFM14C and DEF 14A.

FieldTypeRequiredDescription
accessionstringno
confidencenumber | nullno
documentobject | nullno
extractionobjectno
familystring | nullnoOne of: merger, proxy, null.
filingFilingRefno
flagsarray of stringno
formstringno
keys_foundarray of stringno
primary_text_bytesinteger | nullno
registrantstring | nullno
sectionsarray of SectionMapRowno
sections_foundinteger | nullnoSections with a key.
sections_unmappedinteger | nullno
snapshotobjectno
source_formatstring | nullno
toc_entriesinteger | nullno
toc_kindstring | nullnoOne of: linked, text, none, null.
versionsstringno

Schema: SectionMapRow

One top-level section of a merger document's or proxy statement's map (extractor section_maps 0.2.0): a keyed heading, or an unmapped heading not inside one. It runs from its heading to the next heading that has a key or stands at its depth of the contents or shallower; the unmapped sub-headings in between are its subsections. Contents of one style give no depths: sections are then flat.

FieldTypeRequiredDescription
block_countintegerno
confidencenumberno
extracted_atstringno
extractor_versionstringno
first_block_idstring | nullno
flagsarray of stringno
heading_block_idstringno
heading_textstringnoThe heading as filed.
keystringnoThe canonical key, or 'unmapped'. Proposals: proposal_<n>, n = 1..99, one key per proposal (there is no 'proposals' key).
labelstring | nullno
last_block_idstring | nullno
linksobjectno
ordinalintegerno1-based, document order.
proposal_titlestring | nullnoproposal_<n>: the heading without its number ('Proposal No. 2: Ratification of Ernst & Young LLP' -> 'Ratification of Ernst & Young LLP'); null for other keys.
sectionstringnoThe key or unmapped_<ordinal> for a heading no key names; the {section} of the text route.
signalsarray of stringno
span_endintegerno
span_startintegerno
statusstringnoOne of: ok.
subsectionsarray of objectnoThe unmapped sub-headings inside this section, document order; each runs to the next heading.
subsections[].block_countintegerno
subsections[].heading_block_idstringno
subsections[].heading_textstringno
subsections[].linksobjectno
subsections[].ordinalintegerno
subsections[].sectionstringnounmapped_<ordinal>
subsections[].span_endintegerno
subsections[].span_startintegerno
subsections[].text_bytesintegerno
subsections[].text_endintegerno
subsections[].text_startintegerno
subsections[].toc_textstring | nullno
text_bytesintegerno
text_endintegerno
text_startintegerno
title_as_foundstringnoSame as heading_text (the shape of 10-K sections).
toc_textstring | nullnoThe table of contents entry as filed, when the section came from it.

Schema: SectionScope

FieldTypeRequiredDescription
amendment_nointeger | nullno
explanatory_noteobject | nullno
is_amendmentbooleanno
items_presentarray of stringno
kindstringnoOne of: full, part_iii_only, exhibits_only, items_subset, no_items.

Schema: SectionSearchList

FieldTypeRequiredDescription
as_ofstring | nullno
dataarray of objectno
data[].filingFilingRefno
data[].formstringno
data[].linksobjectno
data[].scope_kindstringno
data[].sectionSectionno
formstringno
has_morebooleanno
next_cursorstring | nullno
sectionstringno
snapshotSnapshotno

Schema: SectionsOfFiling

FieldTypeRequiredDescription
accessionstringno
documentobject | nullno
extractionExtractionno
filingFilingRefno
financial_statementsobject | nullno
formstring | nullno
scopeSectionScopeno
sectionsarray of Sectionno
snapshotSnapshotno
versionsstringno

Schema: Snapshot

Which SEC submissions snapshot the response speaks for. On filing responses (filings, a filing, versions, reports): the snapshot whose values v3 stores, i.e. the date of the last complete snapshot sync; available is false until one has completed (the values are then those v3 learned itself). On entity responses: whether the snapshot store was used, and its snapshot; when available is false that response was built from the v3 database alone.

FieldTypeRequiredDescription
availablebooleanyes
datedate (YYYY-MM-DD) | nullyesDate of that snapshot; null when there is none.

Schema: Spac

Whether the entity was a SPAC (blank check, SIC 6770), from the SIC and name in the headers of its filings over time (derive:spac_history). status: current (its filings still read SIC 6770), former (a later filing reads another SIC, or its name moved away from a SPAC name while the SIC still reads 6770), none (no filing reads 6770). merger_closed_at: the de-SPAC close, the period of report (event date) of the 8-K with Item 2.01 nearest the change (basis item_2_01); without one, the first filing under the new SIC (sic_change) or the date of the name change (name_change); merger_accession is the filing it comes from. ipo_at: the first 424B prospectus filed under 6770. flags: no_item_2_01, item_2_01_after_change, no_ipo_prospectus (a blank-check shell, not a listed SPAC), sic_returned_to_6770, name_change_only, merged_into_other_registrant (SIC and name unchanged: the SPAC merged into a new holding company, which is another entity), sic_changed_without_close (current: EDGAR moved the SIC, usually at the deal announcement, but no close was filed).

FieldTypeRequiredDescription
basisstringyesOne of: item_2_01, sic_change, name_change, none.
computed_atstring | nullno
current_namestring | nullno
derive_versionstring | nullno
flagsarray of stringno
ipo_accessionstring | nullno
ipo_atdate (YYYY-MM-DD) | nullno
merger_accessionstring | nullyes
merger_closed_atdate (YYYY-MM-DD) | nullyes
sic_history_sourceobject | nullnofirst_6770_accession, first_6770_date, last_6770_accession, last_6770_date, sic_change_accession, sic_change_date, new_sic.
spac_namestring | nullno
statusstringyesOne of: current, former, none.

Schema: SpacCompanies

FieldTypeRequiredDescription
dataarray of objectyes
data[].cikstringno
data[].linksobjectno
data[].namestring | nullno
data[].spacSpacno
has_morebooleanyes
next_cursorstring | nullyes
spacstringyesOne of: former, current.

Schema: SpanText

The canonical text of an item or section (not the filed HTML), page [text_offset, text_offset + text_bytes) in UTF-8 bytes.

FieldTypeRequiredDescription
accessionstringno
docmodel_versionstring | nullno
documentobject | nullno
extractionExtractionno
next_offsetinteger | nullno
sectionstringno
served_model_versionstringno
textstring | nullno
text_bytesinteger | nullno
text_offsetinteger | nullno
text_reasonstring | nullnoOne of: model_changed, bytes_unavailable, null.
text_statusstringnoOne of: current, from_version, reparse_pending, no_text, parse_pending.
text_total_bytesinteger | nullno
text_truncatedbooleanno

Schema: StreamEvent

FieldTypeRequiredDescription
dataobjectyesfiling.* events carry {filing} (and change or changes for filing.updated and filing.corrected); filing.deleted carries {accession, deleted_at, reason}; feed.day_closed carries {day, filings, live_first_seen, feed_only, corrected, deleted, realtime_missed}.
data.filingStreamFilingno
emitted_atdate-time (RFC 3339, UTC)yes
idstringyesstr_<stream_seq>, zero padded.
schema_versionintegeryesOne of: 1.
stream_seqintegeryesThe event's position in the stream log; dense: a jump means a missed event.
typestringyesOne of: filing.new, filing.updated, filing.corrected, filing.deleted, feed.day_closed.

Schema: StreamFiling

The filing of a filing.* event: the members of GET /v3/filings/{accession} under the same names, plus form_family, registered_at, documents_state, primary_document and links.sec_index. Metadata and links only; document bytes come from the document links.

FieldTypeRequiredDescription
accepted_atdate-time (RFC 3339, UTC) | nullno
accepted_at_sourcestring | nullno
accessionstringno
base_formstring | nullno
doc_countintegerno
documentsarray of objectnoAt most 100 entries, none with detail=summary.
documents_statestringnopending: the documents were not fetched within the 15 s hold; documents is empty and a filing.updated with change documents_added follows. One of: complete, pending.
documents_truncatedbooleannotrue when the list was cut: the filing has more than 100 documents, or the list was shortened to fit the event's 16 KiB.
entitiesarray of objectnoThe filing's entities, as on GET /v3/filings/{accession}, with tickers.
entities_truncatedbooleannotrue when the entities were cut to fit the event's 16 KiB: the filer plus the first 50, or the filer alone. Additive member.
filing_datedate (YYYY-MM-DD) | nullno
first_seen_atdate-time (RFC 3339, UTC) | nullno
form_familystring | nullno
form_typestring | nullno
itemsarray of stringno
latebooleanno
linksobjectno
links.sec_indexstringno
links.selfstringno
period_of_reportdate (YYYY-MM-DD) | nullno
primary_documentobject | nullno
provisionalbooleanno
registered_atdate-time (RFC 3339, UTC) | nullno
sourcestringnorealtime for a filing seen live, feed for one first seen in the nightly feed (late: true).
statusstringno
total_bytesintegerno

Schema: StreamPage

FieldTypeRequiredDescription
dataarray of StreamEventyesIn stream order (the order of emission, not acceptance order).
has_morebooleanyestrue when more events are waiting: ask again at once.
head_cursorstringyes
liveobjectyes
live.covered_untildate-time (RFC 3339, UTC) | nullno
live.statestringnoThe live ingest daemon's state, or down.
next_cursorstringyesOn every answer, an empty one included; with filters it moves past the events they dropped.
retentionobjectyes
retention.daysintegerno
retention.oldest_cursorstring | nullno

Schema: StreamStatus

FieldTypeRequiredDescription
head_cursorstringyes
latencyobjectyesPercentiles in seconds of live filing.new, over the last hour and the last 24 hours: from SEC's acceptance to the event, and from registration to the event.
latency.from_acceptedobjectno
latency.from_registeredobjectno
liveobjectyes
live.covered_untildate-time (RFC 3339, UTC) | nullno
live.statestringno
retentionobjectyes
retention.daysintegerno
retention.oldest_cursorstring | nullno
sequencerobjectyes
sequencer.lag_eventsinteger | nullno
sequencer.lag_secondsnumber | nullno
sequencer.leadingboolean | nullno

Schema: Usage

FieldTypeRequiredDescription
as_ofdate-time (RFC 3339, UTC)yes
enforcementobjectyesEach feature: off, observe (counted and logged, never refused) or enforce.
keyobjectyes
key.bytesinteger | nullno
key.fingerprintstringnoFirst 12 hex digits of the key's SHA-256.
key.requestsinteger | nullno
limitsobject | nullyesNull while no limit is applied (metering off) and for a key without an organization.
limits.burstinteger | nullno
limits.exemptobject | nullnoNull, or the caller's exemption from the rate limit (and, when concurrency is true, from the concurrency cap). The transfer allowance still applies.
limits.exempt.concurrencybooleanno
limits.exempt.expires_atdate-time (RFC 3339, UTC) | nullnoWhen the exemption ends; null = no end set.
limits.exempt.ratebooleanno
limits.exempt.scopestringnokey: this key; org: every credential of the organization; config: the server's configuration. One of: key, org, config.
limits.monthly_bytesinteger | nullnoIncluded response bytes per month (measured before compression); null = unlimited.
limits.monthly_requestsinteger | nullno
limits.requests_per_secondinteger | nullnoNull while the caller is exempt from the rate limit.
monthstringyesThe month counted, YYYY-MM: the calendar month in New York time (America/New_York).
orgobjectyesThis month, all keys of the organization (a legacy key: that key). Null members while usage is not counted.
org.bytesinteger | nullnoBillable response bytes (5xx and 429 excluded).
org.bytes_remaininginteger | nullno
org.requestsinteger | nullno
org_idinteger | nullyesThe organization of the key; null for a legacy key not attributed to one.
planstring | nullyesThe organization's plan id; null when its entitlements are not known (default limits apply).
reset_atdate-time (RFC 3339, UTC)yesWhen the monthly allowance starts again: the start of the next month, midnight in New York (04:00 or 05:00 UTC).

Schema: ValueUnit

The unit decision of one filing's values: dollar values are served only together with it.

FieldTypeRequiredDescription
computed_atdate-time (RFC 3339, UTC) | nullno
derive_versionstring | nullno
detectedstring | nullnoOne of: dollars, thousands, ambiguous, untested, null.
flagsarray of stringno
methodstring | nullnoOne of: date_rule, consensus_price, prior_period, null.
multiplierinteger | nullno
previousobject | nullno
previous.detectedstring | nullno
previous.multiplierinteger | nullno
previous.redecided_atdate-time (RFC 3339, UTC) | nullno
rows_testedinteger | nullno
statusstringnoOne of: decided, pending, not_applicable.
summary_unitstring | nullno

Schema: Versions

Version chain of a report: the original and its amendments. A single-item chain when nothing is linked.

FieldTypeRequiredDescription
countintegernoMembers of the whole chain, deleted and not-ingested included.
itemsarray of objectno
items[].accepted_atdate-time (RFC 3339, UTC) | nullnoAs a filing's accepted_at; null for a member that is not ingested.
items[].accepted_at_snapshotdate-time (RFC 3339, UTC)noAs on a filing: only when SEC's value differs from accepted_at.
items[].accepted_at_sourcestring | nullno
items[].accessionstringno
items[].amendment_nointeger | nullno
items[].amendment_seqinteger | nullno0 for the root, 1..n for amendments in filing order. A filing that is not an amendment has 0 from the moment it is ingested; an amendment is null until the linker has linked it.
items[].amendment_typestring | nullno
items[].currentbooleanno
items[].filing_datedate (YYYY-MM-DD) | nullno
items[].form_typestring | nullno
items[].header_in_fileboolean | nullnoAs on GET /v3/filings/{accession}.
items[].ingestedbooleannoFalse for a root known only from an amendment's link.
items[].linkobjectno
items[].link.candidatesarray of objectnoPossible originals, shown for an ambiguous link.
items[].link.confidencenumber | nullno
items[].link.methodstring | nullnoOne of: explicit_header, explicit_xml, original_date, period_match, date_items_match, file_number, parties, filer_file_number, description_text, manual, null.
items[].link.statusstringnoOne of: resolved, ambiguous, unresolved, target_not_public, target_not_yet_ingested.
items[].primary_cikstring | nullno
items[].scopestring | nullno
items[].sec_urlstring | nullno
items[].statusstring | nullno
lateststring | nullnoNewest ingested, non-deleted member; null when every ingested member is deleted.
positionintegerno1-based place of this filing in the whole chain (not in items when truncated).
report_keystringnoAccession of the chain's root (the original filing, even when it is not ingested).
rootstringnoAlias of report_key.
snapshotSnapshotnoOn /v3/filings/{accession}/versions only; the block embedded in a filing has none (the filing carries it).
truncatedbooleannoTrue when the chain has more than 200 members and items holds 200 of them (always the root, this filing and the latest, then the nearest to this filing).

Schema: WebhookEndpointVerification

{"type": "endpoint.verification", "data": {"challenge": "…"}}: signed like every event.

FieldTypeRequiredDescription
dataobjectyes
data.challengestringyes
typestringyesOne of: endpoint.verification.

Schema: WebhookEnvelope

The body of every webhook request (Standard Webhooks: type, a timestamp and data). Receivers ignore unknown members and unknown types; within schema_version 1 changes are additive only. Deliveries are at least once: deduplicate on id (the webhook-id header).

FieldTypeRequiredDescription
dataobjectyes
emitted_atdate-time (RFC 3339, UTC)yes
event_seqinteger | nullnosearch.match: the outbox position.
idstringyesThe webhook-id header's value: stable across the attempts of one delivery.
schema_versionintegeryesOne of: 1.
stream_seqintegernofiling.* events from the stream log: their stream position.
subscriptionobject | nullnoThe subscription that produced the event ({id, name}); null for a test send; absent from endpoint.verification.
subscription.idstringno
subscription.namestringno
testbooleanyestrue for a test send (POST /v3/callbacks/endpoints/{id}/test): sample data, not billed.
typestringyes

Schema: WebhookFilingCorrected

FieldTypeRequiredDescription
dataobjectyes
data.changesobjectyes
data.changes.docs_addedarray of anyno
data.changes.docs_changedarray of anyno
data.changes.docs_removedarray of anyno
data.changes.header_fieldsarray of objectno
data.changes.header_fields[].afteranyno
data.changes.header_fields[].beforeanyno
data.changes.header_fields[].fieldstringno
data.filingStreamFilingyes
emitted_atdate-time (RFC 3339, UTC)yes
event_seqinteger | nullnosearch.match: the outbox position.
idstringyesThe webhook-id header's value: stable across the attempts of one delivery.
schema_versionintegeryesOne of: 1.
stream_seqintegernofiling.* events from the stream log: their stream position.
subscriptionobject | nullnoThe subscription that produced the event ({id, name}); null for a test send; absent from endpoint.verification.
subscription.idstringno
subscription.namestringno
testbooleanyestrue for a test send (POST /v3/callbacks/endpoints/{id}/test): sample data, not billed.
typestringyesOne of: filing.corrected.

Schema: WebhookFilingDeleted

FieldTypeRequiredDescription
dataobjectyes
data.accessionstringyes
data.deleted_atdate-time (RFC 3339, UTC)yes
data.reasonstringyesOne of: feed_deletion, sec_404.
emitted_atdate-time (RFC 3339, UTC)yes
event_seqinteger | nullnosearch.match: the outbox position.
idstringyesThe webhook-id header's value: stable across the attempts of one delivery.
schema_versionintegeryesOne of: 1.
stream_seqintegernofiling.* events from the stream log: their stream position.
subscriptionobject | nullnoThe subscription that produced the event ({id, name}); null for a test send; absent from endpoint.verification.
subscription.idstringno
subscription.namestringno
testbooleanyestrue for a test send (POST /v3/callbacks/endpoints/{id}/test): sample data, not billed.
typestringyesOne of: filing.deleted.

Schema: WebhookFilingDigest

FieldTypeRequiredDescription
dataobjectyes
data.countintegeryes
data.eventsarray of objectyes
data.events[].dataobjectno
data.events[].typestringno
data.truncatedbooleanyes
emitted_atdate-time (RFC 3339, UTC)yes
event_seqinteger | nullnosearch.match: the outbox position.
idstringyesThe webhook-id header's value: stable across the attempts of one delivery.
schema_versionintegeryesOne of: 1.
stream_seqintegernofiling.* events from the stream log: their stream position.
subscriptionobject | nullnoThe subscription that produced the event ({id, name}); null for a test send; absent from endpoint.verification.
subscription.idstringno
subscription.namestringno
testbooleanyestrue for a test send (POST /v3/callbacks/endpoints/{id}/test): sample data, not billed.
typestringyesOne of: filing.digest.

Schema: WebhookFilingNew

FieldTypeRequiredDescription
dataobjectyes
data.filingStreamFilingyes
emitted_atdate-time (RFC 3339, UTC)yes
event_seqinteger | nullnosearch.match: the outbox position.
idstringyesThe webhook-id header's value: stable across the attempts of one delivery.
schema_versionintegeryesOne of: 1.
stream_seqintegernofiling.* events from the stream log: their stream position.
subscriptionobject | nullnoThe subscription that produced the event ({id, name}); null for a test send; absent from endpoint.verification.
subscription.idstringno
subscription.namestringno
testbooleanyestrue for a test send (POST /v3/callbacks/endpoints/{id}/test): sample data, not billed.
typestringyesOne of: filing.new.

Schema: WebhookFilingUpdated

FieldTypeRequiredDescription
dataobjectyes
data.changestringyesdocuments_added, documents_refetched, finalized, delivery_merged or amendment_linked; new values may be added (receivers ignore unknown ones).
data.filingStreamFilingyes
emitted_atdate-time (RFC 3339, UTC)yes
event_seqinteger | nullnosearch.match: the outbox position.
idstringyesThe webhook-id header's value: stable across the attempts of one delivery.
schema_versionintegeryesOne of: 1.
stream_seqintegernofiling.* events from the stream log: their stream position.
subscriptionobject | nullnoThe subscription that produced the event ({id, name}); null for a test send; absent from endpoint.verification.
subscription.idstringno
subscription.namestringno
testbooleanyestrue for a test send (POST /v3/callbacks/endpoints/{id}/test): sample data, not billed.
typestringyesOne of: filing.updated.

Schema: WebhookSearchDigest

FieldTypeRequiredDescription
dataobjectyes
data.countintegeryes
data.eventsarray of objectyes
data.events[].dataobjectno
data.events[].typestringno
data.truncatedbooleanyes
emitted_atdate-time (RFC 3339, UTC)yes
event_seqinteger | nullnosearch.match: the outbox position.
idstringyesThe webhook-id header's value: stable across the attempts of one delivery.
schema_versionintegeryesOne of: 1.
stream_seqintegernofiling.* events from the stream log: their stream position.
subscriptionobject | nullnoThe subscription that produced the event ({id, name}); null for a test send; absent from endpoint.verification.
subscription.idstringno
subscription.namestringno
testbooleanyestrue for a test send (POST /v3/callbacks/endpoints/{id}/test): sample data, not billed.
typestringyesOne of: search.digest.

Schema: WebhookSearchExportCompleted

FieldTypeRequiredDescription
dataobjectyes
data.exportobjectyes
data.export.bytes_writtenintegerno
data.export.download_urlstring | nullno
data.export.idstringno
data.export.rows_writtenintegerno
data.export.statestringno
emitted_atdate-time (RFC 3339, UTC)yes
event_seqinteger | nullnosearch.match: the outbox position.
idstringyesThe webhook-id header's value: stable across the attempts of one delivery.
schema_versionintegeryesOne of: 1.
stream_seqintegernofiling.* events from the stream log: their stream position.
subscriptionobject | nullnoThe subscription that produced the event ({id, name}); null for a test send; absent from endpoint.verification.
subscription.idstringno
subscription.namestringno
testbooleanyestrue for a test send (POST /v3/callbacks/endpoints/{id}/test): sample data, not billed.
typestringyesOne of: search.export.completed.

Schema: WebhookSearchMatch

FieldTypeRequiredDescription
dataobjectyes
data.documentsarray of objectyes
data.documents[].doc_typestring | nullno
data.documents[].seqintegerno
data.documents[].snippetsarray of anyno
data.documents[].urlstring | nullno
data.event_seqinteger | nullno
data.filingobjectyes
data.filing.accepted_atstring | nullno
data.filing.accessionstringno
data.filing.entitiesarray of objectno
data.filing.filing_datestring | nullno
data.filing.form_typestring | nullno
data.matched_atdate-time (RFC 3339, UTC)yes
data.rematchbooleanyes
data.search_urlstringyesThe /v3/search request of the subscription's query, up to the filing's acceptance.
data.truncatedbooleanyestrue when documents were left out to keep the event within 64 KiB.
emitted_atdate-time (RFC 3339, UTC)yes
event_seqinteger | nullnosearch.match: the outbox position.
idstringyesThe webhook-id header's value: stable across the attempts of one delivery.
schema_versionintegeryesOne of: 1.
stream_seqintegernofiling.* events from the stream log: their stream position.
subscriptionobject | nullnoThe subscription that produced the event ({id, name}); null for a test send; absent from endpoint.verification.
subscription.idstringno
subscription.namestringno
testbooleanyestrue for a test send (POST /v3/callbacks/endpoints/{id}/test): sample data, not billed.
typestringyesOne of: search.match.

Schema: XbrlCompanyPeriods

FieldTypeRequiredDescription
as_ofstring | nullyes
cikstringyes
conceptstringyes
dataarray of objectyes
derivationobjectyesadditivity of the concept's unit (flow, per_share, share_count, ratio, stock); derived false with the refusal status for anything but a flow.
dimsstringyes
excludedExcludedyes
excluded_totalintegeryes
has_morebooleanyes
next_cursornullyes
rulestringyes
rule_versionstringyes

Schema: XbrlCompanySegments

FieldTypeRequiredDescription
accuracyobjectnoMeasured precision and coverage of each requested kind on the latest unseen holdout (static; contract 2.10).
as_ofstring | nullyes
axesarray of stringyes
cikstringyes
dataarray of objectyes
excludedExcludedyes
excluded_totalintegeryes
fromstring | nullyes
has_morebooleanyes
kindsarray of stringyes
limitintegeryesPeriod ends per page (default 1: the latest fiscal year).
next_cursorstring | nullyesOpaque: the next page (earlier period ends), same filters.
periodstring | nullyes
periodsstringyesThe period classes served, canonical (default annual: the year ends, their years and instants).
rulestringyes
rulesobjectyes
tostring | nullyes
viewstringyesOne of: latest, first_reported.

Schema: XbrlCompanyStandard

FieldTypeRequiredDescription
accuracyobjectnoMeasured precision and coverage of each requested field on the named map version (static; contract 2.9).
as_ofstring | nullyes
cikstringyes
dataarray of objectyes
data[].valuesobjectno
excludedExcludedyes
excluded_totalintegeryes
fieldsarray of stringyes
filingsobjectyesBy accession, each filing a value of the page comes from (or a derived value's input): form_type, filing_date, accepted_at, template, map {version, fingerprint}.
fromstring | nullyes
has_morebooleanyes
limitintegeryesPeriod ends per page.
mapobjectyes
next_cursorstring | nullyesOpaque: the next page (earlier period ends), same filters.
periodstring | nullyes
periodsstringyesThe period classes served, canonical (default annual,quarterly).
rulestringyes
tostring | nullyes
ttmbooleannotrue: TTM rows (class ttm) at each quarter end of the monetary flow fields.
viewstringyesOne of: latest, first_reported.

Schema: XbrlCompanyStatements

FieldTypeRequiredDescription
as_ofstring | nullyes
categorystring | nullyes
cikstringyes
dataarray of objectyes
data[].accessionstringno
data[].filingobjectnoWith links.next: the filing route's next page of this report.
data[].has_morebooleanno
data[].statementsarray of XbrlStatementno
excludedExcludedyes
excluded_totalintegeryes
has_morebooleanyesA category alone: the report's next roles (next_cursor).
kindstring | nullyes
next_cursorstring | nullyes
role_uristring | nullyes

Schema: XbrlDuplicate

The fact's duplicate group inside its instance (XBRL International note 2025-01-14): complete, consistent or inconsistent; rank 1 is the preferred member (higher decimals, then document order). No member is removed.

FieldTypeRequiredDescription
groupintegerno
rankintegerno
statusstringnoOne of: complete, consistent, inconsistent.

Schema: XbrlFact

One fact as filed. value is the exact number (null for text, nil, a text block or filed text that is not a number); value_raw the filed characters (null for nil and text blocks). A text block's content is not served: text gives its span in the stored instance.

FieldTypeRequiredDescription
conceptobjectno
concept.is_extensionbooleanno
concept.namestringno
concept.prefixstringno
concept.qnamestringno
contextobject | nullnoNull when the fact's contextRef names no context (warning context_missing).
decimalsstring | nullnoAs filed: INF, -3, 0, ...; null when absent.
dims_hashstring | nullnoFirst 16 bytes (hex) of the SHA-256 of the canonical dimensions; null without dimensions.
doc_seqintegerno
duplicateXbrlDuplicateno
entity_cikstring | nullno
fact_idstring | nullno
fact_seqintegerno1..n across every instance of the filing, in reading order.
footnote_nosarray of integerno
is_nilbooleanno
is_text_blockbooleanno
periodXbrlPeriodno
precision_rawstring | nullno
textobject | nullno
text.documentstringno
text.sha256string | nullno
text.span_endintegerno
text.span_startintegerno
unitobject | nullno
unit_normstring | nullno
valueNullableDecimalno
value_rawstring | nullno
xml_langstring | nullno

Schema: XbrlFilingFacts

FieldTypeRequiredDescription
accessionstringyes
dataarray of XbrlFactyes
extractionExtractionyes
filingFilingRefyes
footnotesarray of objectyes
has_morebooleanyes
next_cursorstring | nullyes
snapshotSnapshotyes
xbrlobject | nullyesThe instances read, namespaces, taxonomy years, counts, dei cover values as filed, cover (registrants, securities, shares outstanding, public float, auditors), flags; null before a parse.

Schema: XbrlFilingRoles

FieldTypeRequiredDescription
accessionstringyes
categorystring | nullyes
dataarray of XbrlRoleyesRole number order, at most 500 a page.
extractionExtractionyes
filingFilingRefyes
has_morebooleanyes
next_cursorstring | nullyes
snapshotSnapshotyes
xbrl_statementsobject | nullyes

Schema: XbrlFilingStatements

FieldTypeRequiredDescription
accessionstringyes
dataarray of XbrlStatementyesAt most 25 roles (limit) and 2 MB of statement JSON a page.
extractionExtractionyes
filingFilingRefyes
has_morebooleanyes
next_cursorstring | nullyes
rolesarray of object | nullyesThe filing's roles, role number order: on the first page (no cursor) only, its first 500 (the rest: /statements/roles); null on later pages.
roles_has_morebooleanyes
snapshotSnapshotyes
xbrl_statementsobject | nullyesMetadata source, documents read, counts, flags; null before a parse.

Schema: XbrlFinancialFact

FieldTypeRequiredDescription
accessionstringno
conceptstringno
context_nointeger | nullno
decimalsstring | nullno
dimsarray of any | nullno
dims_hashstring | nullno
duplicateXbrlDuplicateno
entity_cikstring | nullno
fact_seqintegerno
filingobjectno
filing.accepted_atdate-time (RFC 3339, UTC) | nullno
filing.accepted_at_sourcestring | nullno
filing.deleted_atdate-time (RFC 3339, UTC) | nullno
filing.filing_datedate (YYYY-MM-DD) | nullno
filing.form_typestring | nullno
filing.statusstringnoOne of: provisional, final, deleted.
is_nilbooleanno
is_text_blockbooleanno
legal_entity_memberstring | nullno
periodXbrlPeriodno
unit_normstring | nullno
valueNullableDecimalno
value_rawstring | nullno

Schema: XbrlFinancialFactList

FieldTypeRequiredDescription
as_ofstring | nullyes
cikstringyes
conceptstringyes
dataarray of XbrlFinancialFactyes
dimsstringyes
has_morebooleanyes
next_cursorstring | nullyes
periodstring | nullyes

Schema: XbrlFrame

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

Schema: XbrlPeriod

FieldTypeRequiredDescription
enddate (YYYY-MM-DD) | nullno
startdate (YYYY-MM-DD) | nullno
typestringnoOne of: instant, duration, forever.

Schema: XbrlRole

One role of a filing: role_no, role_uri, long_name, short_name, menu_category, position, html_file (its R page), statement_kind (null: not a statement or cover role), parenthetical, kind_method, nodes, tree_stored, matches_sec_render (true / false; null: no R page or no instance), links.statement.

An object with no fixed fields.

Schema: XbrlSegmentRow

One line of a breakdown: role member | segments_total | reconciling | consolidated; member (qname; null on the consolidated row), member_label (the company's own label), member_standard (country:XX, a srt / us-gaap member, or null for the company's own member), axis_qname, concept (null for an L4 consolidated value), concept_label, status ok | ambiguous, value (a decimal string, null unless ok), unit_norm, weight (the row's sign in the check), fact_seq and context_no (the fact behind it), source (consolidated: l4:<field>:<rule> or fact), flags (check_fail, ambiguous_duplicate).

An object with no fixed fields.

Schema: XbrlSeries

FieldTypeRequiredDescription
as_ofstring | nullyes
cikstringyes
conceptstringyes
dataarray of objectyes
data[].accessionstringno
data[].decimalsstring | nullno
data[].dup_inconsistentbooleanno
data[].fact_seqintegerno
data[].filingobjectno
data[].identityobjectno
data[].identity.dims_hashstring | nullno
data[].identity.periodXbrlPeriodno
data[].identity.unit_normstringno
data[].is_nilbooleanno
data[].revisionobjectnonumber: 1 = first reported; of: incarnations known at as_of; original_value: the first one's; changed: the value differs from the previous incarnation's.
data[].valueNullableDecimalno
data[].value_rawstring | nullno
dimsstringyes
excludedExcludedno
excluded_totalintegerno
has_morebooleanyes
next_cursornullyes
viewstringyesOne of: latest, first_reported, revisions.

Schema: XbrlStandardFrame

FieldTypeRequiredDescription
accuracyobjectnoMeasured precision and coverage of the field on the named map version (static; contract 2.9).
as_ofstring | nullyes
dataarray of XbrlStdValueyesOne ok value per company, CIK order, with entity_cik, period and links.company: reported, or derived (a quarter of a quarter frame, a TTM) with formula and inputs.
excludedExcludedyes
excluded_totalintegeryes
fieldstringyes
framestringyes
has_morebooleanyes
limitintegeryesCompanies with a value per page.
mapobjectyes
next_cursorstring | nullyesOpaque: the companies after this page, same filters.
periodstringyes
refusedobjectyesCompanies left out by status: ambiguous, not_reported, not_applicable, basis_mismatch, refused_*.
rulestringyes
ttmbooleanyestrue: each value is the trailing twelve months ending in the frame's quarter.
viewstringyes

Schema: XbrlStatement

FieldTypeRequiredDescription
calculationarray of objectno
calculation[].childstringno
calculation[].orderNullableDecimalno
calculation[].order_rawstring | nullno
calculation[].parentstringno
calculation[].weightNullableDecimalno
calculation[].weight_rawstring | nullno
columnsarray of objectno
columns[].daysinteger | nullno
columns[].is_document_periodbooleanno
columns[].periodXbrlPeriodno
layoutobjectnoThe rows as SEC's renderer lays them out (its R page): kind tree (value rows in tree order, rows filled only by member facts after) or roll_forward (equity: one row group per period, oldest first); rows [{seq, column, members}] (column: the period group's column, null for tree; members: the member row group, axis=member;..., null for a main row -- a row repeats once per member group).
layout.kindstringnoOne of: tree, roll_forward.
layout.rowsarray of objectno
layout.rows[].columninteger | nullno
layout.rows[].membersstring | nullno
layout.rows[].seqintegerno
matches_sec_renderboolean | nullnoCompared when the filing was parsed: the assembled layout has the non-abstract rows of the filing's R page of this role in the same order (true) or not (false); null when the filing has no R page for it or no instance.
roleobjectnorole_no, role_uri, names, menu_category, statement_kind (BS IS CF EQ CI CP UN; null for a note, policy, table or detail role), parenthetical, kind_method, r_page (the SEC-rendered page of the role).
rowsarray of objectno
rows[].cellsarray of XbrlStatementCellno
rows_from_seqintegernoThe first row (seq) served here: 1, or where a role cut by the previous page's row budget continues.
rows_has_morebooleannoThe role's later rows are on the next page (the page's 2 MB were reached). The calculation comes with the first part only.
warningsarray of objectnoOn the part that starts at the first row.

Schema: XbrlStatementCell

The fact of a cell as filed (null: no fact for that row and column, never zero). A text block (a note's row): is_text_block true, value and value_raw null, text {doc_seq, span_start, span_end} where its content is in the stored instance.

FieldTypeRequiredDescription
decimalsstring | nullno
entity_cikstring | nullno
fact_seqintegerno
is_nilbooleanno
is_text_blockbooleanno
textobjectno
unit_normstring | nullno
valueNullableDecimalno
value_rawstring | nullno

Schema: XbrlStdValue

One standard field for one period. Reported (source reported): status ok | not_reported | ambiguous | not_applicable, value (null unless ok: a blank is never a zero), unit_norm, rule (candidate:<priority> or rollup), flags (identity_fail:<id>, scale_outlier:<k>, via_fallback, via_rollup, sign_applied), sources (the facts: fact_seq, context_no, concept, role value | rollup_child, weight, calc_role_uri, value_raw), alternatives (other candidates with a fact), accession of the incarnation served (on /v3/companies/{cik}/standard its filing is in the response's filings; on /v3/financials/standard inline: filing, map {version, fingerprint}, template), incarnations (filings that stated an ok value). Derived (source derived; Q4, Q3, Q2, H2 of monetary flow fields): status ok | basis_mismatch | refused_*, value, formula, inputs, rule_version, flags, detail, first_reported beside a basis_mismatch.

An object with no fixed fields.

Markdown version: /docs/reference/schemas.md