# Schemas

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

## Schema: Addresses

| Field | Type | Required | Description |
|---|---|---|---|
| `business` | object \| null | no | {street1, street2, city, state, zip, phone} as filed. |
| `mail` | object \| null | no |   |

## Schema: CallbackAttempt

| Field | Type | Required | Description |
|---|---|---|---|
| `at` | date-time (RFC 3339, UTC) | yes |   |
| `duration_ms` | integer \| null | yes |   |
| `error_class` | string \| null | yes | One of: `timeout`, `connect`, `tls`, `dns`, `blocked_address`, `redirect`, `http`, `too_large`, `null`. |
| `http_status` | integer \| null | yes | Null when no status line was received. |
| `n` | integer | yes | 1 for the first attempt. |
| `remote_ip` | string \| null | yes | The address connected to. |
| `response_excerpt` | string \| null | yes | The first 512 bytes of the endpoint's answer. |

## Schema: CallbackDelivery

One delivery of a webhook event to one endpoint.

| Field | Type | Required | Description |
|---|---|---|---|
| `accession` | string \| null | yes | The filing's accession number, for filing events. |
| `attempt_count` | integer | yes | Attempts made so far; a manual retry or a replay continues the count. |
| `billed_bytes` | integer | yes | The payload bytes billed: the payload size once the endpoint answered 2xx, else 0. Failed attempts, test events and endpoint verification are not billed. |
| `created_at` | date-time (RFC 3339, UTC) | yes |   |
| `delivered_at` | date-time (RFC 3339, UTC) \| null | yes |   |
| `endpoint_id` | string | yes | cbe_ and 24 hex digits. |
| `held_reason` | string \| null | yes | Only while state is held. One of: `quota_exceeded`, `plan_required`, `endpoint_disabled`, `endpoint_unverified`, `digest`, `null`. |
| `id` | string | yes | dlv_ and 24 hex digits. |
| `last_attempt_at` | date-time (RFC 3339, UTC) \| null | yes | When the newest attempt was made; null before the first. |
| `last_error` | string \| null | yes | Why 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_status` | integer \| null | yes | The HTTP status of the last attempt that got one. |
| `next_attempt_at` | date-time (RFC 3339, UTC) \| null | yes | When the next attempt is due; only while state is pending. |
| `state` | string | yes | pending: 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_id` | string \| null | yes | sub_ and 24 hex digits; null for an event that belongs to no subscription. |
| `type` | string | yes | The event type, for example filing.new. |

## Schema: CallbackDeliveryDetail

| Field | Type | Required | Description |
|---|---|---|---|
| `accession` | string \| null | yes | The filing's accession number, for filing events. |
| `attempt_count` | integer | yes | Attempts made so far; a manual retry or a replay continues the count. |
| `billed_bytes` | integer | yes | The payload bytes billed: the payload size once the endpoint answered 2xx, else 0. Failed attempts, test events and endpoint verification are not billed. |
| `created_at` | date-time (RFC 3339, UTC) | yes |   |
| `delivered_at` | date-time (RFC 3339, UTC) \| null | yes |   |
| `endpoint_id` | string | yes | cbe_ and 24 hex digits. |
| `held_reason` | string \| null | yes | Only while state is held. One of: `quota_exceeded`, `plan_required`, `endpoint_disabled`, `endpoint_unverified`, `digest`, `null`. |
| `id` | string | yes | dlv_ and 24 hex digits. |
| `last_attempt_at` | date-time (RFC 3339, UTC) \| null | yes | When the newest attempt was made; null before the first. |
| `last_error` | string \| null | yes | Why 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_status` | integer \| null | yes | The HTTP status of the last attempt that got one. |
| `next_attempt_at` | date-time (RFC 3339, UTC) \| null | yes | When the next attempt is due; only while state is pending. |
| `state` | string | yes | pending: 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_id` | string \| null | yes | sub_ and 24 hex digits; null for an event that belongs to no subscription. |
| `type` | string | yes | The event type, for example filing.new. |
| `attempts` | array of [CallbackAttempt](#schema-callbackattempt) | yes | Every attempt, oldest first; empty before the first. |
| `payload` | object | yes | The event as sent, the body of the request. |

## Schema: CallbackDeliveryList

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | array of [CallbackDelivery](#schema-callbackdelivery) | yes |   |
| `next_cursor` | string \| null | yes | Pass 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.

| Field | Type | Required | Description |
|---|---|---|---|
| `active` | boolean | yes |   |
| `created_at` | date-time (RFC 3339, UTC) | yes |   |
| `description` | string \| null | yes |   |
| `event_types` | array of string | yes |   |
| `health` | object | yes |   |
| `health.consecutive_failures` | integer | no |   |
| `health.disabled_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `health.disabled_reason` | string \| null | no |   |
| `health.failing_since` | date-time (RFC 3339, UTC) \| null | no |   |
| `health.last_success_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `health.state` | string | yes | One of: `unverified`, `active`, `failing`, `disabled`. |
| `health.verified_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `id` | string | yes | cbe_ and 24 hex digits. |
| `last_24h` | object | yes | Deliveries of the last 24 hours by state. |
| `last_24h.delivered` | integer | no |   |
| `last_24h.dropped` | integer | no |   |
| `last_24h.failed` | integer | no |   |
| `last_24h.held` | integer | no |   |
| `updated_at` | date-time (RFC 3339, UTC) | yes |   |
| `url` | string | yes | As stored: https, the host in lower case, no :443, / for an empty path. |

## Schema: CallbackEndpointCreate

| Field | Type | Required | Description |
|---|---|---|---|
| `description` | string \| null | no | At most 800 bytes. |
| `event_types` | array of string | yes |   |
| `url` | string | yes | https 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

| Field | Type | Required | Description |
|---|---|---|---|
| `active` | boolean | yes |   |
| `created_at` | date-time (RFC 3339, UTC) | yes |   |
| `description` | string \| null | yes |   |
| `event_types` | array of string | yes |   |
| `health` | object | yes |   |
| `health.consecutive_failures` | integer | no |   |
| `health.disabled_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `health.disabled_reason` | string \| null | no |   |
| `health.failing_since` | date-time (RFC 3339, UTC) \| null | no |   |
| `health.last_success_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `health.state` | string | yes | One of: `unverified`, `active`, `failing`, `disabled`. |
| `health.verified_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `id` | string | yes | cbe_ and 24 hex digits. |
| `last_24h` | object | yes | Deliveries of the last 24 hours by state. |
| `last_24h.delivered` | integer | no |   |
| `last_24h.dropped` | integer | no |   |
| `last_24h.failed` | integer | no |   |
| `last_24h.held` | integer | no |   |
| `updated_at` | date-time (RFC 3339, UTC) | yes |   |
| `url` | string | yes | As stored: https, the host in lower case, no :443, / for an empty path. |
| `secret` | string | yes | whsec_ and the standard base64 (with padding) of 32 random bytes: the Standard Webhooks signing secret. Shown only in this answer. |

## Schema: CallbackEndpointList

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | array of [CallbackEndpoint](#schema-callbackendpoint) | yes |   |
| `has_more` | boolean | yes |   |
| `limits` | object | yes |   |
| `limits.endpoints` | object | no |   |
| `limits.endpoints.limit` | integer \| null | no | The plan's limit; 0 without callbacks. |
| `limits.endpoints.used` | integer | no | Active endpoints. |
| `next_cursor` | string \| null | yes |   |

## Schema: CallbackEndpointPatch

| Field | Type | Required | Description |
|---|---|---|---|
| `active` | boolean | no | true on an inactive endpoint counts against the plan's limit. |
| `description` | string \| null | no | null clears it. |
| `event_types` | array of string | no |   |
| `url` | string | no |   |

## Schema: CallbackEndpointTestRequest

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | string | yes | One 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

| Field | Type | Required | Description |
|---|---|---|---|
| `delivered` | boolean | no | 200 only: the endpoint answered 2xx. |
| `duration_ms` | integer \| null | no | 200 only: the attempt's duration. |
| `error_class` | string \| null | no | 200 only. One of: `timeout`, `connect`, `tls`, `dns`, `blocked_address`, `redirect`, `http`, `too_large`, `null`. |
| `http_status` | integer \| null | no | 200 only: the endpoint's status; null when no HTTP answer came. |
| `id` | string | yes | The test delivery's id (dlv_ and 24 hex digits), in the delivery log. |
| `state` | string | yes | 200: 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

| Field | Type | Required | Description |
|---|---|---|---|
| `from` | string | yes | Start of the window of created_at, inclusive: YYYY-MM-DDTHH:MM:SSZ, or YYYY-MM-DD for midnight UTC. |
| `states` | array of string | no | Default both. |
| `to` | string | no | End of the window, exclusive, same forms; default now. The window is at most 30 days. |
| `types` | array of string | no | Only deliveries of these event types; default every type. |

## Schema: CallbackReplayResult

| Field | Type | Required | Description |
|---|---|---|---|
| `last_created_at` | date-time (RFC 3339, UTC) \| null | yes | When 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. |
| `replayed` | integer | yes | Deliveries requeued. |
| `truncated` | boolean | yes | true 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

| Field | Type | Required | Description |
|---|---|---|---|
| `expire_previous_in_s` | integer | no | How 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

| Field | Type | Required | Description |
|---|---|---|---|
| `computed_at` | date-time (RFC 3339, UTC) | no | When data (the per-day part) was computed, UTC. The value is served until a later computation replaces it. |
| `data` | array of [CoverageDay](#schema-coverageday) | yes | Per 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. |
| `live` | object \| null | no | Live 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_until` | date-time (RFC 3339, UTC) \| null | no | SEC's list of new filings has been read without a gap up to here. |
| `live.ended` | string \| null | no | How the session ended; null while it runs. The reason is in the daemon's log, not here. One of: `clean`, `failed`, `null`. |
| `live.fetch` | object | no | requests, http_404, http_429, http_5xx, network, integrity, too_large, bytes, and recent {requests, failed}. |
| `live.filings` | object | no | Counts since the session started: seen, listed, documents, failed, skipped_known, and per_min_1, per_min_5, per_min_peak. |
| `live.heartbeat_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `live.items_unmapped` | number \| null | no | 8-K item descriptions seen without an item code. |
| `live.last_new_accession` | string \| null | no |   |
| `live.last_new_filing_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `live.latency_ms` | object | no | recent (the last window_s seconds) and day: n, and p50 / p95 of accept_to_seen, seen_to_listed, seen_to_documents. |
| `live.limiter` | object | no | The shared SEC request limiter as the daemon sees it: priority (on, off, unavailable), wait_ms {p50, p95}, waits_over_1s, refused. |
| `live.mode` | string \| null | no | One of: `live`, `dry_run`, `null`. |
| `live.paused_until` | date-time (RFC 3339, UTC) \| null | no |   |
| `live.pauses_24h` | number \| null | no |   |
| `live.poll` | object | no | Counts of polls and sweeps of SEC's list; rtt_ms and skew_ms in milliseconds. |
| `live.poll.below_page0` | number \| null | no |   |
| `live.poll.failed` | number \| null | no |   |
| `live.poll.last_ok_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `live.poll.last_poll_failed` | boolean | no | Whether the last poll failed. The error text stays in the daemon's log. |
| `live.poll.ok` | number \| null | no |   |
| `live.poll.out_of_order` | number \| null | no |   |
| `live.poll.overflows` | number \| null | no |   |
| `live.poll.pages_swept` | number \| null | no |   |
| `live.poll.rtt_ms` | object | no |   |
| `live.poll.skew_ms` | number \| null | no |   |
| `live.poll.sweeps` | object | no |   |
| `live.poll.sweeps_abandoned` | number \| null | no |   |
| `live.poll.sweeps_exhausted` | number \| null | no |   |
| `live.poll.uncovered` | array of object | no | Spans of SEC's list a sweep could not cover (the nightly feed covers those filings); at most 50. |
| `live.poll.uncovered[].at` | date-time (RFC 3339, UTC) \| null | no |   |
| `live.poll.uncovered[].from` | date-time (RFC 3339, UTC) \| null | no |   |
| `live.poll.uncovered[].reason` | string \| null | no | One of: `max_start`, `page_unanswered`, `null`. |
| `live.poll.uncovered[].until` | date-time (RFC 3339, UTC) \| null | no |   |
| `live.poll_interval_ms` | number \| null | no |   |
| `live.queue` | object | no | fetch_fresh, fetch_backlog, build, retry, oldest_age_s, behind_since. |
| `live.roles_unmapped` | integer | no | Role strings of SEC's list that have no v3 role (how many, not which). |
| `live.schema` | number \| null | no |   |
| `live.started_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `live.state` | string \| null | no | One of: `ok`, `idle`, `catching_up`, `paused`, `cautious`, `sec_unreachable`, `db_down`, `disk_low`, `halted`, `stopping`, `stopped`, `failed`, `null`. |
| `live.window_open` | boolean \| null | no |   |
| `live_check` | string | no | As checks.live of /v3/health. One of: `ok`, `paused`, `degraded`, `down`, `disabled`. |
| `snapshot` | object | yes | The snapshot store and the snapshot it serves. |
| `snapshot.accessions` | integer \| null | no | Distinct filings in the snapshot. |
| `snapshot.age_days` | integer \| null | no |   |
| `snapshot.available` | boolean | no |   |
| `snapshot.date` | date (YYYY-MM-DD) \| null | no |   |
| `snapshot.fallback` | boolean \| null | no | A newer snapshot exists but could not be loaded. |
| `snapshot.filers` | integer \| null | no |   |
| `snapshot.filings` | integer \| null | no | Filing listings in the snapshot (a filing listed by two filers counts twice). |
| `snapshot.loaded_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `snapshot.reloading` | boolean \| null | no | A newer snapshot is being loaded; the current one keeps serving. |
| `snapshot.stale` | boolean \| null | no | The snapshot is more than 3 days old. |
| `snapshot.state` | string | no | One of: `ok`, `stale`, `loading`, `unavailable`, `disabled`. |
| `snapshot.tickers_date` | date (YYYY-MM-DD) \| null | no | Newest copy of SEC's ticker file. |
| `snapshot.tickers_from` | date (YYYY-MM-DD) \| null | no | Oldest copy kept. |
| `totals` | object | yes | Table-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_stored` | integer | no | Filings with an acceptance time stored in v3 (any source: a header time, or SEC's from the snapshot sync). |
| `totals.amendments` | integer | no | Amendments, deleted ones excluded. |
| `totals.amendments_resolved` | integer | no | Of those amendments, the ones linked to their original. |
| `totals.computed_at` | date-time (RFC 3339, UTC) | no | When the totals were computed, UTC. |
| `totals.deleted_filings` | integer | no |   |
| `totals.documents` | integer | no |   |
| `totals.filings` | integer | no |   |
| `totals.max_feed_date` | date (YYYY-MM-DD) \| null | no |   |
| `totals.max_filing_date` | date (YYYY-MM-DD) \| null | no |   |
| `totals.min_feed_date` | date (YYYY-MM-DD) \| null | no |   |
| `totals.min_filing_date` | date (YYYY-MM-DD) \| null | no |   |
| `truncated` | boolean | yes | True when the window holds more feed days than max_days: the older ones are left out. Ask for them with from / to. |
| `window` | object | yes | The window of feed days this answer covers. |
| `window.default` | boolean | no | True when neither from nor to was given: the last 90 feed days. |
| `window.from` | date (YYYY-MM-DD) \| null | no | The from that was asked for; without one, the oldest day listed (null when no day is listed). |
| `window.max_days` | integer | no | The most days one answer lists: 90 for the default window, 366 when from or to is given. |
| `window.to` | date (YYYY-MM-DD) \| null | no | The to that was asked for; without one, the newest day listed (null when no day is listed). |

## Schema: CoverageCount

| Field | Type | Required | Description |
|---|---|---|---|
| `as_of` | date-time (RFC 3339, UTC) | yes | When these figures were read, UTC (every few seconds; 5 by default). |
| `deleted` | integer | yes | Filings SEC deleted (status deleted), now. Not counted in filings; they are still served. |
| `documents` | integer | yes | Current 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. |
| `filings` | integer | yes | Filings 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_basis` | string | yes | What filings counts: final and provisional filings; deleted filings are not counted. One of: `final_and_provisional`. |
| `latest_accepted_at` | date-time (RFC 3339, UTC) \| null | yes | The newest SEC acceptance time of a filing that is not deleted. |
| `live` | object \| null | yes | Live 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_ms` | object | no | SEC's acceptance time to seen, milliseconds. |
| `live.accept_to_seen_ms.p50` | number \| null | no |   |
| `live.accept_to_seen_ms.p95` | number \| null | no |   |
| `live.check` | string | no | As checks.live of /v3/health. One of: `ok`, `paused`, `degraded`, `down`. |
| `live.n` | integer \| null | no | Filings whose documents live ingest stored that day. |
| `live.poll_interval_ms` | number \| null | no | The daemon's current interval between two polls of SEC's list. |
| `live.seen_to_documents_ms` | object | no | Seen to the filing's documents being stored and registered, milliseconds. |
| `live.seen_to_documents_ms.p50` | number \| null | no |   |
| `live.seen_to_documents_ms.p95` | number \| null | no |   |
| `live.seen_to_stored_ms` | object | no | Seen to the filing being registered in the database (from then on the API lists it, provisional), milliseconds. |
| `live.seen_to_stored_ms.p50` | number \| null | no |   |
| `live.seen_to_stored_ms.p95` | number \| null | no |   |
| `live.window` | string | no | The figures cover the daemon's current New York day. One of: `day`. |
| `live.window_open` | boolean \| null | no | The daemon is in its business-hours window (fast polling). |
| `provisional` | integer | yes | Filings registered by live ingest and not yet confirmed by SEC's nightly feed (status provisional), now. |
| `summary_computed_at` | date-time (RFC 3339, UTC) \| null | yes | computed_at of the /v3/coverage/summary counts these figures add to. |

## Schema: CoverageDay

| Field | Type | Required | Description |
|---|---|---|---|
| `day` | date (YYYY-MM-DD) | no |   |
| `filings` | integer | no | Filings whose feed_date is this day. |
| `finished_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `members_failed` | integer | no |   |
| `members_ok` | integer | no |   |
| `members_skipped` | integer | no |   |
| `members_total` | integer | no |   |
| `realtime` | object \| null | no | Live 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.documents` | integer | no | Filings whose documents were registered (on the day that happened, which can be the day after the filing was seen). |
| `realtime.failed` | integer | no | Filings whose documents could not be fetched; the feed supplies them. |
| `realtime.latency_ms` | object \| null | no | The 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.listed` | integer | no | Filings registered from their header (visible in the API). |
| `realtime.seen` | integer | no | Sightings in SEC's list of new filings. Not distinct filings: one in flight across a restart of the daemon is counted again. |
| `realtime.sessions` | integer | no | Sessions of the daemon that day (a restart starts a new one). The counts are summed over them. |
| `realtime.skipped` | integer | no | Sightings of filings v3 already had; every restart's catch-up adds to it. |
| `reconciliation` | object \| null | no | The newest complete reconcile run of the day (a later partial run does not replace it); null when the day has none. |
| `reconciliation.chains_deferred` | integer | no | Filings whose version chain was still waiting to be re-ordered with snapshot acceptance times when the run ended; 0 when none. |
| `reconciliation.finished_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `reconciliation.outcomes` | object | no | check 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_id` | integer | no |   |
| `reconciliation.status` | string | no | Both 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_id` | integer | no |   |
| `started_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `status` | string | no | One of: `running`, `complete`, `partial`, `source_invalid`, `failed`. |

## Schema: CoverageSummary

| Field | Type | Required | Description |
|---|---|---|---|
| `amendments` | object | yes | Amendment 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.ambiguous` | integer | no |   |
| `amendments.link_rate` | number \| null | no |   |
| `amendments.resolved` | integer | no |   |
| `amendments.target_not_public` | integer | no |   |
| `amendments.target_not_yet_ingested` | integer | no |   |
| `amendments.total` | integer | no |   |
| `amendments.unresolved` | integer | no |   |
| `before_1993` | object | yes | Filings 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.filings` | integer | no |   |
| `before_1993.first_year` | integer \| null | no | The earliest year counted; null when filings is 0. |
| `before_1993.paper` | integer | no | Paper filing records among filings (is_paper). |
| `by_year` | array of object | yes | Filings 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[].filings` | integer | no |   |
| `by_year[].paper` | integer | no | Paper filing records among filings (is_paper). |
| `by_year[].year` | integer | no |   |
| `by_year_basis` | string | yes | The date by_year groups by. One of: `filing_date`. |
| `callbacks` | object \| null | yes | Webhook delivery, computed with the counts. Null when this deployment has no webhook delivery. |
| `callbacks.computed_at` | date-time (RFC 3339, UTC) | no | When the callbacks block was computed, UTC. |
| `callbacks.latency` | object | no |   |
| `callbacks.latency.first_attempt_from_accepted` | object | no | Seconds 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.n` | integer | no |   |
| `callbacks.latency.first_attempt_from_accepted.p50` | number \| null | no | Null when n is 0. |
| `callbacks.latency.first_attempt_from_accepted.p95` | number \| null | no | Null when n is 0. |
| `computed_at` | date-time (RFC 3339, UTC) | yes | When the counts were computed, UTC. They are served until a later computation replaces them. |
| `document_versions` | integer | yes | Stored document versions, every delivery of every document. |
| `documents` | integer | yes | Current documents (one per document of each filing). |
| `feed_days` | object | yes | Feed days with a complete or partial ingest run (targeted repair runs not counted). |
| `feed_days.count` | integer | no |   |
| `feed_days.first` | date (YYYY-MM-DD) \| null | no |   |
| `feed_days.last` | date (YYYY-MM-DD) \| null | no |   |
| `filings` | object | yes | Filings in v3 by status; total counts every status. |
| `filings.deleted` | integer | no |   |
| `filings.final` | integer | no |   |
| `filings.provisional` | integer | no |   |
| `filings.total` | integer | no |   |
| `gaps` | object \| null | yes | Known 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. |
| `live` | object \| null | yes | Live 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.check` | string | no | As checks.live of /v3/health. One of: `ok`, `paused`, `degraded`, `down`. |
| `live.covered_until` | date-time (RFC 3339, UTC) \| null | no | SEC's list of new filings has been read without a gap up to here. |
| `live.last_new_filing_at` | date-time (RFC 3339, UTC) \| null | no | When the newest filing was first seen. |
| `live.median_lag_seconds` | integer \| null | no | Median 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.mode` | string \| null | no | One of: `live`, `dry_run`, `null`. |
| `live.state` | string \| null | no | The daemon's own state in its last heartbeat, as live.state of /v3/health without the dry_run substitution. |
| `stream` | object \| null | yes | The filing stream, computed with the counts. Null when this deployment has no stream. |
| `stream.computed_at` | date-time (RFC 3339, UTC) | no | When the stream block was computed, UTC. |
| `stream.head_seq` | integer \| null | no | The last stream seq the sequencer assigned; null before its first pass. |
| `stream.latency` | object | no |   |
| `stream.latency.from_accepted` | object | no | Seconds 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.n` | integer | no |   |
| `stream.latency.from_accepted.p50` | number \| null | no | Null when n is 0. |
| `stream.latency.from_accepted.p95` | number \| null | no | Null when n is 0. |

## Schema: Dataset

| Field | Type | Required | Description |
|---|---|---|---|
| `coverage` | object | no | A range, not a statement that every filing in it is parsed. |
| `coverage.basis` | string | no |   |
| `coverage.from` | date (YYYY-MM-DD) \| null | no |   |
| `coverage.to` | date (YYYY-MM-DD) \| null | no |   |
| `dataset` | string | no |   |
| `derive_steps` | array of object | no |   |
| `derive_steps[].step` | string | no |   |
| `derive_steps[].version` | string | no |   |
| `description` | string \| null | no |   |
| `extractor` | string | no |   |
| `filings` | object | no | Only when the server is configured to publish it (owner default: off). |
| `filings.by_status` | object | no |   |
| `filings.total` | integer | no |   |
| `forms` | array of string | no |   |
| `latest_parsed_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `links` | object | no |   |
| `queue` | object | no | The 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.failed` | integer | no |   |
| `queue.oldest_queued_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `queue.queued` | integer | no |   |
| `rows_estimated` | object | no | Estimated rows per table (the planner's statistics); null when never analysed. |
| `status` | string | no | One of: `available`, `in_preparation`. |
| `tables` | array of string | no |   |
| `version` | string | no | The deployed extractor version. |

## Schema: DatasetList

| Field | Type | Required | Description |
|---|---|---|---|
| `computed_at` | date-time (RFC 3339, UTC) | yes |   |
| `data` | array of [Dataset](#schema-dataset) | yes |   |
| `has_more` | boolean | yes |   |
| `next_cursor` | string \| null | yes |   |

## Schema: DocTableCell

| Field | Type | Required | Description |
|---|---|---|---|
| `col` | integer | no |   |
| `col_span` | integer | no |   |
| `currency` | string \| null | no |   |
| `dash` | boolean | no |   |
| `fact_ids` | array of string | no |   |
| `footnotes` | array of string | no |   |
| `header` | boolean | no |   |
| `id` | string | no |   |
| `negative` | boolean | no |   |
| `numeric` | boolean | no |   |
| `percent` | boolean | no |   |
| `punctuation` | boolean | no |   |
| `row` | integer | no |   |
| `row_span` | integer | no |   |
| `scale` | integer \| null | no | The power of ten that applies to this value (0 for per-share amounts and percents). |
| `span_end` | integer | no |   |
| `span_start` | integer | no |   |
| `text` | string | no |   |
| `text_end` | integer | no |   |
| `text_start` | integer | no |   |
| `value` | string \| null | no | The number as displayed (Decimal string, sign applied, not scaled). |
| `value_raw` | string \| null | no |   |

## Schema: DocTableOutline

| Field | Type | Required | Description |
|---|---|---|---|
| `block_id` | string | no |   |
| `block_ordinal` | integer | no |   |
| `caption` | string \| null | no |   |
| `column_headers` | array of string | no |   |
| `extractor_version` | string | no |   |
| `fact_cells` | integer | no |   |
| `header_rows` | integer | no |   |
| `kind` | string | no | One of: `data`, `layout`. |
| `kind_reason` | string | no | One of: `values`, `too_small`, `few_values`, `text`, `contents`. |
| `n_cols` | integer | no |   |
| `n_rows` | integer | no |   |
| `page` | integer | no |   |
| `per_share_except` | boolean | no |   |
| `scale` | integer \| null | no | The power of ten the table states (in thousands: 3); null when it states none. |
| `scale_source` | string \| null | no | One of: `header`, `caption`, `continued`, `document`, `null`. |
| `scale_text` | string \| null | no |   |
| `span_end` | integer | no |   |
| `span_start` | integer | no |   |
| `text_cells` | integer | no |   |
| `text_end` | integer | no |   |
| `text_start` | integer | no |   |
| `value_cells` | integer | no |   |

## Schema: DocTables

| Field | Type | Required | Description |
|---|---|---|---|
| `accession` | string | no |   |
| `cells` | array of [DocTableCell](#schema-doctablecell) \| null | no |   |
| `cells_reason` | string \| null | no | One of: `model_changed`, `bytes_unavailable`, `rules_changed`, `null`. |
| `cells_status` | string | no | One of: `current`, `from_version`, `reparse_pending`. |
| `data` | array of [DocTableOutline](#schema-doctableoutline) | no |   |
| `document` | object \| null | no |   |
| `extraction` | object | no |   |
| `filing` | [FilingRef](#schema-filingref) | no |   |
| `has_more` | boolean | no |   |
| `next_cursor` | string \| null | no |   |
| `rules_version` | string | no |   |
| `table` | [DocTableOutline](#schema-doctableoutline) | no |   |

## Schema: Document

| Field | Type | Required | Description |
|---|---|---|---|
| `decode_status` | string | no | One of: `ok`, `repaired`, `failed`. |
| `description` | string \| null | no |   |
| `encoding` | string | no | One of: `text`, `uu`, `base64`. |
| `filename` | string | no |   |
| `is_primary` | boolean | no |   |
| `mime` | string | no |   |
| `seq` | integer | no |   |
| `sha256` | string \| null | no | Hex SHA-256 of the stored bytes; also the ETag. |
| `size_bytes` | integer \| null | no |   |
| `type` | string | no |   |
| `url` | string | no |   |

## Schema: DocumentList

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | array of [Document](#schema-document) | yes |   |
| `has_more` | boolean | no |   |
| `next_cursor` | string \| null | no |   |

## Schema: EightKEvent

| Field | Type | Required | Description |
|---|---|---|---|
| `confidence` | number | no |   |
| `event_no` | integer | no |   |
| `event_type` | string | no |   |
| `exhibits` | array of object | no |   |
| `exhibits[].doc_seq` | integer \| null | no |   |
| `exhibits[].number` | string | no |   |
| `exhibits[].type` | string \| null | no |   |
| `exhibits[].url` | string \| null | no |   |
| `extracted_at` | string | no |   |
| `extractor_version` | string | no |   |
| `fields` | array of [EightKEventField](#schema-eightkeventfield) | no |   |
| `flags` | array of string | no |   |
| `item_code` | string | no |   |
| `item_text_end` | integer | no |   |
| `item_text_start` | integer | no |   |
| `rules` | string | no |   |
| `rules_version` | string | no |   |

## Schema: EightKEventField

| Field | Type | Required | Description |
|---|---|---|---|
| `confidence` | number | no | rule confidence |
| `doc_seq` | integer | no |   |
| `fiscal_year_end` | string | no | 2.02 period_kind from the fiscal calendar: the fiscal year end used, --MM-DD. |
| `fiscal_year_end_source` | string | no | One of: `xbrl`, `sec_header`. |
| `name` | string | no |   |
| `period_kind_source` | string | no | 2.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_id` | string | no |   |
| `span_end` | integer | no |   |
| `span_exact` | boolean | no | True: span_start..span_end are exactly the filed characters; false: the enclosing element. |
| `span_start` | integer | no |   |
| `text_end` | integer | no |   |
| `text_start` | integer | no |   |
| `value` | any | no | Typed by value_type: a string, an array of strings, YYYY-MM-DD, a boolean, or a Decimal string for a number. |
| `value_as_found` | string | no | The filed characters the value was read from. |
| `value_type` | string | no | One of: `text`, `text_list`, `date`, `boolean`, `number`. |

## Schema: EightKEventList

| Field | Type | Required | Description |
|---|---|---|---|
| `accuracy` | object | no | Items 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_of` | string \| null | no |   |
| `data` | array of object | no |   |
| `data[].events` | array of [EightKEvent](#schema-eightkevent) | no |   |
| `data[].filing` | [FilingRef](#schema-filingref) | no |   |
| `data[].item_code` | string | no |   |
| `data[].links` | object | no |   |
| `has_more` | boolean | no |   |
| `item` | string | no |   |
| `next_cursor` | string \| null | no |   |
| `snapshot` | object | no |   |

## Schema: EightKExhibit

| Field | Type | Required | Description |
|---|---|---|---|
| `block_id` | string | no |   |
| `confidence` | number \| null | no |   |
| `description` | string \| null | no |   |
| `found_in` | string | no |   |
| `item_code` | string \| null | no |   |
| `link_href` | string \| null | no |   |
| `number_as_filed` | string | no |   |
| `row_no` | integer | no |   |
| `span_end` | integer | no |   |
| `span_start` | integer | no |   |

## Schema: EightKFiling

| Field | Type | Required | Description |
|---|---|---|---|
| `accession` | string | no |   |
| `document` | object \| null | no |   |
| `exhibits` | array of [EightKExhibit](#schema-eightkexhibit) | no |   |
| `extraction` | [Extraction](#schema-extraction) | no |   |
| `filing` | [FilingRef](#schema-filingref) | no |   |
| `header_body_agree` | boolean \| null | no |   |
| `item_sets` | object \| null | no |   |
| `item_sets.body` | array of any | no |   |
| `item_sets.header` | array of any | no |   |
| `item_sets.union` | array of any | no |   |
| `items` | array of [EightKItem](#schema-eightkitem) | no |   |
| `links` | object | no |   |
| `mismatch_kind` | string \| null | no | One of: `none`, `header_omits_901`, `differs`, `null`. |
| `snapshot` | [Snapshot](#schema-snapshot) | no |   |

## Schema: EightKItem

| Field | Type | Required | Description |
|---|---|---|---|
| `body_status` | string | no | One of: `heading`, `combined_heading`, `not_applicable`, `not_found`. |
| `confidence` | number \| null | no | Rule confidence by heading kind (not a probability). |
| `flags` | array of string | no |   |
| `in_body` | boolean | no |   |
| `in_header` | boolean | no |   |
| `item_code` | string | no |   |
| `item_legacy` | string \| null | no |   |
| `links` | object | no |   |
| `mapping` | string | no | One of: `none`, `legacy_2004`. |
| `section` | string | no |   |
| `source` | string | no | One of: `header`, `body`, `both`. |
| `span_end` | integer \| null | no |   |
| `span_start` | integer \| null | no |   |
| `text_end` | integer \| null | no |   |
| `text_start` | integer \| null | no |   |
| `title` | string \| null | no |   |

## Schema: EightKItemSearchList

| Field | Type | Required | Description |
|---|---|---|---|
| `as_of` | string \| null | no |   |
| `data` | array of object | no |   |
| `data[].filing` | [FilingRef](#schema-filingref) | no |   |
| `data[].item` | [EightKItem](#schema-eightkitem) | no |   |
| `data[].links` | object | no |   |
| `data[].mismatch_kind` | string | no |   |
| `has_more` | boolean | no |   |
| `item` | string | no |   |
| `next_cursor` | string \| null | no |   |
| `snapshot` | [Snapshot](#schema-snapshot) | no |   |

## 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}.

| Field | Type | Required | Description |
|---|---|---|---|
| `addresses` | [Addresses](#schema-addresses) | no |   |
| `as_of` | object \| null | no | The filing the as-filed attributes come from; null when v3 has no filing for the CIK. |
| `as_of.accession` | string | no |   |
| `as_of.filing_date` | date (YYYY-MM-DD) | no |   |
| `as_of.role` | string | no |   |
| `cik` | string | no |   |
| `current` | [EntityCurrent](#schema-entitycurrent) | no |   |
| `data` | null | no | Present (null) only in the {cik, data, snapshot} body described above. |
| `filings` | integer | no | Filings in v3 that name the entity. |
| `first_filing_date` | date (YYYY-MM-DD) \| null | no |   |
| `fiscal_year_end` | string \| null | no |   |
| `former_names` | array of object | no |   |
| `irs_number` | string \| null | no |   |
| `last_filing_date` | date (YYYY-MM-DD) \| null | no |   |
| `links` | object | no |   |
| `links.filings` | string | no |   |
| `links.sec_filings` | string | no |   |
| `links.self` | string | no |   |
| `name` | string \| null | no |   |
| `role_counts` | object | no |   |
| `roles` | array of string | no |   |
| `sic` | string \| null | no |   |
| `snapshot` | [Snapshot](#schema-snapshot) | no |   |
| `spac` | [Spac](#schema-spac) | no |   |
| `state_of_inc` | string \| null | no |   |

## Schema: EntityCurrent

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

| Field | Type | Required | Description |
|---|---|---|---|
| `addresses` | [Addresses](#schema-addresses) | no |   |
| `category` | string \| null | no |   |
| `cik` | string | no |   |
| `ein` | string \| null | no |   |
| `entity_type` | string \| null | no |   |
| `exchanges` | array of string | no |   |
| `filings` | integer | no | Filings in SEC's list for the entity. |
| `first_filing_date` | date (YYYY-MM-DD) \| null | no |   |
| `fiscal_year_end` | string \| null | no |   |
| `flags` | string \| null | no |   |
| `former_names` | array of object | no |   |
| `last_filing_date` | date (YYYY-MM-DD) \| null | no |   |
| `lei` | string \| null | no |   |
| `listed` | array of object | no | The entity's rows in SEC's ticker file: {ticker, exchange}. |
| `listed_as_of` | date (YYYY-MM-DD) \| null | no |   |
| `name` | string | no |   |
| `phone` | string \| null | no |   |
| `sic` | string \| null | no |   |
| `sic_description` | string \| null | no |   |
| `state_of_inc` | string \| null | no |   |
| `ticker_exchanges` | array of object | no |   |
| `tickers` | array of string | no |   |

## Schema: EntityList

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | array of [EntityMatch](#schema-entitymatch) | yes |   |
| `has_more` | boolean | no |   |
| `next_cursor` | string \| null | no |   |
| `snapshot` | [Snapshot](#schema-snapshot) | yes | available is true when the snapshot was searched; false when the list is names as filed. |

## Schema: EntityMatch

| Field | Type | Required | Description |
|---|---|---|---|
| `cik` | string | no |   |
| `filings` | integer | no | Filings in v3 that name the entity. |
| `matched` | string | no | What the query matched. Snapshot search results only. One of: `cik`, `ticker`, `name`, `former_name`. |
| `name` | string \| null | no | SEC's current name (snapshot search) or the most recent name as filed. |
| `sec_filings` | integer | no | Filings in SEC's list for the entity. Snapshot search results only. |
| `tickers` | array of string | no | Snapshot search results only. |

## Schema: Event

| Field | Type | Required | Description |
|---|---|---|---|
| `at` | date-time (RFC 3339, UTC) | no |   |
| `details` | object | no |   |
| `event` | string | no |   |
| `seq` | integer | no |   |
| `source` | string | no |   |

## Schema: EventList

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | array of [Event](#schema-event) | yes |   |
| `has_more` | boolean | no |   |
| `next_cursor` | string \| null | no |   |

## 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).

| Field | Type | Required | Description |
|---|---|---|---|
| `active_version` | string | yes | The version the deployed parser runs. |
| `dataset` | string | yes | 13f, 8k_items, sections. |
| `extractor` | string | yes |   |
| `first_parsed_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `method` | string \| null | no | One of: `header`, `xml`, `xbrl`, `table`, `rule`, `null`. |
| `parsed_at` | date-time (RFC 3339, UTC) \| null | no | The last write of the result. |
| `reparse` | object \| null | yes | A parse of the deployed version queued, running or given up while a result stands; null otherwise. |
| `reparse.attempts` | integer \| null | no |   |
| `reparse.queued_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `reparse.state` | string | no | One of: `queued`, `running`, `failed`. |
| `reparse.version` | string | no |   |
| `rows_stale` | boolean | no | A later parse could not read the filing and left the rows of an earlier good parse in place. |
| `status` | string | yes | One of: `ok`, `ok_with_warnings`, `partial`, `unparseable`, `not_applicable`, `pending`, `failed`, `not_parsed`. |
| `version` | string \| null | yes | The extractor version that last verified the filing; null without a result. |
| `warnings` | array of [ParseWarning](#schema-parsewarning) | yes | At most 100, in order. |
| `warnings_total` | integer | yes |   |
| `warnings_truncated` | boolean | yes |   |

## Schema: F13fCover

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

| Field | Type | Required | Description |
|---|---|---|---|
| `amendment_no` | integer \| null | no |   |
| `amendment_type` | string \| null | no |   |
| `confidence` | number \| null | no | Rule confidence (not a probability). |
| `is_amendment` | boolean | no |   |
| `manager_address` | object \| null | no |   |
| `manager_address.city` | any | no |   |
| `manager_address.state_or_country` | any | no |   |
| `manager_address.zip_code` | any | no |   |
| `manager_cik` | string | no |   |
| `manager_name` | string \| null | no |   |
| `period` | date (YYYY-MM-DD) \| null | no |   |
| `report_type` | string \| null | no |   |
| `signature` | object \| null | no |   |
| `signature.city` | any | no |   |
| `signature.name` | any | no |   |
| `signature.signature` | any | no |   |
| `signature.signature_date` | any | no |   |
| `signature.state_or_country` | any | no |   |
| `signature.title` | any | no |   |

## Schema: F13fEffectiveHoldingList

| Field | Type | Required | Description |
|---|---|---|---|
| `as_of` | string \| null | no |   |
| `confidential_omitted` | boolean | no |   |
| `data` | array of [F13fHolding](#schema-f13fholding) + object | no |   |
| `effective` | object | no |   |
| `effective.reported_13f_long_value_usd` | [NullableDecimal](#schema-nullabledecimal) | no |   |
| `effective.rows` | integer \| null | no |   |
| `excluded` | [Excluded](#schema-excluded) | no | view=effective only. |
| `excluded_total` | integer | no | view=effective only. |
| `has_more` | boolean | no |   |
| `has_notice` | boolean | no |   |
| `ledger` | array of [LedgerStep](#schema-ledgerstep) | no |   |
| `limits` | [F13fLimits](#schema-f13flimits) | no |   |
| `manager_cik` | string | no |   |
| `next_cursor` | string \| null | no |   |
| `period` | date (YYYY-MM-DD) | no |   |
| `rebuild_pending` | boolean | no | A member filing was deleted since the group was built: its rows are not served and the total is null until the rebuild. |
| `view` | string | no | One of: `effective`, `as_filed`. |

## Schema: F13fFiling

| Field | Type | Required | Description |
|---|---|---|---|
| `accession` | string | no |   |
| `cover` | [F13fCover](#schema-f13fcover) | no |   |
| `extraction` | [Extraction](#schema-extraction) | no |   |
| `filing` | [FilingRef](#schema-filingref) | no |   |
| `ledger` | any | no |   |
| `links` | object | no |   |
| `other_managers` | object | no |   |
| `other_managers.included` | array of [F13fOtherManager](#schema-f13fothermanager) | no |   |
| `other_managers.reporting_for_filer` | array of [F13fOtherManager](#schema-f13fothermanager) | no |   |
| `snapshot` | [Snapshot](#schema-snapshot) | no |   |
| `summary` | [F13fSummary](#schema-f13fsummary) | no |   |
| `value_unit` | [ValueUnit](#schema-valueunit) | no |   |

## Schema: F13fHolderList

| Field | Type | Required | Description |
|---|---|---|---|
| `as_of` | string \| null | no |   |
| `cusip` | string | no |   |
| `data` | array of [F13fHolding](#schema-f13fholding) + object | no |   |
| `excluded` | [Excluded](#schema-excluded) | no |   |
| `excluded_total` | integer | no |   |
| `has_more` | boolean | no |   |
| `limits` | [F13fLimits](#schema-f13flimits) | no |   |
| `next_cursor` | string \| null | no |   |
| `period` | date (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).

| Field | Type | Required | Description |
|---|---|---|---|
| `accession` | string | no |   |
| `amount_type` | string \| null | no |   |
| `confidence` | number \| null | no |   |
| `cusip` | string \| null | no |   |
| `cusip_raw` | string \| null | no |   |
| `cusip_status` | string | no |   |
| `flags` | array of string | no |   |
| `name_of_issuer` | string \| null | no |   |
| `observed_in` | string | no |   |
| `put_call` | string \| null | no |   |
| `row_id` | string | no |   |
| `row_no` | integer | no |   |
| `shares_or_principal` | [NullableDecimal](#schema-nullabledecimal) | no |   |
| `title_of_class` | string \| null | no |   |
| `value_raw` | string \| null | no |   |
| `value_reported` | [NullableDecimal](#schema-nullabledecimal) | no |   |
| `value_usd` | [NullableDecimal](#schema-nullabledecimal) | no |   |

## Schema: F13fHoldingList

| Field | Type | Required | Description |
|---|---|---|---|
| `accession` | string | no |   |
| `data` | array of [F13fHolding](#schema-f13fholding) | no |   |
| `extraction` | [Extraction](#schema-extraction) | no |   |
| `filing` | [FilingRef](#schema-filingref) | no |   |
| `has_more` | boolean | no |   |
| `next_cursor` | string \| null | no |   |
| `snapshot` | [Snapshot](#schema-snapshot) | no |   |
| `value_unit` | [ValueUnit](#schema-valueunit) | no |   |

## 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

| Field | Type | Required | Description |
|---|---|---|---|
| `base_accession` | string \| null | no |   |
| `computed_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `confidential_omitted` | boolean | no |   |
| `derive_version` | string | no |   |
| `flags` | array of string | no |   |
| `has_notice` | boolean | no |   |
| `latest` | object | no |   |
| `latest.accepted_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `latest.accepted_at_source` | string \| null | no |   |
| `latest.accession` | string | no |   |
| `latest.filing_date` | date (YYYY-MM-DD) | no |   |
| `links` | object | no |   |
| `manager_cik` | string | no |   |
| `period` | date (YYYY-MM-DD) | no |   |
| `rebuild_pending` | boolean | no | A member filing was deleted since the group was built: the total is null until the rebuild. |
| `report_type` | string \| null | no |   |
| `reported_13f_long_value_usd` | [NullableDecimal](#schema-nullabledecimal) | no |   |
| `rows_effective` | integer | no |   |
| `steps` | integer | no |   |
| `unit_flags` | array of string | no |   |

## Schema: F13fManagerPeriodList

| Field | Type | Required | Description |
|---|---|---|---|
| `as_of` | string \| null | no |   |
| `data` | array of [F13fManagerPeriod](#schema-f13fmanagerperiod) | no |   |
| `excluded` | [Excluded](#schema-excluded) | no |   |
| `excluded_total` | integer | no |   |
| `has_more` | boolean | no |   |
| `limits` | [F13fLimits](#schema-f13flimits) | no |   |
| `manager_cik` | string | no |   |
| `next_cursor` | string \| null | no |   |

## Schema: F13fOtherManager

| Field | Type | Required | Description |
|---|---|---|---|
| `cik` | string \| null | no |   |
| `cik_raw` | string \| null | no |   |
| `form13f_file_number` | string \| null | no |   |
| `name` | string \| null | no |   |
| `row_no` | integer | no |   |
| `sequence_number` | integer \| null | no |   |

## Schema: F13fSummary

| Field | Type | Required | Description |
|---|---|---|---|
| `rows_parsed` | integer \| null | no |   |
| `table_entry_total` | integer \| null | no |   |
| `table_value_total` | [NullableDecimal](#schema-nullabledecimal) | no |   |
| `value_sum_reported` | [NullableDecimal](#schema-nullabledecimal) | no |   |

## Schema: F144Filing

| Field | Type | Required | Description |
|---|---|---|---|
| `accession` | string | no |   |
| `chain` | object \| null | no |   |
| `extraction` | [Extraction](#schema-extraction) | no |   |
| `filing` | [FilingRef](#schema-filingref) | no |   |
| `header_entities` | array of object | no |   |
| `limits` | array of string | no |   |
| `notice` | [F144Notice](#schema-f144notice) | no |   |
| `snapshot` | [Snapshot](#schema-snapshot) | no |   |

## Schema: F144Notice

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

| Field | Type | Required | Description |
|---|---|---|---|
| `accession` | string | no |   |
| `acquisitions` | array of object | no |   |
| `flags` | array of string | no |   |
| `form_type` | string | no |   |
| `issuer` | object | no |   |
| `nothing_sold_past_3_months` | boolean \| null | no |   |
| `notice_date` | string \| null | no |   |
| `plan_adoption_dates` | array of string \| null | no |   |
| `previous_accession` | string \| null | no |   |
| `sales_past_3_months` | array of object | no |   |
| `securities` | array of object | no |   |
| `seller` | object | no |   |

## 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.

| Field | Type | Required | Description |
|---|---|---|---|
| `category` | string | yes | bug: 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`. |
| `client` | object \| null | no | The client program, e.g. the MCP client's name and version from its initialize request. |
| `client.name` | string | yes |   |
| `client.version` | string \| null | no |   |
| `context` | object \| null | no | Details such as accession, query and request_id: a JSON object of at most 16 KB as compact JSON. |
| `message` | string | yes | What happened and what was expected: 1 to 4,000 characters after trimming, no NUL. |
| `source` | string | no | Where the feedback comes from; the MCP server sends mcp. One of: `api`, `mcp`. |
| `tool` | string \| null | no | The MCP tool or API route the feedback is about (at most 100 bytes). |

## Schema: FeedbackCreated

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | integer (int64) | yes | The feedback's id. |

## Schema: Filing

| Field | Type | Required | Description |
|---|---|---|---|
| `accepted_at` | date-time (RFC 3339, UTC) \| null | no | The 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_snapshot` | date-time (RFC 3339, UTC) | no | Present only when SEC's submissions value differs from accepted_at (at whole seconds): SEC's value as given. |
| `accepted_at_source` | string \| null | no | realtime / 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`. |
| `accession` | string | yes |   |
| `base_form` | string | yes |   |
| `deleted_at` | date-time (RFC 3339, UTC) \| null | no | When 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_count` | integer | no |   |
| `feed_date` | date (YYYY-MM-DD) \| null | no |   |
| `filing_date` | date (YYYY-MM-DD) | yes |   |
| `first_seen_at` | date-time (RFC 3339, UTC) \| null | no | When 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_type` | string | yes | Form type as filed. |
| `header_in_file` | boolean | no | Single 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_amendment` | boolean | yes |   |
| `is_inline_xbrl` | boolean \| null | no | SEC's isInlineXBRL; null as is_xbrl. |
| `is_xbrl` | boolean \| null | no | SEC's isXBRL; null when SEC does not say or the snapshot sync has not seen the filing. |
| `items` | array of string | no |   |
| `items_unmapped` | array of string | no | Item descriptions of the header that have no item code yet. In lists only when there are any; always on the single filing. |
| `links` | object | yes |   |
| `links.documents` | string | no |   |
| `links.events` | string | no |   |
| `links.header` | string \| null | no | null when header_in_file is false (single filing). |
| `links.self` | string | no |   |
| `period_of_report` | date (YYYY-MM-DD) \| null | no | SEC's reportDate (submissions snapshot) when it gives one, otherwise the value in the filing's header. |
| `period_of_report_header` | date (YYYY-MM-DD) \| null | no | Single filing only, and only when SEC's reportDate replaced a different header period: the header's (null: the header has none). |
| `period_of_report_source` | string \| null | no | One of: `submissions`, `header`, `null`. |
| `primary_cik` | string | yes |   |
| `primary_name` | string \| null | no | Name of the primary entity as filed (header_in_file false: the name SEC's submissions index gives for the filing date, or null). |
| `provisional` | boolean | no | status == provisional. |
| `sec_items` | array of string \| null | no | SEC's 8-K items list (items is the header's); null when the snapshot sync has not seen the filing. |
| `sec_primary_doc_description` | string \| null | no | Single filing only: SEC's primaryDocDescription. |
| `sec_primary_document` | string \| null | no | SEC's primaryDocument (file name). |
| `sec_url` | string (URI) | yes |   |
| `snapshot_date` | date (YYYY-MM-DD) \| null | no | Single filing only: the snapshot whose values were last written to the filing; null when none was. |
| `source` | string | no | realtime: registered by live ingest; it becomes feed when the nightly feed delivers the filing. One of: `feed`, `oldload`, `archives`, `realtime`. |
| `status` | string | yes | provisional: 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_bytes` | integer | no |   |

## Schema: FilingDetail

| Field | Type | Required | Description |
|---|---|---|---|
| `accepted_at` | date-time (RFC 3339, UTC) \| null | no | The 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_snapshot` | date-time (RFC 3339, UTC) | no | Present only when SEC's submissions value differs from accepted_at (at whole seconds): SEC's value as given. |
| `accepted_at_source` | string \| null | no | realtime / 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`. |
| `accession` | string | yes |   |
| `base_form` | string | yes |   |
| `deleted_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `doc_count` | integer | no |   |
| `feed_date` | date (YYYY-MM-DD) \| null | no |   |
| `filing_date` | date (YYYY-MM-DD) | yes |   |
| `first_seen_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `form_type` | string | yes | Form type as filed. |
| `header_in_file` | boolean | no | Single 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_amendment` | boolean | yes |   |
| `is_inline_xbrl` | boolean \| null | no | SEC's isInlineXBRL; null as is_xbrl. |
| `is_xbrl` | boolean \| null | no | SEC's isXBRL; null when SEC does not say or the snapshot sync has not seen the filing. |
| `items` | array of string | no |   |
| `items_unmapped` | array of string | no |   |
| `links` | object | yes |   |
| `links.documents` | string | no |   |
| `links.events` | string | no |   |
| `links.header` | string \| null | no | null when header_in_file is false (single filing). |
| `links.self` | string | no |   |
| `period_of_report` | date (YYYY-MM-DD) \| null | no | SEC's reportDate (submissions snapshot) when it gives one, otherwise the value in the filing's header. |
| `period_of_report_header` | date (YYYY-MM-DD) \| null | no | Single filing only, and only when SEC's reportDate replaced a different header period: the header's (null: the header has none). |
| `period_of_report_source` | string \| null | no | One of: `submissions`, `header`, `null`. |
| `primary_cik` | string | yes |   |
| `primary_name` | string \| null | no | Name of the primary entity as filed (header_in_file false: the name SEC's submissions index gives for the filing date, or null). |
| `provisional` | boolean | no | status == provisional. |
| `sec_items` | array of string \| null | no | SEC's 8-K items list (items is the header's); null when the snapshot sync has not seen the filing. |
| `sec_primary_doc_description` | string \| null | no | Single filing only: SEC's primaryDocDescription. |
| `sec_primary_document` | string \| null | no | SEC's primaryDocument (file name). |
| `sec_url` | string (URI) | yes |   |
| `snapshot_date` | date (YYYY-MM-DD) \| null | no | Single filing only: the snapshot whose values were last written to the filing; null when none was. |
| `source` | string | no | realtime: registered by live ingest; it becomes feed when the nightly feed delivers the filing. One of: `feed`, `oldload`, `archives`, `realtime`. |
| `status` | string | yes | provisional: 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_bytes` | integer | no |   |
| `date_of_change` | date (YYYY-MM-DD) \| null | no |   |
| `deleted` | boolean | no | status == deleted. |
| `deletion` | object \| null | no | Only for a deleted filing (null otherwise): where the deletion came from. SEC's DELETION notice gives no reason. |
| `deletion.feed_date` | date (YYYY-MM-DD) \| null | no | The feed day whose archive held the notice. |
| `deletion.notice` | string \| null | no | The notice member, \<archive\>#\<member\>. |
| `deletion.recorded_at` | date-time (RFC 3339, UTC) \| null | no | When v3 registered the deletion. |
| `deletion.source` | string \| null | no | Where 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. |
| `documents` | array of [Document](#schema-document) | no |   |
| `effectiveness_date` | date (YYYY-MM-DD) \| null | no |   |
| `entities` | array of [FilingEntity](#schema-filingentity) | no |   |
| `events` | array of [Event](#schema-event) | no |   |
| `finalized_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `is_correction` | boolean | no |   |
| `is_paper` | boolean | no |   |
| `is_private_release` | boolean | no |   |
| `live` | object | no | Only while the filing is provisional and its source is realtime: where live ingest is with it. Gone once the filing is final. |
| `live.documents_at` | date-time (RFC 3339, UTC) \| null | no | When its documents were registered; null until then. |
| `live.listed_at` | date-time (RFC 3339, UTC) \| null | no | When the filing was listed. |
| `live.state` | string | no | listed: 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_accession` | string \| null | no |   |
| `released_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `snapshot` | [Snapshot](#schema-snapshot) | no |   |
| `versions` | [Versions](#schema-versions) | no |   |

## Schema: FilingEntity

| Field | Type | Required | Description |
|---|---|---|---|
| `addresses` | [Addresses](#schema-addresses) | no |   |
| `cik` | string | no |   |
| `file_number` | string \| null | no |   |
| `film_number` | string \| null | no |   |
| `fiscal_year_end` | string \| null | no |   |
| `name` | string \| null | no |   |
| `role` | string | no | One of: `filer`, `subject`, `filed_by`, `filed_for`, `reporting_owner`, `issuer`, `depositor`, `securitizer`, `issuing_entity`, `underwriter`, `serial_company`. |
| `sic` | string \| null | no |   |
| `state_of_inc` | string \| null | no |   |

## Schema: FilingList

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | array of [Filing](#schema-filing) | yes |   |
| `has_more` | boolean | yes | True when another page follows (pages are complete for every sort). |
| `next_cursor` | string \| null | yes |   |
| `snapshot` | [Snapshot](#schema-snapshot) | yes |   |

## Schema: FilingRef

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

| Field | Type | Required | Description |
|---|---|---|---|
| `accepted_at` | date-time (RFC 3339, UTC) \| null | no | The 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_source` | string \| null | no | realtime / 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`. |
| `accession` | string | no |   |
| `base_form` | string | no |   |
| `deleted` | boolean | no | status == deleted. |
| `deleted_at` | date-time (RFC 3339, UTC) \| null | no | When 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. |
| `deletion` | object \| null | no | Per-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_date` | date (YYYY-MM-DD) \| null | no | The feed day whose archive held the notice. |
| `deletion.notice` | string \| null | no | The notice member, \<archive\>#\<member\>. |
| `deletion.recorded_at` | date-time (RFC 3339, UTC) \| null | no | When v3 registered the deletion. |
| `deletion.source` | string \| null | no | Where 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_date` | date (YYYY-MM-DD) | no |   |
| `form_type` | string | no | Form type as filed. |
| `links` | object | no |   |
| `links.self` | string | no |   |
| `period_of_report` | date (YYYY-MM-DD) \| null | no | SEC's reportDate (submissions snapshot) when it gives one, otherwise the value in the filing's header. |
| `period_of_report_source` | string \| null | no | One of: `submissions`, `header`, `null`. |
| `primary_cik` | string | no |   |
| `primary_name` | string \| null | no | Name of the primary entity as filed (header_in_file false: the name SEC's submissions index gives for the filing date, or null). |
| `provisional` | boolean | no | status == provisional. |
| `status` | string | no | provisional: 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

| Field | Type | Required | Description |
|---|---|---|---|
| `base_form` | string | no |   |
| `count` | integer | no |   |
| `form_type` | string | no |   |
| `is_amendment` | boolean | no |   |

## Schema: FormDFiling

| Field | Type | Required | Description |
|---|---|---|---|
| `accession` | string | yes |   |
| `chain` | object \| null | yes | The 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. |
| `extraction` | object | yes |   |
| `filing` | object | yes |   |
| `header_entities` | array of object | yes |   |
| `issuers` | array of object | yes |   |
| `offering` | any | yes |   |
| `recipients` | array of object | yes |   |
| `related_persons` | array of object | yes |   |
| `snapshot` | object | yes |   |

## 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

| Field | Type | Required | Description |
|---|---|---|---|
| `as_of` | string \| null | yes |   |
| `cik` | string \| null | yes |   |
| `data` | array of object | yes |   |
| `excluded` | [Excluded](#schema-excluded) | no |   |
| `excluded_total` | integer | no |   |
| `has_more` | boolean | yes |   |
| `next_cursor` | string \| null | yes |   |
| `view` | string | yes | One of: `as_filed`, `effective`. |

## Schema: FormList

| Field | Type | Required | Description |
|---|---|---|---|
| `computed_at` | date-time (RFC 3339, UTC) | no | When the list was computed, UTC. It is served until a later computation replaces it. |
| `data` | array of [FormCount](#schema-formcount) | yes |   |
| `has_more` | boolean | no |   |
| `next_cursor` | string \| null | no |   |

## Schema: Health

| Field | Type | Required | Description |
|---|---|---|---|
| `checks` | object | yes |   |
| `checks.callbacks` | string | no | Webhook 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.db` | string | no | One of: `ok`, `fail`. |
| `checks.docs_root` | string | no | One of: `ok`, `missing`. |
| `checks.live` | string | no | Live 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.mcp` | string | no | The 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.store` | string | no | The 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.stream` | string | no | The 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`. |
| `live` | object | no | Present only when live ingest is enabled. Counts and the full heartbeat are on /v3/coverage, which needs a key. |
| `live.lag_seconds` | integer \| null | no | Median 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_at` | date-time (RFC 3339, UTC) \| null | no | When the newest filing was first seen. |
| `live.last_poll_at` | date-time (RFC 3339, UTC) \| null | no | The last successful poll of SEC's list of new filings. |
| `live.paused_until` | date-time (RFC 3339, UTC) \| null | no | End of a pause in force; null otherwise. |
| `live.state` | string \| null | no | The 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. |
| `metering` | object | no | Only 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. |
| `status` | string | yes | degraded 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`. |
| `store` | object | no | The snapshot in use. Counts and load details are on /v3/coverage, which needs a key. |
| `store.available` | boolean | no |   |
| `store.snapshot_date` | date (YYYY-MM-DD) \| null | no |   |
| `store.stale` | boolean \| null | no |   |
| `time` | date-time (RFC 3339, UTC) | no |   |
| `version` | string | no |   |

## Schema: InsiderFootnoteRef

| Field | Type | Required | Description |
|---|---|---|---|
| `field` | string \| null | no | The column the footnote is on; null when it is on a group of fields (transaction coding). |
| `footnote_id` | string \| null | no |   |
| `ref_seq` | integer | no |   |
| `target_path` | string \| null | no |   |
| `text` | string \| null | no |   |

## 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.

| Field | Type | Required | Description |
|---|---|---|---|
| `accession` | string | no |   |
| `acquired_disposed` | string \| null | no |   |
| `confidence` | number \| null | no |   |
| `conversion_or_exercise_price` | [NullableDecimal](#schema-nullabledecimal) | no |   |
| `deemed_execution_date` | string \| null | no |   |
| `equity_swap` | boolean \| null | no |   |
| `exercise_date` | string \| null | no |   |
| `expiration_date` | string \| null | no |   |
| `extracted_at` | string | no |   |
| `extractor_version` | string | no |   |
| `flags` | array of string | no |   |
| `footnotes` | array of [InsiderFootnoteRef](#schema-insiderfootnoteref) | no |   |
| `ownership_form` | string \| null | no |   |
| `ownership_nature` | string \| null | no |   |
| `price` | [NullableDecimal](#schema-nullabledecimal) | no |   |
| `price_raw` | string \| null | no |   |
| `row_id` | string | no |   |
| `row_no` | integer | no |   |
| `security_title` | string \| null | no |   |
| `shares` | [NullableDecimal](#schema-nullabledecimal) | no |   |
| `shares_after` | [NullableDecimal](#schema-nullabledecimal) | no |   |
| `shares_raw` | string \| null | no |   |
| `table` | string | no | One of: `non_derivative_transaction`, `non_derivative_holding`, `derivative_transaction`, `derivative_holding`. |
| `table_code` | string | no | One of: `NT`, `NH`, `DT`, `DH`. |
| `timeliness` | string \| null | no |   |
| `total_value` | [NullableDecimal](#schema-nullabledecimal) | no |   |
| `transaction_code` | string \| null | no |   |
| `transaction_date` | string \| null | no |   |
| `transaction_date_raw` | string \| null | no |   |
| `transaction_form_type` | string \| null | no |   |
| `underlying_shares` | [NullableDecimal](#schema-nullabledecimal) | no |   |
| `underlying_title` | string \| null | no |   |
| `underlying_value` | [NullableDecimal](#schema-nullabledecimal) | no |   |
| `value_after` | [NullableDecimal](#schema-nullabledecimal) | no |   |

## Schema: InsiderRowList

| Field | Type | Required | Description |
|---|---|---|---|
| `as_of` | string \| null | no |   |
| `data` | array of [InsiderRow](#schema-insiderrow) + object | no |   |
| `excluded` | [Excluded](#schema-excluded) | no | view=effective only. |
| `excluded_total` | integer | no | view=effective only. |
| `has_more` | boolean | no |   |
| `next_cursor` | string \| null | no |   |
| `provisional` | boolean | no | True for view=effective: the row-level amendment view is provisional. |
| `view` | string | no | One of: `as_filed`, `effective`. |

## Schema: LedgerStep

| Field | Type | Required | Description |
|---|---|---|---|
| `accepted_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `accepted_at_source` | string \| null | no |   |
| `accession` | string | no |   |
| `applied_action` | string | no | One of: `base`, `replace`, `add`, `notice`, `ignored_duplicate`, `no_table`. |
| `applied_rule` | string | no |   |
| `computed_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `declared_type` | string \| null | no |   |
| `derive_version` | string | no |   |
| `filing_date` | date (YYYY-MM-DD) | no |   |
| `flags` | array of string | no |   |
| `manager_cik` | string | no |   |
| `period` | date (YYYY-MM-DD) | no |   |
| `rows_after` | integer \| null | no |   |
| `rows_before` | integer \| null | no |   |
| `step` | integer | no |   |
| `value_usd_after` | [NullableDecimal](#schema-nullabledecimal) | no |   |
| `value_usd_before` | [NullableDecimal](#schema-nullabledecimal) | no |   |

## Schema: NportFiling

| Field | Type | Required | Description |
|---|---|---|---|
| `accession` | string | yes |   |
| `extraction` | object | yes |   |
| `filing` | object | yes |   |
| `has_more` | boolean | yes |   |
| `holdings` | array of [NportHolding](#schema-nportholding) | yes |   |
| `ledger` | object \| null | yes | series_id, report_date, step, applied_action base \| replace \| ignored_duplicate, applied_rule, flags, effective_accession, steps, is_effective. |
| `limits` | array of string | yes |   |
| `next_cursor` | string \| null | yes |   |
| `report` | any | yes |   |

## Schema: NportFundHoldings

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | array of object | yes |   |
| `has_more` | boolean | yes |   |
| `id_type` | string | yes |   |
| `id_value` | string | yes |   |
| `limits` | array of string | yes |   |
| `next_cursor` | string \| null | yes |   |
| `view` | string | yes | One 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

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | array of [NportReport](#schema-nportreport) | yes |   |
| `has_more` | boolean | yes |   |
| `next_cursor` | string \| null | yes |   |
| `series_id` | string | yes |   |
| `view` | string | yes | One of: `effective`, `as_filed`. |

## Schema: NullableDecimal

An object with no fixed fields.

## Schema: OpenApi

This document.

An object with no fixed fields.

## Schema: OwnershipFiling

| Field | Type | Required | Description |
|---|---|---|---|
| `accession` | string | no |   |
| `amendment_chain` | object \| null | no | Provisional: the original with the amendments that name it, the steps, how each amendment was linked and its row links. |
| `document` | object \| null | no |   |
| `extraction` | [Extraction](#schema-extraction) | no |   |
| `filing` | [FilingRef](#schema-filingref) | no |   |
| `footnotes` | array of object | no |   |
| `header_entities` | array of object | no | The SEC header's entities with every field, addresses and phone numbers included. |
| `issuer` | object \| null | no |   |
| `links` | object | no |   |
| `other_footnote_references` | array of object | no |   |
| `owners` | array of object | no | Every reporting owner, document order, with the whole address and relationship. |
| `signatures` | array of object | no |   |
| `snapshot` | [Snapshot](#schema-snapshot) | no |   |
| `tables` | object | no |   |
| `tables.derivative_holdings` | array of [InsiderRow](#schema-insiderrow) | no |   |
| `tables.derivative_transactions` | array of [InsiderRow](#schema-insiderrow) | no |   |
| `tables.non_derivative_holdings` | array of [InsiderRow](#schema-insiderrow) | no |   |
| `tables.non_derivative_transactions` | array of [InsiderRow](#schema-insiderrow) | no |   |

## Schema: ParseWarning

| Field | Type | Required | Description |
|---|---|---|---|
| `code` | string | no |   |
| `detail` | string \| null | no | Text the extractor wrote. |
| `path` | string \| null | no |   |
| `row_kind` | string \| null | no |   |
| `row_no` | integer \| null | no |   |
| `severity` | string | no | One of: `info`, `warning`, `error`. |
| `table` | string \| null | no |   |

## Schema: ParsedChange

| Field | Type | Required | Description |
|---|---|---|---|
| `at` | date-time (RFC 3339, UTC) | yes | When the old version was replaced (unit_decision: when it was decided). |
| `extractor` | string \| null | no | superseded only. |
| `from_version` | string \| null | no |   |
| `group_key` | string \| null | no | replaced: the group (e.g. \<manager_cik\>\|\<period\>, \<accession\>\|\<extractor\>). |
| `id` | integer | yes | The row's id in its source (v3_parse_superseded, v3_derived_history, v3_13f_unit_decisions). |
| `kind` | string | yes | One of: `superseded`, `replaced`, `unit_decision`. |
| `old` | any | yes | superseded: the old row (object); replaced: the old rows (array); unit_decision: the decision. Numbers are strings holding the stored value. |
| `reason` | string | yes | superseded: changed, removed, withdrawn; replaced: rebuilt, recomputed, reparsed, withdrawn; unit_decision: decided, redecided, revised, withdrawn. |
| `row_key` | object \| null | no | superseded: the row's key columns, type-tagged as in the parse envelope ({"row_no":{"int":"3"}}). |
| `table` | string | yes |   |
| `to_version` | string \| null | no | unit_decision: the derive version that decided. |

## Schema: ParsedChanges

| Field | Type | Required | Description |
|---|---|---|---|
| `accession` | string | yes |   |
| `data` | array of [ParsedChange](#schema-parsedchange) | yes |   |
| `filing` | [FilingRef](#schema-filingref) | yes |   |
| `has_more` | boolean | yes |   |
| `next_cursor` | string \| null | yes |   |

## Schema: ParsedItem

| Field | Type | Required | Description |
|---|---|---|---|
| `active_version` | string | yes | The version the deployed parser runs. |
| `dataset` | string | yes | 13f, 8k_items, sections. |
| `extractor` | string | yes |   |
| `first_parsed_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `method` | string \| null | no | One of: `header`, `xml`, `xbrl`, `table`, `rule`, `null`. |
| `parsed_at` | date-time (RFC 3339, UTC) \| null | no | The last write of the result. |
| `reparse` | object \| null | yes | A parse of the deployed version queued, running or given up while a result stands; null otherwise. |
| `reparse.attempts` | integer \| null | no |   |
| `reparse.queued_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `reparse.state` | string | no | One of: `queued`, `running`, `failed`. |
| `reparse.version` | string | no |   |
| `rows_stale` | boolean | no | A later parse could not read the filing and left the rows of an earlier good parse in place. |
| `status` | string | yes | One of: `ok`, `ok_with_warnings`, `partial`, `unparseable`, `not_applicable`, `pending`, `failed`, `not_parsed`. |
| `version` | string \| null | yes | The extractor version that last verified the filing; null without a result. |
| `warnings` | array of [ParseWarning](#schema-parsewarning) | yes | At most 100, in order. |
| `warnings_total` | integer | yes |   |
| `warnings_truncated` | boolean | yes |   |
| `derived` | array of object | yes | The dataset's derive steps for this filing (13F: units, ledger); version and computed_at null until the step has run for it. |
| `derived[].computed_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `derived[].step` | string | no |   |
| `derived[].version` | string \| null | no |   |
| `inputs` | array of object | yes | The documents the last parse read. |
| `inputs[].filename` | string \| null | no |   |
| `inputs[].seq` | integer \| null | no |   |
| `inputs[].sha256` | string \| null | no |   |
| `inputs[].type` | string \| null | no |   |
| `links` | object | yes |   |
| `links.data` | string \| null | no | The dataset's route for this filing; null while this server does not answer it. |
| `rows_total` | integer | yes |   |

## Schema: ParsedList

| Field | Type | Required | Description |
|---|---|---|---|
| `accession` | string | yes |   |
| `data` | array of [ParsedItem](#schema-parseditem) | yes | One per extractor that covers the filing's form type; empty when none does. |
| `filing` | [FilingRef](#schema-filingref) | yes |   |
| `has_more` | boolean | yes |   |
| `next_cursor` | string \| null | yes |   |
| `snapshot` | [Snapshot](#schema-snapshot) | yes |   |

## Schema: Problem

RFC 9457 problem details.

| Field | Type | Required | Description |
|---|---|---|---|
| `code` | string | yes | One 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`. |
| `detail` | string | yes |   |
| `length` | integer | no | Search query errors: length in characters of the offending part of q. |
| `parameter` | string | no | The offending parameter, for 400 responses. |
| `position` | integer | no | Search query errors: character offset in q. |
| `request_id` | string | yes |   |
| `status` | integer | yes |   |
| `title` | string | yes |   |
| `type` | string (URI) | yes |   |

## Schema: ProposedSaleList

| Field | Type | Required | Description |
|---|---|---|---|
| `as_of` | string \| null | no |   |
| `data` | array of [F144Notice](#schema-f144notice) + object | no |   |
| `excluded` | [Excluded](#schema-excluded) | no | view=effective only. |
| `excluded_total` | integer | no | view=effective only. |
| `has_more` | boolean | no |   |
| `limits` | array of string | no |   |
| `next_cursor` | string \| null | no |   |
| `provisional` | boolean | no |   |
| `view` | string | no | One of: `as_filed`, `effective`. |

## Schema: Report

| Field | Type | Required | Description |
|---|---|---|---|
| `amended` | boolean | no | True when any live member is an amendment. |
| `base_form` | string | no | Base form of the chain's head. |
| `cik` | string | no |   |
| `first_filing_date` | date (YYYY-MM-DD) \| null | no | Filing date of the chain's head (the original, or the first ingested amendment when the original is absent). |
| `head_is_amendment` | boolean | no | The chain's first listed filing is an amendment: its original is not ingested, or it is unlinked, unresolved or ambiguous. |
| `latest` | object | no |   |
| `latest.accepted_at` | date-time (RFC 3339, UTC) \| null | no | As a filing's accepted_at. |
| `latest.accepted_at_snapshot` | date-time (RFC 3339, UTC) | no | As on a filing: only when SEC's value differs from accepted_at. |
| `latest.accepted_at_source` | string \| null | no |   |
| `latest.accession` | string | no |   |
| `latest.filing_date` | date (YYYY-MM-DD) \| null | no |   |
| `latest.form_type` | string \| null | no |   |
| `link_status` | string \| null | no | Link status of the head when it is an amendment. |
| `links` | object | no |   |
| `links.latest` | string | no |   |
| `links.versions` | string | no |   |
| `original_ingested` | boolean | no | True only when the head is an ingested original (not an amendment). |
| `period_of_report` | date (YYYY-MM-DD) \| null | no | Period 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_source` | string \| null | no | One of: `submissions`, `header`, `null`. |
| `report_key` | string | no |   |
| `versions` | integer | no | Live (not deleted) ingested members; /versions count also includes deleted and not-ingested items. |

## Schema: ReportList

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | array of [Report](#schema-report) | yes |   |
| `has_more` | boolean | yes |   |
| `next_cursor` | string \| null | yes |   |
| `snapshot` | [Snapshot](#schema-snapshot) | yes |   |

## Schema: ResolveMatch

| Field | Type | Required | Description |
|---|---|---|---|
| `cik` | string | no |   |
| `exchange` | string \| null | no |   |
| `links` | object | no |   |
| `links.entity` | string | no |   |
| `links.filings` | string | no |   |
| `name` | string \| null | no |   |
| `ticker` | string | no |   |

## Schema: ResolveResult

| Field | Type | Required | Description |
|---|---|---|---|
| `as_of` | date (YYYY-MM-DD) \| null | no |   |
| `coverage_from` | date (YYYY-MM-DD) \| null | no | The oldest copy kept; earlier dates cannot be resolved. |
| `data` | array of [ResolveMatch](#schema-resolvematch) | yes |   |
| `file_date` | date (YYYY-MM-DD) \| null | no | The daily copy of SEC's ticker file that answered. |
| `has_more` | boolean | no |   |
| `next_cursor` | string \| null | no |   |
| `snapshot` | [Snapshot](#schema-snapshot) | yes | available 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. |
| `source` | string \| null | no | One of: `sec_company_tickers`, `submissions`, `null`. |
| `ticker` | string | yes |   |

## Schema: SearchDocument

A matching document (members as trimmed by fields).

| Field | Type | Required | Description |
|---|---|---|---|
| `description` | string \| null | no |   |
| `doc_class` | string \| null | no |   |
| `doc_id` | string | no |   |
| `doc_type` | string \| null | no |   |
| `filename` | string \| null | no |   |
| `is_primary` | boolean \| null | no |   |
| `score` | number | no |   |
| `seq` | integer | no |   |
| `snippets` | array of [SearchSnippet](#schema-searchsnippet) | no |   |
| `url` | string | no | /v3/filings/{accession}/documents/{seq} |

## Schema: SearchFacetBucket

| Field | Type | Required | Description |
|---|---|---|---|
| `count` | integer | no |   |
| `value` | any | no | An 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.

| Field | Type | Required | Description |
|---|---|---|---|
| `form` | array of [SearchFacetBucket](#schema-searchfacetbucket) | no |   |
| `sic` | array of [SearchFacetBucket](#schema-searchfacetbucket) | no |   |
| `state` | array of [SearchFacetBucket](#schema-searchfacetbucket) | no |   |
| `year` | array of [SearchFacetBucket](#schema-searchfacetbucket) | no | Filing 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.

| Field | Type | Required | Description |
|---|---|---|---|
| `accepted_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `accepted_at_source` | string \| null | no |   |
| `accession` | string | no |   |
| `collapsed` | object \| null | no | Only with collapse=true: null, or {cluster_id, matched} for the best member of a template cluster standing for matched results. |
| `description` | string \| null | no |   |
| `doc_class` | string \| null | no |   |
| `doc_id` | string | no |   |
| `doc_type` | string \| null | no |   |
| `documents` | array of [SearchDocument](#schema-searchdocument) | no |   |
| `documents_matched` | integer | no |   |
| `entities` | array of object | no |   |
| `filename` | string \| null | no |   |
| `filing_date` | date (YYYY-MM-DD) \| null | no |   |
| `form_type` | string \| null | no |   |
| `is_primary` | boolean \| null | no |   |
| `provisional` | boolean | no |   |
| `score` | number | no |   |
| `seq` | integer | no |   |
| `snippets` | array of [SearchSnippet](#schema-searchsnippet) | no |   |
| `status` | string | no | The filing's status as indexed: filings SEC deleted are searchable; status= narrows. One of: `provisional`, `final`, `deleted`. |
| `url` | string | no |   |

## Schema: SearchIndexInfo

The index that answered.

| Field | Type | Required | Description |
|---|---|---|---|
| `extractor` | string \| null | no | Text extractor of the newest searched year; snippet offsets count characters of that extractor's text. |
| `index_version` | string \| null | no | Build id of the newest searched year. |
| `indexed_through` | date-time (RFC 3339, UTC) \| null | no | Acceptance-time horizon of the live indexer. |
| `ranking_version` | integer | no |   |
| `years_missing` | array of integer | no | Years that cannot be searched now. |

## Schema: SearchParse

How a query is read; nothing is executed.

| Field | Type | Required | Description |
|---|---|---|---|
| `ast` | object \| null | no | The query tree under the requested syntax: sexpr and tree. |
| `differs` | boolean | no | The two readings differ. |
| `edgar` | object | no | The EDGAR reading: ast, echo (the query EDGAR would build) and error when it does not parse. |
| `filters` | object | no | The structured filters after alias mapping and ticker resolution. |
| `match` | string | no | One of: `exact`, `stem`. |
| `normalized` | string | no | The normalised query. |
| `prefixes` | array of object | no |   |
| `prefixes[].capped` | boolean | no |   |
| `prefixes[].expansions` | integer | no |   |
| `prefixes[].in_span` | boolean | no | Inside NEAR or a phrase (capped at 1,024 expansions). |
| `prefixes[].prefix` | string | no |   |
| `prefixes[].top` | array of array of any | no | Up to 20 \[term, document frequency\] pairs. |
| `resolved` | object | no | {tickers: {TICKER: \[cik, ...\]}}. |
| `shards` | array of integer | no | The index years the query would search. |
| `syntax` | string | no | One of: `sb`, `edgar`. |
| `warnings` | array of [SearchWarning](#schema-searchwarning) | no |   |

## Schema: SearchResults

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | array of [SearchHit](#schema-searchhit) | yes |   |
| `facets` | [SearchFacets](#schema-searchfacets) | no |   |
| `has_more` | boolean | yes |   |
| `index` | [SearchIndexInfo](#schema-searchindexinfo) | yes |   |
| `next_cursor` | string \| null | yes | Pass back as cursor with the same query, filters, sort and group. Null when nothing follows, and always null with from \> 0. |
| `resolved` | object | yes | {tickers: {TICKER: \[cik, ...\]}}: how tickers were resolved. |
| `resolved.tickers` | object | no |   |
| `took_ms` | integer | yes |   |
| `total` | [SearchTotals](#schema-searchtotals) | yes |   |
| `warnings` | array of [SearchWarning](#schema-searchwarning) | yes |   |

## Schema: SearchSnippet

| Field | Type | Required | Description |
|---|---|---|---|
| `end` | integer | no | Code-point offset of the end of the snippet (exclusive), as start. |
| `highlights` | array of array of integer | no | \[start, end) character offsets in text of the matched words. |
| `start` | integer | no | Code-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. |
| `text` | string | no | Plain 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.

| Field | Type | Required | Description |
|---|---|---|---|
| `damaged_years` | array of integer \| null | yes | Years found damaged and dropped from the index until they are rebuilt; searches answer from the other years. |
| `freshness` | object \| null | yes | Seconds from a filing's acceptance to its first searchable commit, over the last 15 minutes; null without a live indexer. |
| `freshness.p50_s` | number \| null | no |   |
| `freshness.p95_s` | number \| null | no |   |
| `freshness.window` | string \| null | no | "15m". |
| `indexed_through` | date-time (RFC 3339, UTC) \| null | yes | The newest event time the live index has applied. |
| `indexer` | object \| null | yes |   |
| `indexer.indexed_through` | date-time (RFC 3339, UTC) \| null | no |   |
| `indexer.lag_events` | integer \| null | no |   |
| `indexer.lag_seconds` | number \| null | no |   |
| `indexer_stale` | boolean \| null | yes | True 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_seconds` | number \| null | yes | How far the live indexer is behind (0 when caught up). |
| `partial_years` | array of integer \| null | yes | Years 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. |
| `rebuilding` | array of integer \| null | yes | Years being rebuilt. |
| `state` | string \| null | yes |   |
| `tickers` | object \| null | yes |   |
| `tickers.file_date` | date (YYYY-MM-DD) \| null | no |   |
| `years` | array of object | yes |   |
| `years[].built_at` | string \| null | no |   |
| `years[].documents` | integer \| null | no |   |
| `years[].extractor` | string \| null | no |   |
| `years[].filings` | integer \| null | no |   |
| `years[].index_version` | string \| null | no |   |
| `years[].year` | integer | no |   |
| `years_missing` | array of integer \| null | yes | Years 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.

| Field | Type | Required | Description |
|---|---|---|---|
| `active` | boolean | yes |   |
| `created_at` | date-time (RFC 3339, UTC) | yes |   |
| `endpoint_id` | string | yes | cbe_ and 24 hex digits. |
| `id` | string | yes | sub_ and 24 hex digits. |
| `include_corrections` | boolean | yes |   |
| `kind` | string | yes | From 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_s` | integer \| null | yes | Digest interval; null: every event is delivered alone. |
| `name` | string | yes |   |
| `query` | object | yes | As 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.filters` | object | yes |   |
| `query.match` | string | yes | One of: `exact`, `stem`. |
| `query.q` | string | yes |   |
| `query.syntax` | string | yes | One of: `sb`, `edgar`. |
| `updated_at` | date-time (RFC 3339, UTC) | yes |   |

## Schema: SearchSubscriptionCreate

| Field | Type | Required | Description |
|---|---|---|---|
| `endpoint_id` | string | yes | One of the organization's endpoints; it must list filing.new (filing, firehose) or search.match (search). |
| `include_corrections` | boolean | no |   |
| `min_interval_s` | integer \| null | no |   |
| `name` | string | yes | 1 to 800 bytes. |
| `query` | object | yes | The 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

| Field | Type | Required | Description |
|---|---|---|---|
| `active` | boolean | yes |   |
| `created_at` | date-time (RFC 3339, UTC) | yes |   |
| `endpoint_id` | string | yes | cbe_ and 24 hex digits. |
| `id` | string | yes | sub_ and 24 hex digits. |
| `include_corrections` | boolean | yes |   |
| `kind` | string | yes | From 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_s` | integer \| null | yes | Digest interval; null: every event is delivered alone. |
| `name` | string | yes |   |
| `query` | object | yes | As 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.filters` | object | yes |   |
| `query.match` | string | yes | One of: `exact`, `stem`. |
| `query.q` | string | yes |   |
| `query.syntax` | string | yes | One of: `sb`, `edgar`. |
| `updated_at` | date-time (RFC 3339, UTC) | yes |   |
| `resolved` | object | yes | The 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.tickers` | object | no |   |

## Schema: SearchSubscriptionList

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | array of [SearchSubscription](#schema-searchsubscription) | yes |   |
| `has_more` | boolean | yes |   |
| `limits` | object | yes | By kind: filter (stored kind filing), firehose, search. limit: the plan's (0 without); used: active subscriptions of that kind. |
| `limits.filter` | object | no |   |
| `limits.filter.limit` | integer | no |   |
| `limits.filter.used` | integer | no |   |
| `limits.firehose` | object | no |   |
| `limits.firehose.limit` | integer | no |   |
| `limits.firehose.used` | integer | no |   |
| `limits.search` | object | no |   |
| `limits.search.limit` | integer | no |   |
| `limits.search.used` | integer | no |   |
| `next_cursor` | string \| null | yes |   |

## Schema: SearchSubscriptionPatch

| Field | Type | Required | Description |
|---|---|---|---|
| `active` | boolean | no | true on an inactive subscription counts against its kind's limit. |
| `endpoint_id` | string | no |   |
| `include_corrections` | boolean | no |   |
| `min_interval_s` | integer \| null | no | null clears it. |
| `name` | string | no |   |
| `query` | object | no | Replaces the stored query whole. |

## Schema: SearchSubscriptionTest

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | array of object | yes | The 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.

| Field | Type | Required | Description |
|---|---|---|---|
| `collapsed_hidden` | integer \| null | no | Results hidden by collapse=true; 0 without it. Totals and facets are never collapsed. |
| `documents` | integer \| null | no | Matching documents. |
| `filings` | integer \| null | no | Filings with at least one matching document. |
| `relation` | string | no | gte when a NEAR candidate budget was exhausted (warning near_budget_exhausted); eq otherwise. One of: `eq`, `gte`. |

## Schema: SearchWarning

| Field | Type | Required | Description |
|---|---|---|---|
| `code` | string | no | One of ignored_parameter, unknown_ticker, snippet_truncated, near_budget_exhausted, leading_wildcard_dropped, no_searchable_text, cursor_generation_expired, cluster_table_changed. |
| `detail` | string | no |   |
| `doc_id` | string | no | snippet_truncated: the document whose snippet scan was cut short. |
| `parameter` | string | no | ignored_parameter: the parameter's name. |
| `position` | integer \| null | no | Character offset in q, when the warning concerns q. |
| `ticker` | string | no | unknown_ticker: the ticker the ticker file does not know. |

## Schema: SecFiling

One filing as SEC lists it for the entity.

| Field | Type | Required | Description |
|---|---|---|---|
| `accepted_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `accession` | string | no |   |
| `act` | string \| null | no |   |
| `cik` | string | no |   |
| `file_number` | string \| null | no |   |
| `filing_date` | date (YYYY-MM-DD) | no |   |
| `film_number` | string \| null | no |   |
| `form` | string | no |   |
| `in_v3` | boolean | no | Whether v3 has ingested this filing. A filing SEC deleted is in v3 too (status deleted). |
| `is_inline_xbrl` | boolean \| null | no |   |
| `is_xbrl` | boolean \| null | no |   |
| `items` | array of string | no |   |
| `links` | object | no |   |
| `links.filing` | string \| null | no | The filing in v3; null when in_v3 is false. |
| `primary_doc_description` | string \| null | no |   |
| `primary_document` | string \| null | no |   |
| `report_date` | date (YYYY-MM-DD) \| null | no |   |
| `size` | integer \| null | no |   |
| `status` | string \| null | no | The filing's status in v3; null when in_v3 is false. One of: `provisional`, `final`, `deleted`, `null`. |

## Schema: SecFilingList

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | array of [SecFiling](#schema-secfiling) | yes |   |
| `has_more` | boolean | no |   |
| `next_cursor` | string \| null | no | Always null: this list is paged with offset; use next_offset. |
| `next_offset` | integer \| null | no | The offset of the next page; null on the last page (and when the snapshot store is unavailable). |
| `offset` | integer | no |   |
| `snapshot` | [Snapshot](#schema-snapshot) | yes |   |
| `total` | integer \| null | no | Rows matching the filters; null when the snapshot store is unavailable. |

## Schema: Section

| Field | Type | Required | Description |
|---|---|---|---|
| `absence_basis` | string | no | One of: `none`, `form_optional`, `bracketed`, `amendment_scope`. |
| `confidence` | number \| null | no | Rule confidence (not a probability). |
| `flags` | array of string | no |   |
| `incorporation` | object \| null | no |   |
| `item_code` | string | no |   |
| `item_order` | integer | no |   |
| `label` | string \| null | no |   |
| `links` | object | no |   |
| `part` | string | no |   |
| `section` | string | no | The key: 10k.1a, 10q.p1i2, 20f.3d. |
| `status` | string | no | One of: `ok`, `incorporated_by_reference`, `combined_with`, `omitted`, `reserved`, `not_found`. |
| `text_end` | integer \| null | no |   |
| `text_start` | integer \| null | no |   |

## Schema: SectionMapOfFiling

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

| Field | Type | Required | Description |
|---|---|---|---|
| `accession` | string | no |   |
| `confidence` | number \| null | no |   |
| `document` | object \| null | no |   |
| `extraction` | object | no |   |
| `family` | string \| null | no | One of: `merger`, `proxy`, `null`. |
| `filing` | [FilingRef](#schema-filingref) | no |   |
| `flags` | array of string | no |   |
| `form` | string | no |   |
| `keys_found` | array of string | no |   |
| `primary_text_bytes` | integer \| null | no |   |
| `registrant` | string \| null | no |   |
| `sections` | array of [SectionMapRow](#schema-sectionmaprow) | no |   |
| `sections_found` | integer \| null | no | Sections with a key. |
| `sections_unmapped` | integer \| null | no |   |
| `snapshot` | object | no |   |
| `source_format` | string \| null | no |   |
| `toc_entries` | integer \| null | no |   |
| `toc_kind` | string \| null | no | One of: `linked`, `text`, `none`, `null`. |
| `versions` | string | no |   |

## 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.

| Field | Type | Required | Description |
|---|---|---|---|
| `block_count` | integer | no |   |
| `confidence` | number | no |   |
| `extracted_at` | string | no |   |
| `extractor_version` | string | no |   |
| `first_block_id` | string \| null | no |   |
| `flags` | array of string | no |   |
| `heading_block_id` | string | no |   |
| `heading_text` | string | no | The heading as filed. |
| `key` | string | no | The canonical key, or 'unmapped'. Proposals: proposal_\<n\>, n = 1..99, one key per proposal (there is no 'proposals' key). |
| `label` | string \| null | no |   |
| `last_block_id` | string \| null | no |   |
| `links` | object | no |   |
| `ordinal` | integer | no | 1-based, document order. |
| `proposal_title` | string \| null | no | proposal_\<n\>: the heading without its number ('Proposal No. 2: Ratification of Ernst & Young LLP' -\> 'Ratification of Ernst & Young LLP'); null for other keys. |
| `section` | string | no | The key or unmapped_\<ordinal\> for a heading no key names; the {section} of the text route. |
| `signals` | array of string | no |   |
| `span_end` | integer | no |   |
| `span_start` | integer | no |   |
| `status` | string | no | One of: `ok`. |
| `subsections` | array of object | no | The unmapped sub-headings inside this section, document order; each runs to the next heading. |
| `subsections[].block_count` | integer | no |   |
| `subsections[].heading_block_id` | string | no |   |
| `subsections[].heading_text` | string | no |   |
| `subsections[].links` | object | no |   |
| `subsections[].ordinal` | integer | no |   |
| `subsections[].section` | string | no | unmapped_\<ordinal\> |
| `subsections[].span_end` | integer | no |   |
| `subsections[].span_start` | integer | no |   |
| `subsections[].text_bytes` | integer | no |   |
| `subsections[].text_end` | integer | no |   |
| `subsections[].text_start` | integer | no |   |
| `subsections[].toc_text` | string \| null | no |   |
| `text_bytes` | integer | no |   |
| `text_end` | integer | no |   |
| `text_start` | integer | no |   |
| `title_as_found` | string | no | Same as heading_text (the shape of 10-K sections). |
| `toc_text` | string \| null | no | The table of contents entry as filed, when the section came from it. |

## Schema: SectionScope

| Field | Type | Required | Description |
|---|---|---|---|
| `amendment_no` | integer \| null | no |   |
| `explanatory_note` | object \| null | no |   |
| `is_amendment` | boolean | no |   |
| `items_present` | array of string | no |   |
| `kind` | string | no | One of: `full`, `part_iii_only`, `exhibits_only`, `items_subset`, `no_items`. |

## Schema: SectionSearchList

| Field | Type | Required | Description |
|---|---|---|---|
| `as_of` | string \| null | no |   |
| `data` | array of object | no |   |
| `data[].filing` | [FilingRef](#schema-filingref) | no |   |
| `data[].form` | string | no |   |
| `data[].links` | object | no |   |
| `data[].scope_kind` | string | no |   |
| `data[].section` | [Section](#schema-section) | no |   |
| `form` | string | no |   |
| `has_more` | boolean | no |   |
| `next_cursor` | string \| null | no |   |
| `section` | string | no |   |
| `snapshot` | [Snapshot](#schema-snapshot) | no |   |

## Schema: SectionsOfFiling

| Field | Type | Required | Description |
|---|---|---|---|
| `accession` | string | no |   |
| `document` | object \| null | no |   |
| `extraction` | [Extraction](#schema-extraction) | no |   |
| `filing` | [FilingRef](#schema-filingref) | no |   |
| `financial_statements` | object \| null | no |   |
| `form` | string \| null | no |   |
| `scope` | [SectionScope](#schema-sectionscope) | no |   |
| `sections` | array of [Section](#schema-section) | no |   |
| `snapshot` | [Snapshot](#schema-snapshot) | no |   |
| `versions` | string | no |   |

## 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.

| Field | Type | Required | Description |
|---|---|---|---|
| `available` | boolean | yes |   |
| `date` | date (YYYY-MM-DD) \| null | yes | Date 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).

| Field | Type | Required | Description |
|---|---|---|---|
| `basis` | string | yes | One of: `item_2_01`, `sic_change`, `name_change`, `none`. |
| `computed_at` | string \| null | no |   |
| `current_name` | string \| null | no |   |
| `derive_version` | string \| null | no |   |
| `flags` | array of string | no |   |
| `ipo_accession` | string \| null | no |   |
| `ipo_at` | date (YYYY-MM-DD) \| null | no |   |
| `merger_accession` | string \| null | yes |   |
| `merger_closed_at` | date (YYYY-MM-DD) \| null | yes |   |
| `sic_history_source` | object \| null | no | first_6770_accession, first_6770_date, last_6770_accession, last_6770_date, sic_change_accession, sic_change_date, new_sic. |
| `spac_name` | string \| null | no |   |
| `status` | string | yes | One of: `current`, `former`, `none`. |

## Schema: SpacCompanies

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | array of object | yes |   |
| `data[].cik` | string | no |   |
| `data[].links` | object | no |   |
| `data[].name` | string \| null | no |   |
| `data[].spac` | [Spac](#schema-spac) | no |   |
| `has_more` | boolean | yes |   |
| `next_cursor` | string \| null | yes |   |
| `spac` | string | yes | One 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.

| Field | Type | Required | Description |
|---|---|---|---|
| `accession` | string | no |   |
| `docmodel_version` | string \| null | no |   |
| `document` | object \| null | no |   |
| `extraction` | [Extraction](#schema-extraction) | no |   |
| `next_offset` | integer \| null | no |   |
| `section` | string | no |   |
| `served_model_version` | string | no |   |
| `text` | string \| null | no |   |
| `text_bytes` | integer \| null | no |   |
| `text_offset` | integer \| null | no |   |
| `text_reason` | string \| null | no | One of: `model_changed`, `bytes_unavailable`, `null`. |
| `text_status` | string | no | One of: `current`, `from_version`, `reparse_pending`, `no_text`, `parse_pending`. |
| `text_total_bytes` | integer \| null | no |   |
| `text_truncated` | boolean | no |   |

## Schema: StreamEvent

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | object | yes | filing.\* 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.filing` | [StreamFiling](#schema-streamfiling) | no |   |
| `emitted_at` | date-time (RFC 3339, UTC) | yes |   |
| `id` | string | yes | str_\<stream_seq\>, zero padded. |
| `schema_version` | integer | yes | One of: `1`. |
| `stream_seq` | integer | yes | The event's position in the stream log; dense: a jump means a missed event. |
| `type` | string | yes | One 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.

| Field | Type | Required | Description |
|---|---|---|---|
| `accepted_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `accepted_at_source` | string \| null | no |   |
| `accession` | string | no |   |
| `base_form` | string \| null | no |   |
| `doc_count` | integer | no |   |
| `documents` | array of object | no | At most 100 entries, none with detail=summary. |
| `documents_state` | string | no | pending: 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_truncated` | boolean | no | true when the list was cut: the filing has more than 100 documents, or the list was shortened to fit the event's 16 KiB. |
| `entities` | array of object | no | The filing's entities, as on GET /v3/filings/{accession}, with tickers. |
| `entities_truncated` | boolean | no | true 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_date` | date (YYYY-MM-DD) \| null | no |   |
| `first_seen_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `form_family` | string \| null | no |   |
| `form_type` | string \| null | no |   |
| `items` | array of string | no |   |
| `late` | boolean | no |   |
| `links` | object | no |   |
| `links.sec_index` | string | no |   |
| `links.self` | string | no |   |
| `period_of_report` | date (YYYY-MM-DD) \| null | no |   |
| `primary_document` | object \| null | no |   |
| `provisional` | boolean | no |   |
| `registered_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `source` | string | no | realtime for a filing seen live, feed for one first seen in the nightly feed (late: true). |
| `status` | string | no |   |
| `total_bytes` | integer | no |   |

## Schema: StreamPage

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | array of [StreamEvent](#schema-streamevent) | yes | In stream order (the order of emission, not acceptance order). |
| `has_more` | boolean | yes | true when more events are waiting: ask again at once. |
| `head_cursor` | string | yes |   |
| `live` | object | yes |   |
| `live.covered_until` | date-time (RFC 3339, UTC) \| null | no |   |
| `live.state` | string | no | The live ingest daemon's state, or down. |
| `next_cursor` | string | yes | On every answer, an empty one included; with filters it moves past the events they dropped. |
| `retention` | object | yes |   |
| `retention.days` | integer | no |   |
| `retention.oldest_cursor` | string \| null | no |   |

## Schema: StreamStatus

| Field | Type | Required | Description |
|---|---|---|---|
| `head_cursor` | string | yes |   |
| `latency` | object | yes | Percentiles 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_accepted` | object | no |   |
| `latency.from_registered` | object | no |   |
| `live` | object | yes |   |
| `live.covered_until` | date-time (RFC 3339, UTC) \| null | no |   |
| `live.state` | string | no |   |
| `retention` | object | yes |   |
| `retention.days` | integer | no |   |
| `retention.oldest_cursor` | string \| null | no |   |
| `sequencer` | object | yes |   |
| `sequencer.lag_events` | integer \| null | no |   |
| `sequencer.lag_seconds` | number \| null | no |   |
| `sequencer.leading` | boolean \| null | no |   |

## Schema: Usage

| Field | Type | Required | Description |
|---|---|---|---|
| `as_of` | date-time (RFC 3339, UTC) | yes |   |
| `enforcement` | object | yes | Each feature: off, observe (counted and logged, never refused) or enforce. |
| `key` | object | yes |   |
| `key.bytes` | integer \| null | no |   |
| `key.fingerprint` | string | no | First 12 hex digits of the key's SHA-256. |
| `key.requests` | integer \| null | no |   |
| `limits` | object \| null | yes | Null while no limit is applied (metering off) and for a key without an organization. |
| `limits.burst` | integer \| null | no |   |
| `limits.exempt` | object \| null | no | Null, 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.concurrency` | boolean | no |   |
| `limits.exempt.expires_at` | date-time (RFC 3339, UTC) \| null | no | When the exemption ends; null = no end set. |
| `limits.exempt.rate` | boolean | no |   |
| `limits.exempt.scope` | string | no | key: this key; org: every credential of the organization; config: the server's configuration. One of: `key`, `org`, `config`. |
| `limits.monthly_bytes` | integer \| null | no | Included response bytes per month (measured before compression); null = unlimited. |
| `limits.monthly_requests` | integer \| null | no |   |
| `limits.requests_per_second` | integer \| null | no | Null while the caller is exempt from the rate limit. |
| `month` | string | yes | The month counted, YYYY-MM: the calendar month in New York time (America/New_York). |
| `org` | object | yes | This month, all keys of the organization (a legacy key: that key). Null members while usage is not counted. |
| `org.bytes` | integer \| null | no | Billable response bytes (5xx and 429 excluded). |
| `org.bytes_remaining` | integer \| null | no |   |
| `org.requests` | integer \| null | no |   |
| `org_id` | integer \| null | yes | The organization of the key; null for a legacy key not attributed to one. |
| `plan` | string \| null | yes | The organization's plan id; null when its entitlements are not known (default limits apply). |
| `reset_at` | date-time (RFC 3339, UTC) | yes | When 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.

| Field | Type | Required | Description |
|---|---|---|---|
| `computed_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `derive_version` | string \| null | no |   |
| `detected` | string \| null | no | One of: `dollars`, `thousands`, `ambiguous`, `untested`, `null`. |
| `flags` | array of string | no |   |
| `method` | string \| null | no | One of: `date_rule`, `consensus_price`, `prior_period`, `null`. |
| `multiplier` | integer \| null | no |   |
| `previous` | object \| null | no |   |
| `previous.detected` | string \| null | no |   |
| `previous.multiplier` | integer \| null | no |   |
| `previous.redecided_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `rows_tested` | integer \| null | no |   |
| `status` | string | no | One of: `decided`, `pending`, `not_applicable`. |
| `summary_unit` | string \| null | no |   |

## Schema: Versions

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

| Field | Type | Required | Description |
|---|---|---|---|
| `count` | integer | no | Members of the whole chain, deleted and not-ingested included. |
| `items` | array of object | no |   |
| `items[].accepted_at` | date-time (RFC 3339, UTC) \| null | no | As a filing's accepted_at; null for a member that is not ingested. |
| `items[].accepted_at_snapshot` | date-time (RFC 3339, UTC) | no | As on a filing: only when SEC's value differs from accepted_at. |
| `items[].accepted_at_source` | string \| null | no |   |
| `items[].accession` | string | no |   |
| `items[].amendment_no` | integer \| null | no |   |
| `items[].amendment_seq` | integer \| null | no | 0 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_type` | string \| null | no |   |
| `items[].current` | boolean | no |   |
| `items[].filing_date` | date (YYYY-MM-DD) \| null | no |   |
| `items[].form_type` | string \| null | no |   |
| `items[].header_in_file` | boolean \| null | no | As on GET /v3/filings/{accession}. |
| `items[].ingested` | boolean | no | False for a root known only from an amendment's link. |
| `items[].link` | object | no |   |
| `items[].link.candidates` | array of object | no | Possible originals, shown for an ambiguous link. |
| `items[].link.confidence` | number \| null | no |   |
| `items[].link.method` | string \| null | no | One of: `explicit_header`, `explicit_xml`, `original_date`, `period_match`, `date_items_match`, `file_number`, `parties`, `filer_file_number`, `description_text`, `manual`, `null`. |
| `items[].link.status` | string | no | One of: `resolved`, `ambiguous`, `unresolved`, `target_not_public`, `target_not_yet_ingested`. |
| `items[].primary_cik` | string \| null | no |   |
| `items[].scope` | string \| null | no |   |
| `items[].sec_url` | string \| null | no |   |
| `items[].status` | string \| null | no |   |
| `latest` | string \| null | no | Newest ingested, non-deleted member; null when every ingested member is deleted. |
| `position` | integer | no | 1-based place of this filing in the whole chain (not in items when truncated). |
| `report_key` | string | no | Accession of the chain's root (the original filing, even when it is not ingested). |
| `root` | string | no | Alias of report_key. |
| `snapshot` | [Snapshot](#schema-snapshot) | no | On /v3/filings/{accession}/versions only; the block embedded in a filing has none (the filing carries it). |
| `truncated` | boolean | no | True 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.

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | object | yes |   |
| `data.challenge` | string | yes |   |
| `type` | string | yes | One 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).

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | object | yes |   |
| `emitted_at` | date-time (RFC 3339, UTC) | yes |   |
| `event_seq` | integer \| null | no | search.match: the outbox position. |
| `id` | string | yes | The webhook-id header's value: stable across the attempts of one delivery. |
| `schema_version` | integer | yes | One of: `1`. |
| `stream_seq` | integer | no | filing.\* events from the stream log: their stream position. |
| `subscription` | object \| null | no | The subscription that produced the event ({id, name}); null for a test send; absent from endpoint.verification. |
| `subscription.id` | string | no |   |
| `subscription.name` | string | no |   |
| `test` | boolean | yes | true for a test send (POST /v3/callbacks/endpoints/{id}/test): sample data, not billed. |
| `type` | string | yes |   |

## Schema: WebhookFilingCorrected

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | object | yes |   |
| `data.changes` | object | yes |   |
| `data.changes.docs_added` | array of any | no |   |
| `data.changes.docs_changed` | array of any | no |   |
| `data.changes.docs_removed` | array of any | no |   |
| `data.changes.header_fields` | array of object | no |   |
| `data.changes.header_fields[].after` | any | no |   |
| `data.changes.header_fields[].before` | any | no |   |
| `data.changes.header_fields[].field` | string | no |   |
| `data.filing` | [StreamFiling](#schema-streamfiling) | yes |   |
| `emitted_at` | date-time (RFC 3339, UTC) | yes |   |
| `event_seq` | integer \| null | no | search.match: the outbox position. |
| `id` | string | yes | The webhook-id header's value: stable across the attempts of one delivery. |
| `schema_version` | integer | yes | One of: `1`. |
| `stream_seq` | integer | no | filing.\* events from the stream log: their stream position. |
| `subscription` | object \| null | no | The subscription that produced the event ({id, name}); null for a test send; absent from endpoint.verification. |
| `subscription.id` | string | no |   |
| `subscription.name` | string | no |   |
| `test` | boolean | yes | true for a test send (POST /v3/callbacks/endpoints/{id}/test): sample data, not billed. |
| `type` | string | yes | One of: `filing.corrected`. |

## Schema: WebhookFilingDeleted

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | object | yes |   |
| `data.accession` | string | yes |   |
| `data.deleted_at` | date-time (RFC 3339, UTC) | yes |   |
| `data.reason` | string | yes | One of: `feed_deletion`, `sec_404`. |
| `emitted_at` | date-time (RFC 3339, UTC) | yes |   |
| `event_seq` | integer \| null | no | search.match: the outbox position. |
| `id` | string | yes | The webhook-id header's value: stable across the attempts of one delivery. |
| `schema_version` | integer | yes | One of: `1`. |
| `stream_seq` | integer | no | filing.\* events from the stream log: their stream position. |
| `subscription` | object \| null | no | The subscription that produced the event ({id, name}); null for a test send; absent from endpoint.verification. |
| `subscription.id` | string | no |   |
| `subscription.name` | string | no |   |
| `test` | boolean | yes | true for a test send (POST /v3/callbacks/endpoints/{id}/test): sample data, not billed. |
| `type` | string | yes | One of: `filing.deleted`. |

## Schema: WebhookFilingDigest

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | object | yes |   |
| `data.count` | integer | yes |   |
| `data.events` | array of object | yes |   |
| `data.events[].data` | object | no |   |
| `data.events[].type` | string | no |   |
| `data.truncated` | boolean | yes |   |
| `emitted_at` | date-time (RFC 3339, UTC) | yes |   |
| `event_seq` | integer \| null | no | search.match: the outbox position. |
| `id` | string | yes | The webhook-id header's value: stable across the attempts of one delivery. |
| `schema_version` | integer | yes | One of: `1`. |
| `stream_seq` | integer | no | filing.\* events from the stream log: their stream position. |
| `subscription` | object \| null | no | The subscription that produced the event ({id, name}); null for a test send; absent from endpoint.verification. |
| `subscription.id` | string | no |   |
| `subscription.name` | string | no |   |
| `test` | boolean | yes | true for a test send (POST /v3/callbacks/endpoints/{id}/test): sample data, not billed. |
| `type` | string | yes | One of: `filing.digest`. |

## Schema: WebhookFilingNew

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | object | yes |   |
| `data.filing` | [StreamFiling](#schema-streamfiling) | yes |   |
| `emitted_at` | date-time (RFC 3339, UTC) | yes |   |
| `event_seq` | integer \| null | no | search.match: the outbox position. |
| `id` | string | yes | The webhook-id header's value: stable across the attempts of one delivery. |
| `schema_version` | integer | yes | One of: `1`. |
| `stream_seq` | integer | no | filing.\* events from the stream log: their stream position. |
| `subscription` | object \| null | no | The subscription that produced the event ({id, name}); null for a test send; absent from endpoint.verification. |
| `subscription.id` | string | no |   |
| `subscription.name` | string | no |   |
| `test` | boolean | yes | true for a test send (POST /v3/callbacks/endpoints/{id}/test): sample data, not billed. |
| `type` | string | yes | One of: `filing.new`. |

## Schema: WebhookFilingUpdated

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | object | yes |   |
| `data.change` | string | yes | documents_added, documents_refetched, finalized, delivery_merged or amendment_linked; new values may be added (receivers ignore unknown ones). |
| `data.filing` | [StreamFiling](#schema-streamfiling) | yes |   |
| `emitted_at` | date-time (RFC 3339, UTC) | yes |   |
| `event_seq` | integer \| null | no | search.match: the outbox position. |
| `id` | string | yes | The webhook-id header's value: stable across the attempts of one delivery. |
| `schema_version` | integer | yes | One of: `1`. |
| `stream_seq` | integer | no | filing.\* events from the stream log: their stream position. |
| `subscription` | object \| null | no | The subscription that produced the event ({id, name}); null for a test send; absent from endpoint.verification. |
| `subscription.id` | string | no |   |
| `subscription.name` | string | no |   |
| `test` | boolean | yes | true for a test send (POST /v3/callbacks/endpoints/{id}/test): sample data, not billed. |
| `type` | string | yes | One of: `filing.updated`. |

## Schema: WebhookSearchDigest

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | object | yes |   |
| `data.count` | integer | yes |   |
| `data.events` | array of object | yes |   |
| `data.events[].data` | object | no |   |
| `data.events[].type` | string | no |   |
| `data.truncated` | boolean | yes |   |
| `emitted_at` | date-time (RFC 3339, UTC) | yes |   |
| `event_seq` | integer \| null | no | search.match: the outbox position. |
| `id` | string | yes | The webhook-id header's value: stable across the attempts of one delivery. |
| `schema_version` | integer | yes | One of: `1`. |
| `stream_seq` | integer | no | filing.\* events from the stream log: their stream position. |
| `subscription` | object \| null | no | The subscription that produced the event ({id, name}); null for a test send; absent from endpoint.verification. |
| `subscription.id` | string | no |   |
| `subscription.name` | string | no |   |
| `test` | boolean | yes | true for a test send (POST /v3/callbacks/endpoints/{id}/test): sample data, not billed. |
| `type` | string | yes | One of: `search.digest`. |

## Schema: WebhookSearchExportCompleted

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | object | yes |   |
| `data.export` | object | yes |   |
| `data.export.bytes_written` | integer | no |   |
| `data.export.download_url` | string \| null | no |   |
| `data.export.id` | string | no |   |
| `data.export.rows_written` | integer | no |   |
| `data.export.state` | string | no |   |
| `emitted_at` | date-time (RFC 3339, UTC) | yes |   |
| `event_seq` | integer \| null | no | search.match: the outbox position. |
| `id` | string | yes | The webhook-id header's value: stable across the attempts of one delivery. |
| `schema_version` | integer | yes | One of: `1`. |
| `stream_seq` | integer | no | filing.\* events from the stream log: their stream position. |
| `subscription` | object \| null | no | The subscription that produced the event ({id, name}); null for a test send; absent from endpoint.verification. |
| `subscription.id` | string | no |   |
| `subscription.name` | string | no |   |
| `test` | boolean | yes | true for a test send (POST /v3/callbacks/endpoints/{id}/test): sample data, not billed. |
| `type` | string | yes | One of: `search.export.completed`. |

## Schema: WebhookSearchMatch

| Field | Type | Required | Description |
|---|---|---|---|
| `data` | object | yes |   |
| `data.documents` | array of object | yes |   |
| `data.documents[].doc_type` | string \| null | no |   |
| `data.documents[].seq` | integer | no |   |
| `data.documents[].snippets` | array of any | no |   |
| `data.documents[].url` | string \| null | no |   |
| `data.event_seq` | integer \| null | no |   |
| `data.filing` | object | yes |   |
| `data.filing.accepted_at` | string \| null | no |   |
| `data.filing.accession` | string | no |   |
| `data.filing.entities` | array of object | no |   |
| `data.filing.filing_date` | string \| null | no |   |
| `data.filing.form_type` | string \| null | no |   |
| `data.matched_at` | date-time (RFC 3339, UTC) | yes |   |
| `data.rematch` | boolean | yes |   |
| `data.search_url` | string | yes | The /v3/search request of the subscription's query, up to the filing's acceptance. |
| `data.truncated` | boolean | yes | true when documents were left out to keep the event within 64 KiB. |
| `emitted_at` | date-time (RFC 3339, UTC) | yes |   |
| `event_seq` | integer \| null | no | search.match: the outbox position. |
| `id` | string | yes | The webhook-id header's value: stable across the attempts of one delivery. |
| `schema_version` | integer | yes | One of: `1`. |
| `stream_seq` | integer | no | filing.\* events from the stream log: their stream position. |
| `subscription` | object \| null | no | The subscription that produced the event ({id, name}); null for a test send; absent from endpoint.verification. |
| `subscription.id` | string | no |   |
| `subscription.name` | string | no |   |
| `test` | boolean | yes | true for a test send (POST /v3/callbacks/endpoints/{id}/test): sample data, not billed. |
| `type` | string | yes | One of: `search.match`. |

## Schema: XbrlCompanyPeriods

| Field | Type | Required | Description |
|---|---|---|---|
| `as_of` | string \| null | yes |   |
| `cik` | string | yes |   |
| `concept` | string | yes |   |
| `data` | array of object | yes |   |
| `derivation` | object | yes | additivity of the concept's unit (flow, per_share, share_count, ratio, stock); derived false with the refusal status for anything but a flow. |
| `dims` | string | yes |   |
| `excluded` | [Excluded](#schema-excluded) | yes |   |
| `excluded_total` | integer | yes |   |
| `has_more` | boolean | yes |   |
| `next_cursor` | null | yes |   |
| `rule` | string | yes |   |
| `rule_version` | string | yes |   |

## Schema: XbrlCompanySegments

| Field | Type | Required | Description |
|---|---|---|---|
| `accuracy` | object | no | Measured precision and coverage of each requested kind on the latest unseen holdout (static; contract 2.10). |
| `as_of` | string \| null | yes |   |
| `axes` | array of string | yes |   |
| `cik` | string | yes |   |
| `data` | array of object | yes |   |
| `excluded` | [Excluded](#schema-excluded) | yes |   |
| `excluded_total` | integer | yes |   |
| `from` | string \| null | yes |   |
| `has_more` | boolean | yes |   |
| `kinds` | array of string | yes |   |
| `limit` | integer | yes | Period ends per page (default 1: the latest fiscal year). |
| `next_cursor` | string \| null | yes | Opaque: the next page (earlier period ends), same filters. |
| `period` | string \| null | yes |   |
| `periods` | string | yes | The period classes served, canonical (default annual: the year ends, their years and instants). |
| `rule` | string | yes |   |
| `rules` | object | yes |   |
| `to` | string \| null | yes |   |
| `view` | string | yes | One of: `latest`, `first_reported`. |

## Schema: XbrlCompanyStandard

| Field | Type | Required | Description |
|---|---|---|---|
| `accuracy` | object | no | Measured precision and coverage of each requested field on the named map version (static; contract 2.9). |
| `as_of` | string \| null | yes |   |
| `cik` | string | yes |   |
| `data` | array of object | yes |   |
| `data[].values` | object | no |   |
| `excluded` | [Excluded](#schema-excluded) | yes |   |
| `excluded_total` | integer | yes |   |
| `fields` | array of string | yes |   |
| `filings` | object | yes | By 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}. |
| `from` | string \| null | yes |   |
| `has_more` | boolean | yes |   |
| `limit` | integer | yes | Period ends per page. |
| `map` | object | yes |   |
| `next_cursor` | string \| null | yes | Opaque: the next page (earlier period ends), same filters. |
| `period` | string \| null | yes |   |
| `periods` | string | yes | The period classes served, canonical (default annual,quarterly). |
| `rule` | string | yes |   |
| `to` | string \| null | yes |   |
| `ttm` | boolean | no | true: TTM rows (class ttm) at each quarter end of the monetary flow fields. |
| `view` | string | yes | One of: `latest`, `first_reported`. |

## Schema: XbrlCompanyStatements

| Field | Type | Required | Description |
|---|---|---|---|
| `as_of` | string \| null | yes |   |
| `category` | string \| null | yes |   |
| `cik` | string | yes |   |
| `data` | array of object | yes |   |
| `data[].accession` | string | no |   |
| `data[].filing` | object | no | With links.next: the filing route's next page of this report. |
| `data[].has_more` | boolean | no |   |
| `data[].statements` | array of [XbrlStatement](#schema-xbrlstatement) | no |   |
| `excluded` | [Excluded](#schema-excluded) | yes |   |
| `excluded_total` | integer | yes |   |
| `has_more` | boolean | yes | A category alone: the report's next roles (next_cursor). |
| `kind` | string \| null | yes |   |
| `next_cursor` | string \| null | yes |   |
| `role_uri` | string \| null | yes |   |

## 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.

| Field | Type | Required | Description |
|---|---|---|---|
| `group` | integer | no |   |
| `rank` | integer | no |   |
| `status` | string | no | One 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.

| Field | Type | Required | Description |
|---|---|---|---|
| `concept` | object | no |   |
| `concept.is_extension` | boolean | no |   |
| `concept.name` | string | no |   |
| `concept.prefix` | string | no |   |
| `concept.qname` | string | no |   |
| `context` | object \| null | no | Null when the fact's contextRef names no context (warning context_missing). |
| `decimals` | string \| null | no | As filed: INF, -3, 0, ...; null when absent. |
| `dims_hash` | string \| null | no | First 16 bytes (hex) of the SHA-256 of the canonical dimensions; null without dimensions. |
| `doc_seq` | integer | no |   |
| `duplicate` | [XbrlDuplicate](#schema-xbrlduplicate) | no |   |
| `entity_cik` | string \| null | no |   |
| `fact_id` | string \| null | no |   |
| `fact_seq` | integer | no | 1..n across every instance of the filing, in reading order. |
| `footnote_nos` | array of integer | no |   |
| `is_nil` | boolean | no |   |
| `is_text_block` | boolean | no |   |
| `period` | [XbrlPeriod](#schema-xbrlperiod) | no |   |
| `precision_raw` | string \| null | no |   |
| `text` | object \| null | no |   |
| `text.document` | string | no |   |
| `text.sha256` | string \| null | no |   |
| `text.span_end` | integer | no |   |
| `text.span_start` | integer | no |   |
| `unit` | object \| null | no |   |
| `unit_norm` | string \| null | no |   |
| `value` | [NullableDecimal](#schema-nullabledecimal) | no |   |
| `value_raw` | string \| null | no |   |
| `xml_lang` | string \| null | no |   |

## Schema: XbrlFilingFacts

| Field | Type | Required | Description |
|---|---|---|---|
| `accession` | string | yes |   |
| `data` | array of [XbrlFact](#schema-xbrlfact) | yes |   |
| `extraction` | [Extraction](#schema-extraction) | yes |   |
| `filing` | [FilingRef](#schema-filingref) | yes |   |
| `footnotes` | array of object | yes |   |
| `has_more` | boolean | yes |   |
| `next_cursor` | string \| null | yes |   |
| `snapshot` | [Snapshot](#schema-snapshot) | yes |   |
| `xbrl` | object \| null | yes | The 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

| Field | Type | Required | Description |
|---|---|---|---|
| `accession` | string | yes |   |
| `category` | string \| null | yes |   |
| `data` | array of [XbrlRole](#schema-xbrlrole) | yes | Role number order, at most 500 a page. |
| `extraction` | [Extraction](#schema-extraction) | yes |   |
| `filing` | [FilingRef](#schema-filingref) | yes |   |
| `has_more` | boolean | yes |   |
| `next_cursor` | string \| null | yes |   |
| `snapshot` | [Snapshot](#schema-snapshot) | yes |   |
| `xbrl_statements` | object \| null | yes |   |

## Schema: XbrlFilingStatements

| Field | Type | Required | Description |
|---|---|---|---|
| `accession` | string | yes |   |
| `data` | array of [XbrlStatement](#schema-xbrlstatement) | yes | At most 25 roles (limit) and 2 MB of statement JSON a page. |
| `extraction` | [Extraction](#schema-extraction) | yes |   |
| `filing` | [FilingRef](#schema-filingref) | yes |   |
| `has_more` | boolean | yes |   |
| `next_cursor` | string \| null | yes |   |
| `roles` | array of object \| null | yes | The 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_more` | boolean | yes |   |
| `snapshot` | [Snapshot](#schema-snapshot) | yes |   |
| `xbrl_statements` | object \| null | yes | Metadata source, documents read, counts, flags; null before a parse. |

## Schema: XbrlFinancialFact

| Field | Type | Required | Description |
|---|---|---|---|
| `accession` | string | no |   |
| `concept` | string | no |   |
| `context_no` | integer \| null | no |   |
| `decimals` | string \| null | no |   |
| `dims` | array of any \| null | no |   |
| `dims_hash` | string \| null | no |   |
| `duplicate` | [XbrlDuplicate](#schema-xbrlduplicate) | no |   |
| `entity_cik` | string \| null | no |   |
| `fact_seq` | integer | no |   |
| `filing` | object | no |   |
| `filing.accepted_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `filing.accepted_at_source` | string \| null | no |   |
| `filing.deleted_at` | date-time (RFC 3339, UTC) \| null | no |   |
| `filing.filing_date` | date (YYYY-MM-DD) \| null | no |   |
| `filing.form_type` | string \| null | no |   |
| `filing.status` | string | no | One of: `provisional`, `final`, `deleted`. |
| `is_nil` | boolean | no |   |
| `is_text_block` | boolean | no |   |
| `legal_entity_member` | string \| null | no |   |
| `period` | [XbrlPeriod](#schema-xbrlperiod) | no |   |
| `unit_norm` | string \| null | no |   |
| `value` | [NullableDecimal](#schema-nullabledecimal) | no |   |
| `value_raw` | string \| null | no |   |

## Schema: XbrlFinancialFactList

| Field | Type | Required | Description |
|---|---|---|---|
| `as_of` | string \| null | yes |   |
| `cik` | string | yes |   |
| `concept` | string | yes |   |
| `data` | array of [XbrlFinancialFact](#schema-xbrlfinancialfact) | yes |   |
| `dims` | string | yes |   |
| `has_more` | boolean | yes |   |
| `next_cursor` | string \| null | yes |   |
| `period` | string \| null | yes |   |

## Schema: XbrlFrame

| Field | Type | Required | Description |
|---|---|---|---|
| `as_of` | string \| null | yes |   |
| `concept` | string | yes |   |
| `data` | array of object | yes |   |
| `data[].accepted_at` | string | no |   |
| `data[].accession` | string | no |   |
| `data[].decimals` | string \| null | no |   |
| `data[].derived_key` | string \| null | no |   |
| `data[].dims_hash` | string \| null | no |   |
| `data[].entity_cik` | string | no |   |
| `data[].fact_seq` | integer \| null | no |   |
| `data[].from_accession` | string | no |   |
| `data[].period` | object | no | With frame only: the fact's own start and end. |
| `data[].source` | string | no | With frame only. One of: `reported`, `derived`. |
| `data[].unit_norm` | string | no |   |
| `data[].valid_from` | string | no |   |
| `data[].value` | [NullableDecimal](#schema-nullabledecimal) | no |   |
| `data[].value_raw` | string \| null | no |   |
| `dims` | string | yes |   |
| `excluded` | [Excluded](#schema-excluded) | no |   |
| `excluded_total` | integer | no |   |
| `frame` | string | no | With frame only: CY2024Q4, CY2024 or CY2024Q4I. |
| `has_more` | boolean | yes |   |
| `next_cursor` | string \| null | yes | Pass as cursor for the next page; null on the last. |
| `period` | string | yes | As requested; with frame, the calendar period's dates (YYYY-MM-DD/YYYY-MM-DD, or the instant). |
| `refused` | object | no | With 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). |
| `rule` | string | no |   |
| `rule_version` | string | no |   |
| `unit` | string \| null | no |   |

## Schema: XbrlPeriod

| Field | Type | Required | Description |
|---|---|---|---|
| `end` | date (YYYY-MM-DD) \| null | no |   |
| `start` | date (YYYY-MM-DD) \| null | no |   |
| `type` | string | no | One 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

| Field | Type | Required | Description |
|---|---|---|---|
| `as_of` | string \| null | yes |   |
| `cik` | string | yes |   |
| `concept` | string | yes |   |
| `data` | array of object | yes |   |
| `data[].accession` | string | no |   |
| `data[].decimals` | string \| null | no |   |
| `data[].dup_inconsistent` | boolean | no |   |
| `data[].fact_seq` | integer | no |   |
| `data[].filing` | object | no |   |
| `data[].identity` | object | no |   |
| `data[].identity.dims_hash` | string \| null | no |   |
| `data[].identity.period` | [XbrlPeriod](#schema-xbrlperiod) | no |   |
| `data[].identity.unit_norm` | string | no |   |
| `data[].is_nil` | boolean | no |   |
| `data[].revision` | object | no | number: 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[].value` | [NullableDecimal](#schema-nullabledecimal) | no |   |
| `data[].value_raw` | string \| null | no |   |
| `dims` | string | yes |   |
| `excluded` | [Excluded](#schema-excluded) | no |   |
| `excluded_total` | integer | no |   |
| `has_more` | boolean | yes |   |
| `next_cursor` | null | yes |   |
| `view` | string | yes | One of: `latest`, `first_reported`, `revisions`. |

## Schema: XbrlStandardFrame

| Field | Type | Required | Description |
|---|---|---|---|
| `accuracy` | object | no | Measured precision and coverage of the field on the named map version (static; contract 2.9). |
| `as_of` | string \| null | yes |   |
| `data` | array of [XbrlStdValue](#schema-xbrlstdvalue) | yes | One 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. |
| `excluded` | [Excluded](#schema-excluded) | yes |   |
| `excluded_total` | integer | yes |   |
| `field` | string | yes |   |
| `frame` | string | yes |   |
| `has_more` | boolean | yes |   |
| `limit` | integer | yes | Companies with a value per page. |
| `map` | object | yes |   |
| `next_cursor` | string \| null | yes | Opaque: the companies after this page, same filters. |
| `period` | string | yes |   |
| `refused` | object | yes | Companies left out by status: ambiguous, not_reported, not_applicable, basis_mismatch, refused_\*. |
| `rule` | string | yes |   |
| `ttm` | boolean | yes | true: each value is the trailing twelve months ending in the frame's quarter. |
| `view` | string | yes |   |

## Schema: XbrlStatement

| Field | Type | Required | Description |
|---|---|---|---|
| `calculation` | array of object | no |   |
| `calculation[].child` | string | no |   |
| `calculation[].order` | [NullableDecimal](#schema-nullabledecimal) | no |   |
| `calculation[].order_raw` | string \| null | no |   |
| `calculation[].parent` | string | no |   |
| `calculation[].weight` | [NullableDecimal](#schema-nullabledecimal) | no |   |
| `calculation[].weight_raw` | string \| null | no |   |
| `columns` | array of object | no |   |
| `columns[].days` | integer \| null | no |   |
| `columns[].is_document_period` | boolean | no |   |
| `columns[].period` | [XbrlPeriod](#schema-xbrlperiod) | no |   |
| `layout` | object | no | The 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.kind` | string | no | One of: `tree`, `roll_forward`. |
| `layout.rows` | array of object | no |   |
| `layout.rows[].column` | integer \| null | no |   |
| `layout.rows[].members` | string \| null | no |   |
| `layout.rows[].seq` | integer | no |   |
| `matches_sec_render` | boolean \| null | no | Compared 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. |
| `role` | object | no | role_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). |
| `rows` | array of object | no |   |
| `rows[].cells` | array of [XbrlStatementCell](#schema-xbrlstatementcell) | no |   |
| `rows_from_seq` | integer | no | The first row (seq) served here: 1, or where a role cut by the previous page's row budget continues. |
| `rows_has_more` | boolean | no | The role's later rows are on the next page (the page's 2 MB were reached). The calculation comes with the first part only. |
| `warnings` | array of object | no | On 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.

| Field | Type | Required | Description |
|---|---|---|---|
| `decimals` | string \| null | no |   |
| `entity_cik` | string \| null | no |   |
| `fact_seq` | integer | no |   |
| `is_nil` | boolean | no |   |
| `is_text_block` | boolean | no |   |
| `text` | object | no |   |
| `unit_norm` | string \| null | no |   |
| `value` | [NullableDecimal](#schema-nullabledecimal) | no |   |
| `value_raw` | string \| null | no |   |

## 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.
