{"openapi":"3.0.3","info":{"title":"Finks API","version":"v2026.11.13.4","description":"Search financial news, filings and market data by meaning. Docs: https://finks.ai/docs."},"servers":[{"url":"https://data.finks.ai"}],"externalDocs":{"description":"Finks API docs","url":"https://finks.ai/docs"},"tags":[{"name":"Search","description":"Find the news, filings and calls behind any market question.","externalDocs":{"url":"https://finks.ai/docs/reference/search"}},{"name":"Records","description":"Go from a search result to the full story.","externalDocs":{"url":"https://finks.ai/docs/reference/records"}},{"name":"Screener","description":"Find the companies that match your criteria.","externalDocs":{"url":"https://finks.ai/docs/reference/screener"}},{"name":"Company and filings","description":"Follow a company's filings and news as they land.","externalDocs":{"url":"https://finks.ai/docs/reference/filings"}},{"name":"Account","description":"Check your plan, your usage and what your key can reach.","externalDocs":{"url":"https://finks.ai/docs/reference/account"}}],"paths":{"/v1/account":{"get":{"operationId":"get_account","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountView"}}},"description":"The calling account's state for the current billing period, with its sign-up profile"},"401":{"description":"Missing, unknown, revoked, or expired key"}},"security":[{"bearerAuth":[]}],"tags":["Account"],"x-tier":"free","summary":"Account","description":"Your account and its plan limits.","externalDocs":{"url":"https://finks.ai/docs/reference/account#get-v1-account"}}},"/v1/account/keys":{"get":{"operationId":"get_account_keys","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountKeysView"}}},"description":"The calling account's masked keys"},"401":{"description":"Missing, unknown, revoked, or expired key"}},"security":[{"bearerAuth":[]}],"tags":["Account"],"x-tier":"free","summary":"Keys","description":"The account's keys, masked, with each one's environment and status.","externalDocs":{"url":"https://finks.ai/docs/reference/account#get-v1-account-keys"}}},"/v1/account/usage":{"get":{"operationId":"get_account_usage","parameters":[{"description":"The month, `YYYY-MM`. Default: the current UTC month.","in":"query","name":"period","required":false,"schema":{"nullable":true,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountUsageView"}}},"description":"The calling account's recorded usage for one billing period"},"400":{"description":"`request.invalid`, a malformed or repeated `period`"},"401":{"description":"Missing, unknown, revoked, or expired key"}},"security":[{"bearerAuth":[]}],"tags":["Account"],"x-tier":"free","summary":"Usage","description":"Usage for one month, the current UTC month by default, per billable unit.","externalDocs":{"url":"https://finks.ai/docs/reference/account#get-v1-account-usage"}}},"/v1/companies/{symbol}/events":{"get":{"operationId":"get_company_events","parameters":[{"description":"The company's ticker.","in":"path","name":"symbol","required":true,"schema":{"type":"string"}},{"description":"Comma list of `brief`, `article`, `filing`. Default: every type the plan covers.","in":"query","name":"types","required":false,"schema":{"nullable":true,"type":"string"}},{"description":"Comma list of event-type slugs (`earnings`, `m_and_a`, ...): only items carrying any of them. An item with no event type is excluded while it is set. Unset, the filings are the 8-Ks and the Form 4 (`insider_transaction`), Form 144 (`insider_sale_notice`) and Schedule 13D/13G (`beneficial_ownership`) filings; the other SEC form filings (`ownership_stake`, `initial_holding`, `insider_annual_transaction`, `late_filing_notice`, `delisting_notice`, `registration_termination`) are listed only when named here.","in":"query","name":"event_types","required":false,"schema":{"nullable":true,"type":"string"}},{"description":"RFC 3339, inclusive. Default: the start of the plan's history window.","in":"query","name":"published_after","required":false,"schema":{"nullable":true,"type":"string"}},{"description":"RFC 3339, exclusive.","in":"query","name":"published_before","required":false,"schema":{"nullable":true,"type":"string"}},{"description":"Results per page: at least 1, at most your plan's page cap. Default 10, or the cap if lower.","in":"query","name":"limit","required":false,"schema":{"format":"int32","minimum":0,"nullable":true,"type":"integer"}},{"description":"The `next_cursor` of the previous page. Leave it out for the first page.","in":"query","name":"cursor","required":false,"schema":{"nullable":true,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyEventsResponse"}}},"description":"The company's items, newest first","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"`request.invalid` naming the parameter, `request.out_of_plan` naming the allowance, or `invalid_cursor`","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"401":{"description":"Missing, unknown, revoked, or expired key"},"404":{"description":"`not_found`, no company is listed under this symbol","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"429":{"description":"Rate limited, quota denied, or spend cap reached","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"501":{"description":"The plan grants no serving limit","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"503":{"description":"`content.unresolved`, the company lookup or a pool could not answer","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"security":[{"bearerAuth":[]}],"summary":"Company timeline","tags":["Company and filings"],"x-tier":"free","description":"One company's filings and coverage, newest first.","externalDocs":{"url":"https://finks.ai/docs/reference/filings#get-v1-companies-symbol-events"}}},"/v1/content":{"get":{"operationId":"get_content","parameters":[{"description":"`filing`, the type this route lists.","in":"query","name":"type","required":false,"schema":{"nullable":true,"type":"string"}},{"description":"ANY within, AND across filters.","in":"query","name":"symbols","required":false,"schema":{"nullable":true,"type":"string"}},{"description":"Canonical entity ids.","in":"query","name":"entities","required":false,"schema":{"nullable":true,"type":"string"}},{"description":"`any` (default) or `all`. Without `entities`, a 400.","in":"query","name":"entity_match","required":false,"schema":{"nullable":true,"type":"string"}},{"in":"query","name":"sectors","required":false,"schema":{"nullable":true,"type":"string"},"description":"Accepted and ignored: it filters nothing today."},{"description":"Taxonomy facet.","in":"query","name":"themes","required":false,"schema":{"nullable":true,"type":"string"}},{"description":"Matches the scalar `event_type` or the `event_types[]` array. Each slug must be on the event-type allowlist; any other is a 400.","in":"query","name":"event_types","required":false,"schema":{"nullable":true,"type":"string"}},{"description":"Taxonomy facet.","in":"query","name":"geos","required":false,"schema":{"nullable":true,"type":"string"}},{"in":"query","name":"form","required":false,"schema":{"nullable":true,"type":"string"}},{"in":"query","name":"cik","required":false,"schema":{"nullable":true,"type":"string"}},{"description":"RFC 3339, inclusive. Half-open interval with `published_before`.","in":"query","name":"published_after","required":false,"schema":{"nullable":true,"type":"string"}},{"description":"RFC 3339, exclusive.","in":"query","name":"published_before","required":false,"schema":{"nullable":true,"type":"string"}},{"in":"query","name":"min_confidence","required":false,"schema":{"nullable":true,"type":"string"}},{"in":"query","name":"include_full_text","required":false,"schema":{"nullable":true,"type":"boolean"},"description":"Ask for the raw primary-document text. Not every document can be served in full: read `full_text_status` for the outcome."},{"description":"The `next_cursor` of the previous page. Leave it out for the first page.","in":"query","name":"cursor","required":false,"schema":{"nullable":true,"type":"string"}},{"description":"Results per page: at least 1, at most your plan's page cap. Default 10, or the cap if lower.","in":"query","name":"limit","required":false,"schema":{"format":"int32","minimum":0,"nullable":true,"type":"integer"}},{"description":"`full` (default): the full record. `compact`: one small `CompactFilingRecord` per filing (no evidence, citations, facets, versions or rights fields) and a `summary` block; the page is a `CompactContentPage`. Compact takes no `include_full_text=true`.","in":"query","name":"view","required":false,"schema":{"nullable":true,"type":"string"}},{"description":"`asc` (default): oldest first. `desc`: newest first. The cursor binds the order.","in":"query","name":"order","required":false,"schema":{"nullable":true,"type":"string"}},{"description":"`accession`, with `view=compact` only: filings sharing an accession on the page collapse into the first one's entry, the rest under its `parts`.","in":"query","name":"group_by","required":false,"schema":{"nullable":true,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentPage"}}},"description":"One page of filing records: a `ContentPage`, or a `CompactContentPage` under `view=compact`","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"`request.invalid`, `invalid_cursor`, or `request.out_of_plan` naming `filing`","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"401":{"description":"Missing, unknown, revoked, or expired key"},"429":{"description":"Rate limited, quota denied, or spend cap reached","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"501":{"description":"A parameter this deployment cannot honestly answer","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"503":{"description":"`content.unresolved`, the read did not resolve","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"security":[{"bearerAuth":[]}],"summary":"Filing feed","tags":["Company and filings"],"x-tier":"free","description":"SEC filings, newest first, filtered by form, company and date.","externalDocs":{"url":"https://finks.ai/docs/reference/filings#get-v1-content"}}},"/v1/content/{id}":{"get":{"operationId":"get_content_by_id","parameters":[{"description":"A search result's `id`. It is opaque: pass it as it came.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContentRecord"}}},"description":"The whole record","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"`request.invalid`, not an id this API serves; `request.out_of_plan` naming `type`, the plan does not cover the id's pool","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"401":{"description":"Missing, unknown, revoked, or expired key"},"410":{"description":"`withdrawn`, no servable record carries this id","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"429":{"description":"Rate limited or quota denied","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"503":{"description":"`content.unresolved`, the read did not resolve","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"security":[{"bearerAuth":[]}],"summary":"Read a record","tags":["Records"],"x-tier":"free","description":"The full record behind a result `id`: summary, evidence, body or transcript, and a filing's sections.","externalDocs":{"url":"https://finks.ai/docs/reference/records#get-v1-content-id"}}},"/v1/datasets":{"get":{"operationId":"get_datasets","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetsResponse"}}},"description":"Every pool, dataset and route-only name, and whether this key's plan includes it"},"401":{"description":"Missing, unknown, revoked, or expired key"}},"security":[{"bearerAuth":[]}],"tags":["Account"],"x-tier":"free","summary":"Datasets","description":"Every dataset Finks serves, with its routes and source, and whether your plan includes it.","externalDocs":{"url":"https://finks.ai/docs/reference/account#get-v1-datasets"}}},"/v1/events/{ledger_event_id}":{"get":{"operationId":"get_ledger_record","parameters":[{"description":"A filing's `ledger_event_id`, from a search result or the filing feed.","in":"path","name":"ledger_event_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventLedgerRecord"}}},"description":"The event and its current filing","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"`request.invalid`, not a ledger id; `request.out_of_plan`, the plan does not cover `filing`","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"401":{"description":"Missing, unknown, revoked, or expired key"},"404":{"description":"`not_found`, the ledger serves no event under this id","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"429":{"description":"Rate limited or quota denied","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"503":{"description":"`content.unresolved`, the ledger or the filing read did not resolve","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"security":[{"bearerAuth":[]}],"summary":"Filing event","tags":["Records"],"x-tier":"free","description":"One real-world event across its 8-K and every 8-K/A, with the filing record that currently states its facts. An old event id answers with the event it now belongs to.","externalDocs":{"url":"https://finks.ai/docs/reference/records#get-v1-events-ledger-event-id"}}},"/v1/screener":{"post":{"operationId":"post_screener","parameters":[{"in":"query","name":"view","required":false,"schema":{"nullable":true,"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenerRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenerResponse"}}},"description":"One page of the screen, ordered by the ranking (or symbol), with coverage. A screen matching nothing is a 200 with empty `data`. A `natural_language` screen, or one leaving a default implicit, also carries `interpretation` (`defaults_applied`); `normalized_query` states every default and reruns the screen without a model. Under `view=compact`, a `CompactScreenerPage` (`results[]`), each row's `as_of` naming the values dated differently from the page.","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"`request.invalid` naming the body field or the query parameter (`view`), `request.out_of_plan` naming the allowance (`query.limit` above the plan's screener cap: `screener_search`'s `page_cap`, Free 10 / Starter 50 / Pro 100 / Scale 100; `query.limit` above 100 is `request.invalid`), `invalid_filter`, `unsupported_subject`, `unsupported_field_for_subject` naming the field, `unresolvable_query` (an `as_of` other than the current snapshot, or `natural_language` that maps to nothing: `reason: nothing_mapped`), `invalid_cursor`, or `cursor_expired` (the snapshot was rebuilt)","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"401":{"description":"Missing, unknown, revoked, or expired key"},"413":{"description":"`request.too_large`, the body is over the 2 MB limit","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"429":{"description":"Rate limited, quota denied, or spend cap reached","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"501":{"description":"`natural_language` from an account it is not enabled for, an operation other than `filter` or `rank`, or the plan grants no serving limit","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"503":{"description":"`content.unresolved`, the screen could not be read, or `natural_language` could not be compiled (`reason: compile`)","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"security":[{"bearerAuth":[]}],"summary":"Screen companies","tags":["Screener"],"x-tier":"free","description":"Companies that pass your filters, ranked by any field.","externalDocs":{"url":"https://finks.ai/docs/reference/screener#post-v1-screener"}}},"/v1/screener/fields":{"get":{"operationId":"get_screener_fields","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScreenerFieldCatalogResponse"}}},"description":"Every screener field: type, unit, operators, basis, live enum values for text fields, freshness source, rights, and whether it is servable today"},"401":{"description":"Missing, unknown, revoked, or expired key"}},"security":[{"bearerAuth":[]}],"summary":"Screener fields","tags":["Screener"],"x-tier":"free","description":"Every field you can filter, rank or return.","externalDocs":{"url":"https://finks.ai/docs/reference/screener#get-v1-screener-fields"}}},"/v1/search":{"post":{"operationId":"post_search","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"}}},"description":"Ranked results, best first","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"400":{"description":"`request.invalid` naming the field, `request.out_of_plan` naming the allowed value, `invalid_cursor`, or `cursor_expired`","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"401":{"description":"Missing, unknown, revoked, or expired key"},"413":{"description":"`request.too_large`, the body is over the 2 MB limit","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"429":{"description":"Rate limited, quota denied, or spend cap reached","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"501":{"description":"The plan grants no serving limit","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}},"503":{"description":"`content.unresolved`, a pool `types` names, or every pool searched, could not answer","headers":{"X-Credits-Remaining":{"$ref":"#/components/headers/X-Credits-Remaining"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}}}},"security":[{"bearerAuth":[]}],"summary":"Search","tags":["Search"],"x-tier":"free","description":"Searches briefs, articles, filings and earnings call transcripts, best match first. Read any result in full with GET /v1/content/{id}.","externalDocs":{"url":"https://finks.ai/docs/reference/search#post-v1-search"}}},"/v1/search/fields":{"get":{"operationId":"get_search_fields","parameters":[{"description":"`tool_schema` returns the catalog as a tool-call schema an agent framework registers directly.","in":"query","name":"format","required":false,"schema":{"nullable":true,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchFieldsResponse"}}},"description":"The field catalog, or the tool-call schema under `format=tool_schema`"},"400":{"description":"`request.invalid`, an unknown parameter or `format` value"},"401":{"description":"Missing, unknown, revoked, or expired key"},"503":{"description":"`content.unresolved`, no pool could report its depth"}},"security":[{"bearerAuth":[]}],"summary":"Search fields","tags":["Search"],"x-tier":"free","description":"What your key can search: pools, datasets, event types and result fields. `format=tool_schema` returns a ready tool definition.","externalDocs":{"url":"https://finks.ai/docs/reference/search#get-v1-search-fields"}}}},"components":{"headers":{"X-Credits-Remaining":{"schema":{"format":"int64","minimum":0,"type":"integer"}},"X-RateLimit-Limit":{"schema":{"format":"int64","minimum":1,"type":"integer"}},"X-RateLimit-Remaining":{"description":"Requests left of `X-RateLimit-Limit` in the current minute after this one; `0` on its `429 rate_limit.exceeded`. Present with `X-RateLimit-Limit`.","schema":{"format":"int64","minimum":0,"type":"integer"}},"X-RateLimit-Reset":{"description":"Whole seconds (1-60) until the minute ends and the count restarts; equal to `Retry-After` on the per-minute limit's `429`. Present with `X-RateLimit-Limit`.","schema":{"format":"int64","minimum":1,"type":"integer"}}},"schemas":{"AccountFeature":{"description":"A customer-visible feature flag on for the account.","properties":{"label":{"description":"Its public label, up to 60 characters of product wording (for people).","type":"string"},"name":{"description":"The flag's name (stable; for code).","type":"string"}},"required":["name","label"],"type":"object"},"AccountKeysView":{"description":"`GET /v1/account/keys`.","properties":{"account_id":{"type":"string"},"keys":{"$ref":"#/components/schemas/KeysView"}},"required":["account_id","keys"],"type":"object"},"AccountPeriodView":{"properties":{"label":{"description":"The account period's label, the shared S4 counter rule: `YYYY-MM` when the period starts at a UTC 1st 00:00:00 (every calendar account), else its start, `YYYY-MM-DDTHH:MM:SSZ`.","type":"string"},"period":{"description":"UTC calendar month, `YYYY-MM`, that the `units` usage figures cover.","type":"string"},"resets_at":{"description":"When the account period ends and the next begins, RFC 3339 UTC: the next UTC month start, or the next anchored boundary. Arithmetic on the period, never a configured cycle length.","type":"string"},"starts_at":{"description":"First instant of the account period, RFC 3339 UTC.","type":"string"}},"required":["period","label","starts_at","resets_at"],"type":"object"},"AccountProfile":{"additionalProperties":false,"properties":{"account_type":{"$ref":"#/components/schemas/AccountType"},"company_name":{"description":"The company's name, by `name`'s rules: required for `company`, `null` for `individual`.","nullable":true,"type":"string"},"country":{"description":"ISO 3166-1 alpha-2, upper case.","type":"string"},"name":{"description":"The person's name: 1-200 characters, trimmed, inner whitespace collapsed, no control characters.","type":"string"},"use_case":{"$ref":"#/components/schemas/UseCase"}},"required":["name","account_type","country","use_case"],"type":"object"},"AccountSealsView":{"properties":{"account_id":{"type":"string"},"next_cursor":{"description":"Pass as `cursor` (same `from`/`to`) for the next page; `null` on the last.","nullable":true,"type":"string"},"seals":{"items":{"$ref":"#/components/schemas/Seal"},"type":"array"}},"required":["account_id","seals","next_cursor"],"type":"object"},"AccountStateView":{"description":"`GET /v1/account`, the whole account state in one read.","properties":{"account_id":{"type":"string"},"alert_thresholds":{"$ref":"#/components/schemas/SettingView"},"keys":{"$ref":"#/components/schemas/KeysView"},"metering":{"$ref":"#/components/schemas/MeteringView"},"period":{"$ref":"#/components/schemas/AccountPeriodView"},"spend_cap":{"$ref":"#/components/schemas/SettingView"},"units":{"items":{"$ref":"#/components/schemas/UnitStateView"},"type":"array"}},"required":["account_id","period","metering","keys","units","spend_cap","alert_thresholds"],"type":"object"},"AccountType":{"enum":["individual","company"],"type":"string"},"AccountUsageView":{"description":"`GET /v1/account/usage`.","properties":{"account_id":{"type":"string"},"metering":{"$ref":"#/components/schemas/MeteringView"},"period":{"$ref":"#/components/schemas/PeriodView"},"units":{"items":{"$ref":"#/components/schemas/UnitStateView"},"type":"array"}},"required":["account_id","period","metering","units"],"type":"object"},"AccountView":{"allOf":[{"$ref":"#/components/schemas/AccountStateView"},{"properties":{"agent_search_daily_jobs":{"allOf":[{"$ref":"#/components/schemas/ResearchDailyJobs"}],"nullable":true},"features":{"items":{"$ref":"#/components/schemas/AccountFeature"},"type":"array"},"profile":{"allOf":[{"$ref":"#/components/schemas/AccountProfile"}],"nullable":true},"research_daily_jobs":{"allOf":[{"$ref":"#/components/schemas/ResearchDailyJobs"}],"nullable":true}},"required":["profile","research_daily_jobs","agent_search_daily_jobs","features"],"type":"object"}]},"ApiError":{"properties":{"code":{"$ref":"#/components/schemas/ErrorCode"},"details":{"nullable":true},"message":{"type":"string"},"request_id":{"$ref":"#/components/schemas/RequestId"}},"required":["code","message","request_id"],"type":"object"},"AppliedDefault":{"description":"One default the compiler applied because the caller did not state it explicitly.","properties":{"field":{"type":"string"},"value":{}},"required":["field","value"],"type":"object"},"AuditAction":{"description":"What changed. New actions are additions.","enum":["key.created","key.rotated","key.revoked","key.updated","entitlements.updated","feature_access_changed"],"type":"string"},"AuditActor":{"properties":{"email":{"nullable":true,"type":"string"},"id":{"nullable":true,"type":"string"},"kind":{"$ref":"#/components/schemas/AuditActorKind"},"role":{"nullable":true,"type":"string"}},"required":["kind"],"type":"object"},"AuditActorKind":{"enum":["console","billing","operator","identity","system"],"type":"string"},"AuditEvent":{"properties":{"account_id":{"type":"string"},"action":{"$ref":"#/components/schemas/AuditAction"},"actor":{"$ref":"#/components/schemas/AuditActor"},"at":{"description":"RFC 3339 UTC, millisecond precision.","type":"string"},"changes":{"description":"Per changed field: `{\"from\": …, \"to\": …}` for a value the customer already sees, `{\"withheld\": true}` for one it does not (credit and pricing fields). On `feature_access_changed`: `{\"feature\": <public label>, \"enabled\": bool}`.","type":"object"},"event_id":{"description":"`evt_…`.","type":"string"},"key_id":{"description":"The key the action is about (on `key.rotated`, the new key); absent for plan changes.","nullable":true,"type":"string"}},"required":["event_id","account_id","at","actor","action","changes"],"type":"object"},"AuditPage":{"description":"One page of the audit log, newest first: `GET /v1/account/audit` and `read_audit`.","properties":{"has_more":{"type":"boolean"},"next_cursor":{"description":"Pass back as `cursor` for the next (older) page; `null` on the last page.","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/AuditEvent"},"type":"array"}},"required":["results","has_more"],"type":"object"},"Chart":{"description":"A line or bar chart (`x`, `y`, wide `rows`: every `y[].field` in every row, a number or `null`), or a table (`columns`, `rows`).","properties":{"as_of":{"nullable":true,"type":"string"},"columns":{"items":{"$ref":"#/components/schemas/ChartField"},"type":"array"},"kind":{"$ref":"#/components/schemas/ChartKind"},"rows":{"items":{"type":"object"},"type":"array"},"title":{"type":"string"},"x":{"allOf":[{"$ref":"#/components/schemas/ChartAxis"}],"nullable":true},"y":{"items":{"$ref":"#/components/schemas/ChartField"},"type":"array"}},"required":["kind","title","rows"],"type":"object"},"ChartAxis":{"properties":{"field":{"type":"string"},"label":{"type":"string"},"type":{"$ref":"#/components/schemas/ChartXType"}},"required":["field","type","label"],"type":"object"},"ChartField":{"properties":{"field":{"type":"string"},"label":{"type":"string"},"unit":{"nullable":true,"type":"string"}},"required":["field","label"],"type":"object"},"ChartKind":{"enum":["line","bar","table"],"type":"string"},"ChartSource":{"description":"What the rows cite: a result's link, or the route the data came from.","properties":{"as_of":{"nullable":true,"type":"string"},"attribution":{"description":"A research chart's rows' publisher attribution and terms link (as its citations carry them); absent on `POST /v1/workflows/chart`.","nullable":true,"type":"string"},"route":{"nullable":true,"type":"string"},"terms_url":{"nullable":true,"type":"string"},"title":{"type":"string"},"url":{"nullable":true,"type":"string"}},"required":["title"],"type":"object"},"ChartXType":{"enum":["time","category","number"],"type":"string"},"CitationAnchor":{"description":"Half-open Unicode-codepoint span into the cited section's exact text.","properties":{"end":{"format":"int32","minimum":0,"type":"integer"},"start":{"format":"int32","minimum":0,"type":"integer"}},"required":["start","end"],"type":"object"},"ClinicalTrial":{"properties":{"attribution":{"description":"ClinicalTrials.gov's attribution and Finks' modifications: show it wherever the row is shown, with `source_url` and `last_update_posted`.","type":"string"},"brief_title":{"nullable":true,"type":"string"},"collaborator_ciks":{"items":{"type":"string"},"type":"array"},"collaborator_names":{"description":"The collaborators as filed, and the SEC issuer CIKs they resolve to.","items":{"type":"string"},"type":"array"},"completion_date":{"nullable":true,"type":"string"},"completion_date_precision":{"nullable":true,"type":"string"},"completion_date_type":{"nullable":true,"type":"string"},"conditions":{"items":{"type":"string"},"type":"array"},"enrollment":{"format":"int32","nullable":true,"type":"integer"},"enrollment_type":{"description":"`ACTUAL` or `ESTIMATED`.","nullable":true,"type":"string"},"first_posted":{"description":"`YYYY-MM-DD`.","nullable":true,"type":"string"},"has_results":{"nullable":true,"type":"boolean"},"intervention_names":{"description":"In the study's order, beside `intervention_types`.","items":{"nullable":true,"type":"string"},"type":"array"},"intervention_types":{"items":{"type":"string"},"type":"array"},"last_update_posted":{"description":"`YYYY-MM-DD`: what pages; ClinicalTrials.gov's processed date for the attribution.","type":"string"},"lead_sponsor_class":{"description":"`INDUSTRY`, `NIH`, `OTHER_GOV`, ….","nullable":true,"type":"string"},"mapping_basis":{"description":"`self`, `parent_seed` or `unlisted_self`.","nullable":true,"type":"string"},"nct_id":{"description":"`NCT05992935`.","type":"string"},"org_study_id":{"nullable":true,"type":"string"},"overall_status":{"description":"`RECRUITING`, `ACTIVE_NOT_RECRUITING`, `COMPLETED`, `TERMINATED`, `UNKNOWN`, … (an open study unverified for 2 years is `UNKNOWN`, CT.gov's display rule).","nullable":true,"type":"string"},"phases":{"description":"`EARLY_PHASE1`, `PHASE1`…`PHASE4` or `NA`; two for a phase 1/2 study.","items":{"type":"string"},"type":"array"},"primary_completion_date":{"nullable":true,"type":"string"},"primary_completion_date_precision":{"nullable":true,"type":"string"},"primary_completion_date_type":{"nullable":true,"type":"string"},"results_first_posted":{"nullable":true,"type":"string"},"source_url":{"description":"The study on clinicaltrials.gov.","type":"string"},"sponsor_cik":{"nullable":true,"type":"string"},"sponsor_name":{"nullable":true,"type":"string"},"sponsor_own_cik":{"nullable":true,"type":"string"},"sponsor_symbol":{"nullable":true,"type":"string"},"start_date":{"nullable":true,"type":"string"},"start_date_precision":{"nullable":true,"type":"string"},"start_date_type":{"nullable":true,"type":"string"},"status_verified_date":{"nullable":true,"type":"string"},"study_type":{"description":"`INTERVENTIONAL`, `OBSERVATIONAL` or `EXPANDED_ACCESS`.","nullable":true,"type":"string"},"why_stopped":{"nullable":true,"type":"string"}},"required":["nct_id","last_update_posted","attribution","source_url"],"type":"object"},"ClinicalTrialsResponse":{"description":"`GET /v1/clinical-trials`: a company's clinical trials, most recently updated first.","properties":{"attribution":{"description":"ClinicalTrials.gov's attribution, as on every row: show it wherever the data is shown. Absent on an empty page.","nullable":true,"type":"string"},"has_more":{"type":"boolean"},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"},"results":{"description":"By `(last_update_posted, nct_id)` descending, at most `limit`, never before the plan's history window; may be empty.","items":{"$ref":"#/components/schemas/ClinicalTrial"},"type":"array"}},"required":["results","has_more"],"type":"object"},"CommodityObservation":{"description":"One day's spot price.","properties":{"attribution":{"description":"The citation to show with the price.","type":"string"},"currency":{"type":"string"},"date":{"description":"`YYYY-MM-DD`, the trading day the price is for.","type":"string"},"price":{"description":"The spot price as published, in `unit` (never converted).","format":"double","type":"number"},"source":{"description":"The publisher: `EIA`.","type":"string"},"unit":{"type":"string"}},"required":["date","price","unit","currency","source","attribution"],"type":"object"},"CommodityObservationsResponse":{"description":"`GET /v1/commodities/series/{series_id}/observations`: one series, newest day first.","properties":{"has_more":{"type":"boolean"},"label":{"description":"The series' short label, as `GET /v1/commodities/series` gives it; absent for a series not yet curated.","nullable":true,"type":"string"},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"},"results":{"description":"By `date` descending, at most `limit`, may be empty.","items":{"$ref":"#/components/schemas/CommodityObservation"},"type":"array"},"series_id":{"type":"string"}},"required":["series_id","results","has_more"],"type":"object"},"CommoditySeries":{"properties":{"area":{"description":"The delivery area the publisher names (`NEW YORK CITY`), when it names one.","nullable":true,"type":"string"},"attribution":{"description":"The citation to show with any of its prices.","type":"string"},"commodity":{"description":"The product priced (`Natural Gas`, `WTI Crude Oil`, `Propane`).","type":"string"},"currency":{"type":"string"},"first_date":{"description":"`YYYY-MM-DD`, the first day served.","type":"string"},"frequency":{"description":"`daily`: one price per trading day.","type":"string"},"label":{"description":"A short human label, at most 40 characters (`RWTC`: `WTI crude oil spot price`); EIA's `name` for a series not yet curated.","type":"string"},"last_date":{"description":"`YYYY-MM-DD`, the latest day published.","type":"string"},"name":{"description":"The publisher's name for the series (`Henry Hub Natural Gas Spot Price (Dollars per Million Btu)`).","type":"string"},"series_id":{"description":"The publisher's series id, as published (`RNGWHHD`: Henry Hub natural gas; `RWTC`: WTI crude at Cushing; `RBRTE`: Brent).","type":"string"},"source":{"description":"The publisher: `EIA`.","type":"string"},"unit":{"description":"`USD per MMBtu`, `USD per barrel` or `USD per gallon`.","type":"string"}},"required":["series_id","name","commodity","unit","currency","frequency","source","attribution","first_date","last_date"],"type":"object"},"CommoditySeriesResponse":{"description":"`GET /v1/commodities/series`: every commodity price series served, by `series_id`.","properties":{"results":{"items":{"$ref":"#/components/schemas/CommoditySeries"},"type":"array"}},"required":["results"],"type":"object"},"CompactAttribution":{"properties":{"fields":{"description":"The page's fields whose values it covers.","items":{"type":"string"},"type":"array"},"source":{"description":"`ecb`.","type":"string"},"text":{"description":"The attribution text, verbatim; it must be shown wherever these values are.","type":"string"},"url":{"nullable":true,"type":"string"}},"required":["source","text","fields"],"type":"object"},"CompactContentPage":{"description":"One `view=compact` page of `/v1/content`: the shared envelope plus `summary`.","properties":{"data":{"items":{"$ref":"#/components/schemas/CompactFilingRecord"},"type":"array"},"has_more":{"type":"boolean"},"next_cursor":{"nullable":true,"type":"string"},"summary":{"$ref":"#/components/schemas/ContentSummary"}},"required":["data","has_more","summary"],"type":"object"},"CompactFilingRecord":{"description":"One filing in a `view=compact` listing (finks-api#433): what an agent needs to scan a feed and pick what to fetch. No evidence, citations, facets, versions or rights fields; the full record stays on `GET /v1/content/{id}` and the default view.","properties":{"company":{"description":"EDGAR's name for the filer of record; `null` when unnamed.","nullable":true,"type":"string"},"confidence":{"allOf":[{"$ref":"#/components/schemas/ConfidenceTier"}],"nullable":true},"event_id":{"type":"string"},"event_type":{"nullable":true,"type":"string"},"filed_at":{"type":"string"},"form":{"type":"string"},"headline":{"type":"string"},"item":{"type":"string"},"parts":{"items":{"$ref":"#/components/schemas/CompactFilingRecord"},"type":"array"},"symbol":{"nullable":true,"type":"string"},"url":{"description":"The cited document on EDGAR (`citation.source_url` on the full record).","type":"string"}},"required":["event_id","filed_at","form","item","headline","url"],"type":"object"},"CompactScreenerAsOf":{"description":"The dates a compact page's values are current as of.","properties":{"fundamentals":{"description":"The newest date of the TTM or FY values on the page (a TTM build date, or the latest fiscal period end; each row's FY period is its `fiscal_period_end_date`). `null` when no fundamentals field is requested.","nullable":true,"type":"string"},"market":{"description":"The snapshot the market and profile values were read from (`normalized_query.as_of`); a row whose own market date differs says so (`as_of_market`).","type":"string"},"quote":{"nullable":true,"type":"string"}},"required":["market"],"type":"object"},"CompactScreenerPage":{"properties":{"as_of":{"$ref":"#/components/schemas/CompactScreenerAsOf"},"attribution":{"description":"Present whenever a value on the page needs one (an ECB-converted field).","items":{"$ref":"#/components/schemas/CompactAttribution"},"type":"array"},"interpretation":{"allOf":[{"$ref":"#/components/schemas/Interpretation"}],"nullable":true},"next_cursor":{"nullable":true,"type":"string"},"normalized_query":{"$ref":"#/components/schemas/NormalizedQuery"},"results":{"description":"In ranking order (or `symbol` ascending), as `data` on the full view.","items":{"$ref":"#/components/schemas/CompactScreenerRow"},"type":"array"},"total_matched":{"description":"Every company the screen matches (`total_count` on the full view).","format":"int64","minimum":0,"type":"integer"}},"required":["results","total_matched","as_of","normalized_query"],"type":"object"},"CompactScreenerRow":{"additionalProperties":{"description":"Each requested field (`normalized_query.requested_fields`) by its catalog name, as a plain value."},"properties":{"as_of":{"additionalProperties":{"type":"string"},"type":"object"},"as_of_market":{"description":"This row's market date (price performance, else profile), present only when it differs from the page's `as_of.market` (a listing whose last bar is older).","nullable":true,"type":"string"},"entity_id":{"description":"`subject_ref.subject_id` on the full view: the company's Finks entity.","nullable":true,"type":"string"},"fiscal_period_end_date":{"description":"The latest fiscal year's period end the row's FY fields (`revenue`, `revenue_growth_1year`, ...) are from; absent when no FY field is requested.","nullable":true,"type":"string"},"name":{"nullable":true,"type":"string"},"symbol":{"description":"The company's primary listing (`subject_ref.symbols[0]`).","type":"string"}},"required":["symbol"],"type":"object"},"CompanyEventsResponse":{"description":"`GET /v1/companies/{symbol}/events`: one company's timeline, newest first. Each item is a `SearchResult` card, `type` saying which pool it came from.","properties":{"has_more":{"type":"boolean"},"next_cursor":{"description":"Opaque keyset token for the next, older page. `null` on the last page.","nullable":true,"type":"string"},"primary_symbol":{"description":"The issuer's primary ticker in SEC's ticker map (`GOOG` -> `GOOGL`, `BRK.A` -> `BRK-B`; a retired ticker of a still-listed issuer, `SQ` -> `XYZ`). Absent when no issuer SEC's map lists is found for the symbol.","nullable":true,"type":"string"},"results":{"description":"Newest first by `published_at`, at most `limit` items, may be empty.","items":{"$ref":"#/components/schemas/SearchResult"},"type":"array"},"symbol":{"description":"The symbol asked for, upper-cased.","type":"string"},"symbols":{"description":"Every listing the timeline matched on: the symbol and the other classes of its issuer (`GOOGL` also matches `GOOG`), sorted.","items":{"type":"string"},"type":"array"}},"required":["symbol","symbols","results","has_more"],"type":"object"},"ConfidenceDetail":{"properties":{"citation":{"nullable":true,"type":"string"},"classification":{"nullable":true,"type":"string"},"extraction":{"nullable":true,"type":"string"},"faithfulness":{"nullable":true,"type":"string"},"identity":{"nullable":true,"type":"string"}},"type":"object"},"ConfidenceTier":{"enum":["unverified","low","medium","high"],"type":"string"},"ContentPage":{"properties":{"data":{"items":{"$ref":"#/components/schemas/FilingRecord"},"type":"array"},"has_more":{"type":"boolean"},"next_cursor":{"description":"Opaque server-issued token. `null` when this is the last page.","nullable":true,"type":"string"}},"required":["data","has_more"],"type":"object"},"ContentRecord":{"allOf":[{"$ref":"#/components/schemas/SearchResult"},{"properties":{"amended_by":{"nullable":true,"type":"string"},"amends":{"nullable":true,"type":"string"},"body":{"description":"Brief: the key facts as a CommonMark bullet list, each ending with its outlets, then the context sentence; the stored source-link list is never served. Article: the full article text. Transcript: the call's transcript, verbatim; absent until its text lands or where its rights are not `allow`.","nullable":true,"type":"string"},"citations":{"items":{"$ref":"#/components/schemas/SectionCitation"},"nullable":true,"type":"array"},"form":{"description":"Filing: the form as filed: `8-K`, `8-K/A`, `6-K`, `6-K/A`, a periodic report form (`10-K`, `10-K/A`, `10-KT`, `10-Q`, `10-Q/A`, `10-QT`, `20-F`, `20-F/A`, `40-F`, `40-F/A`), an offering or proxy form (`S-1`, `S-1/A`, `F-1`, `F-1/A`, `424B4`, `424B1`, `DEF 14A`), or another SEC form (`144`, `3`, `4`, `5`, `NT 10-K`, `25-NSE`, `15-12G`, `13F-HR`, `SCHEDULE 13D`, `SCHEDULE 13G`, ..., and their `/A`s).","nullable":true,"type":"string"},"item":{"description":"Filing: the 8-K item (`2.02`). Absent on a 6-K, a periodic report, an offering or proxy filing or another SEC form.","nullable":true,"type":"string"},"sections":{"items":{"$ref":"#/components/schemas/FilingSection"},"nullable":true,"type":"array"},"summary_evidence":{"description":"Filing: the verbatim filing quotes behind each sentence of `summary`. Absent when no sentence has one.","items":{"$ref":"#/components/schemas/SummaryEvidence"},"type":"array"}},"type":"object"}]},"ContentSummary":{"description":"The `view=compact` summary header: enough to decide what to read before pulling detail.","properties":{"by_event_type":{"additionalProperties":{"minimum":0,"type":"integer"},"description":"Filings on this page per served `event_type`; one without is not counted.","type":"object"},"by_form":{"additionalProperties":{"minimum":0,"type":"integer"},"description":"Filings on this page per form.","type":"object"},"count":{"description":"Filings on this page, `parts` included.","minimum":0,"type":"integer"},"truncated":{"description":"Another page exists (`has_more`).","type":"boolean"},"window":{"$ref":"#/components/schemas/ContentWindow"}},"required":["count","window","truncated","by_form","by_event_type"],"type":"object"},"ContentType":{"enum":["brief","article","filing"],"type":"string"},"ContentWindow":{"description":"The time window a compact page was read over, as applied (RFC 3339; `null` = open).","properties":{"published_after":{"nullable":true,"type":"string"},"published_before":{"nullable":true,"type":"string"}},"type":"object"},"CreditBalanceView":{"description":"The ledger-derived credit balance for one unit. A remaining figure requires *both* a configured allowance and a recorded consumption figure. Missing either, this reports which one is missing rather than subtracting from, or into, a number nobody has.","discriminator":{"propertyName":"state"},"oneOf":[{"properties":{"consumed_units":{"format":"int64","minimum":0,"type":"integer"},"included_units":{"format":"int64","minimum":0,"type":"integer"},"remaining_units":{"format":"int64","minimum":0,"type":"integer"},"state":{"enum":["remaining"],"type":"string"}},"required":["included_units","consumed_units","remaining_units","state"],"type":"object"},{"properties":{"state":{"enum":["no_allowance_configured"],"type":"string"}},"required":["state"],"type":"object"},{"description":"There is an allowance, but consumption is unknown, so the remainder is unknown.","properties":{"reason":{"$ref":"#/components/schemas/NotRecordedView"},"state":{"enum":["not_recorded"],"type":"string"}},"required":["reason","state"],"type":"object"}]},"DailyUnavailableReason":{"enum":["undatable_row"],"type":"string"},"DailyView":{"description":"The per-day breakdown of a recorded month. Days with no rows are **absent** from `days`; they are never present carrying a zero.","discriminator":{"propertyName":"state"},"oneOf":[{"properties":{"days":{"items":{"$ref":"#/components/schemas/DayView"},"type":"array"},"state":{"enum":["complete"],"type":"string"}},"required":["days","state"],"type":"object"},{"properties":{"reason":{"$ref":"#/components/schemas/DailyUnavailableReason"},"state":{"enum":["unavailable"],"type":"string"}},"required":["reason","state"],"type":"object"}]},"DataItem":{"discriminator":{"propertyName":"dataset"},"oneOf":[{"description":"The fund's profile and its 10 largest positions (`GET /v1/funds/{symbol}`).","properties":{"as_of":{"nullable":true,"type":"string"},"dataset":{"enum":["fund"],"type":"string"},"entity":{"type":"string"},"fund":{"$ref":"#/components/schemas/FundProfile"},"holdings":{"items":{"$ref":"#/components/schemas/FundHolding"},"type":"array"},"href":{"nullable":true,"type":"string"}},"required":["entity","fund","holdings","dataset"],"type":"object"},{"description":"The 10 funds holding the most of the security (`GET /v1/funds?holding=`).","properties":{"as_of":{"nullable":true,"type":"string"},"dataset":{"enum":["fund_owners"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/FundOwner"},"type":"array"}},"required":["entity","results","dataset"],"type":"object"},{"description":"The 10 largest 13F holders in the latest complete quarter (`GET /v1/companies/{symbol}/holders`).","properties":{"as_of":{"nullable":true,"type":"string"},"dataset":{"enum":["holders"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"period_of_report":{"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Holder"},"type":"array"}},"required":["entity","period_of_report","results","dataset"],"type":"object"},{"description":"The issuer's free-float estimate (`GET /v1/companies/{symbol}/float`).","properties":{"as_of":{"nullable":true,"type":"string"},"dataset":{"enum":["float"],"type":"string"},"entity":{"type":"string"},"float":{"$ref":"#/components/schemas/FloatEstimate"},"href":{"nullable":true,"type":"string"}},"required":["entity","float","dataset"],"type":"object"},{"description":"The stock's live quote (`GET /v1/companies/{symbol}/quote`).","properties":{"as_of":{"nullable":true,"type":"string"},"dataset":{"enum":["quote"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"quote":{"$ref":"#/components/schemas/LiveQuote"}},"required":["entity","quote","dataset"],"type":"object"},{"description":"The newest 10 SEC-form events (`GET /v1/companies/{symbol}/events` with those event types), each a search card whose `id` resolves on `GET /v1/content/{id}`.","properties":{"as_of":{"nullable":true,"type":"string"},"dataset":{"enum":["sec_forms"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/SearchResult"},"type":"array"}},"required":["entity","results","dataset"],"type":"object"},{"description":"A company's calendar rows from 90 days back to 90 ahead: its last and next reports (`GET /v1/earnings`). Two or more named companies share one item: `entity` their symbols joined by `,`, one row per company (its next report, else its latest), by report date then symbol. With no company named, the week's reports by market cap, one row per company (`entity` is `earnings_calendar`).","properties":{"as_of":{"nullable":true,"type":"string"},"dataset":{"enum":["earnings_calendar"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/EarningsCalendarEntry"},"type":"array"}},"required":["entity","results","dataset"],"type":"object"},{"description":"The issuer's newest 10 current Form D filings (`GET /v1/form-d?cik=`); for a set question (\"largest Form D offerings last month\", no company named), each operating company's largest new offering in the window, with `set` (`entity` is `form_d`).","properties":{"as_of":{"nullable":true,"type":"string"},"dataset":{"enum":["form_d"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/FormDFiling"},"type":"array"},"set":{"allOf":[{"$ref":"#/components/schemas/SetReading"}],"nullable":true}},"required":["entity","results","dataset"],"type":"object"},{"description":"The related block: the newest 10 briefs and articles of the last 90 days about the company's industry peers, `peers` its most-covered other listings in the company's industry (`href` is `POST /v1/search`: send `symbols` = `peers` for the rest). Each result is a search card whose `id` resolves on `GET /v1/content/{id}`.","properties":{"as_of":{"nullable":true,"type":"string"},"dataset":{"enum":["industry_news"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"peers":{"items":{"type":"string"},"type":"array"},"results":{"items":{"$ref":"#/components/schemas/SearchResult"},"type":"array"}},"required":["entity","peers","results","dataset"],"type":"object"},{"properties":{"as_of":{"nullable":true,"type":"string"},"dataset":{"enum":["macro"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"label":{"description":"The series' short label (`CPI`), as `GET /v1/macro/series` gives it.","nullable":true,"type":"string"},"next_release":{"allOf":[{"$ref":"#/components/schemas/MacroRelease"}],"nullable":true},"period":{"description":"The newest observation's period, as a reader names it: `2026-09` for a monthly series, `2026-Q3` for a quarterly one (`as_of` is its first day). Absent with no observation.","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/MacroObservation"},"type":"array"}},"required":["entity","results","dataset"],"type":"object"},{"description":"The latest Treasury curve (`GET /v1/rates/curve`, `curve`), or one rates series' newest 10 observations, newest first (`GET /v1/rates/series/{series}/observations`, `results`; `entity` is the series: a Freddie Mac mortgage rate, `pmms_30y_frm`). Each observation carries its `attribution`, to show with the figure (Freddie Mac's condition for its survey).","properties":{"as_of":{"nullable":true,"type":"string"},"curve":{"allOf":[{"$ref":"#/components/schemas/RateCurveResponse"}],"nullable":true},"dataset":{"enum":["rates"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"label":{"description":"The curve's or series' short label (`Treasury par yield`, `30-year fixed mortgage rate`).","nullable":true,"type":"string"},"results":{"description":"A series item's observations; absent on a curve item.","items":{"$ref":"#/components/schemas/RateObservation"},"type":"array"}},"required":["entity","dataset"],"type":"object"},{"description":"The newest 10 FOMC documents (`GET /v1/fomc/documents`).","properties":{"as_of":{"nullable":true,"type":"string"},"dataset":{"enum":["fomc"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/FomcDocument"},"type":"array"}},"required":["entity","results","dataset"],"type":"object"},{"description":"The query compiled and run as a natural-language screen (beta): the `POST /v1/screener` response, with `interpretation` and the `normalized_query` to resubmit there to page or rerun it with no model call. `entity` is `screen`.","properties":{"as_of":{"nullable":true,"type":"string"},"dataset":{"enum":["screen"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"screen":{"$ref":"#/components/schemas/ScreenerResponse"}},"required":["entity","screen","dataset"],"type":"object"},{"description":"The newest 10 FINRA short-interest settlements (`GET /v1/companies/{symbol}/short-interest`); each row carries its `attribution` and `exportable`.","properties":{"as_of":{"nullable":true,"type":"string"},"dataset":{"enum":["short_interest"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/ShortInterest"},"type":"array"},"units":{"additionalProperties":{"type":"string"},"description":"Each figure's unit: `shares` (`short_interest`, `previous_short_interest`, `avg_daily_volume`), `days` (`days_to_cover`).","type":"object"}},"required":["entity","results","dataset"],"type":"object"},{"description":"The company's newest 10 funding rounds with their sourced statements (`GET /v1/funding`). `entity` is the symbol, or a private company's `company_key`. With no company named, the market's rounds of the last 30 days (`entity` is `funding_rounds`); for a set question (\"which AI companies raised money this year\"), the window's largest raisers in the category, with `set` (`href` is the same read on `/v1/funding`).","properties":{"as_of":{"nullable":true,"type":"string"},"dataset":{"enum":["funding_rounds"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"order":{"description":"`amount`: the rows are the window's largest `amount_raised` first (a `biggest`, `largest` or `top` question with no company named), while `href` pages the same window newest first. Absent: newest first.","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/FundingRound"},"type":"array"},"set":{"allOf":[{"$ref":"#/components/schemas/SetReading"}],"nullable":true},"units":{"additionalProperties":{"type":"string"},"description":"`amount_raised` and `offering_amount`'s unit: the rows' currency lower-cased (`usd`) when every row with an amount states the same one; absent when they mix (each row's `currency` says).","type":"object"}},"required":["entity","results","dataset"],"type":"object"},{"properties":{"as_of":{"nullable":true,"type":"string"},"dataset":{"enum":["federal_awards"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"order":{"description":"`amount`: the rows are the window's largest `obligated_usd` first (a `biggest`, `largest` or `top` question with no company named), while `href` pages the same window most recently active first. Absent: most recently active first.","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/FederalAward"},"type":"array"},"set":{"allOf":[{"$ref":"#/components/schemas/SetReading"}],"nullable":true},"units":{"additionalProperties":{"type":"string"},"description":"Each figure's unit: `usd` (`obligated_usd`, `ceiling_usd`).","type":"object"}},"required":["entity","results","dataset"],"type":"object"},{"description":"The fund's newest 10 Section 19(a) source-of-distribution estimates (`GET /v1/funds/{symbol}/distributions`).","properties":{"as_of":{"nullable":true,"type":"string"},"dataset":{"enum":["distribution_sources"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/DistributionSource"},"type":"array"}},"required":["entity","results","dataset"],"type":"object"},{"description":"A private company's newest 10 valuation claims (`GET /v1/valuations`), each as reported with its status, basis and source; never verified. `entity` is the private company's `company_key`.","properties":{"as_of":{"nullable":true,"type":"string"},"dataset":{"enum":["valuation_claims"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/ValuationClaim"},"type":"array"}},"required":["entity","results","dataset"],"type":"object"},{"description":"A company's 10 most recently filed registered offerings (`GET /v1/offerings`), each with its filings' terms as model-read from the filing and its `source_url`. `entity` is the symbol.","properties":{"as_of":{"nullable":true,"type":"string"},"dataset":{"enum":["offerings"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/Offering"},"type":"array"},"units":{"additionalProperties":{"type":"string"},"description":"Each figure's unit: `usd` (`amount_usd`).","type":"object"}},"required":["entity","results","dataset"],"type":"object"},{"description":"A company's newest 10 proxy statements (`GET /v1/proxies`), each model-read from the filing, with its `source_url`. `entity` is the symbol.","properties":{"as_of":{"nullable":true,"type":"string"},"dataset":{"enum":["proxy"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/ProxyStatement"},"type":"array"}},"required":["entity","results","dataset"],"type":"object"},{"description":"A private company's profile (`GET /v1/private-companies/{cluster_id}`): one row, each section with its source and its own as-of. `entity` is the private company's `company_key`.","properties":{"as_of":{"nullable":true,"type":"string"},"dataset":{"enum":["private_company_profile"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"profile":{"$ref":"#/components/schemas/PrivateCompanyProfile"}},"required":["entity","profile","dataset"],"type":"object"},{"description":"A company's newest 10 FDA actions (`GET /v1/fda`): drug approvals, 510(k) clearances and PMA approvals, newest decision first. `entity` is the symbol; `attribution` is openFDA's, to show with the rows.","properties":{"as_of":{"nullable":true,"type":"string"},"attribution":{"nullable":true,"type":"string"},"dataset":{"enum":["fda"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/FdaRecord"},"type":"array"}},"required":["entity","results","dataset"],"type":"object"},{"description":"A company's 10 most recently updated clinical trials (`GET /v1/clinical-trials`). `entity` is the symbol; `attribution` is ClinicalTrials.gov's, to show with the rows.","properties":{"as_of":{"nullable":true,"type":"string"},"attribution":{"nullable":true,"type":"string"},"dataset":{"enum":["clinical_trials"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/ClinicalTrial"},"type":"array"}},"required":["entity","results","dataset"],"type":"object"},{"description":"The newest 10 Federal Register documents naming the company, or of a regulatory topic's agencies, types and words (`GET /v1/federal-register`). `entity` is the symbol, or the topic's query string (`agency=occ&q=charter`, also `href`'s); `attribution` is the Federal Register's, to show with the rows.","properties":{"as_of":{"nullable":true,"type":"string"},"attribution":{"nullable":true,"type":"string"},"dataset":{"enum":["federal_register"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/FederalRegisterDocument"},"type":"array"}},"required":["entity","results","dataset"],"type":"object"},{"description":"A company's H-1B petitions for its newest 10 fiscal years (`GET /v1/hiring`), each year summed over its employers. `entity` is the symbol or the private company's `company_key`; `attribution` is USCIS's, to show with the figures.","properties":{"as_of":{"nullable":true,"type":"string"},"attribution":{"nullable":true,"type":"string"},"dataset":{"enum":["h1b_approvals"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/H1bYear"},"type":"array"}},"required":["entity","results","dataset"],"type":"object"},{"description":"A company's certified LCA positions for its newest 10 fiscal years (`GET /v1/hiring`): an intent to hire, not hires. `attribution` is DOL's, to show with the figures (no DOL endorsement implied).","properties":{"as_of":{"nullable":true,"type":"string"},"attribution":{"nullable":true,"type":"string"},"dataset":{"enum":["lca_positions"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/LcaYear"},"type":"array"}},"required":["entity","results","dataset"],"type":"object"},{"description":"A commodity's newest 10 EIA daily spot prices (`GET /v1/commodities/series/{series_id}/observations`). `entity` is the series id (`RNGWHHD`); each price carries its `attribution`.","properties":{"as_of":{"nullable":true,"type":"string"},"dataset":{"enum":["commodities"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"label":{"description":"The series' short label (`Henry Hub natural gas spot price`).","nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/CommodityObservation"},"type":"array"}},"required":["entity","results","dataset"],"type":"object"},{"properties":{"as_of":{"nullable":true,"type":"string"},"dataset":{"enum":["reported_facts"],"type":"string"},"entity":{"type":"string"},"href":{"nullable":true,"type":"string"},"results":{"items":{"$ref":"#/components/schemas/ReportedFact"},"type":"array"}},"required":["entity","results","dataset"],"type":"object"}]},"DataScope":{"enum":["asked","all"],"type":"string"},"Dataset":{"enum":["fund","fund_owners","holders","float","sec_forms","earnings_calendar","form_d","industry_news","macro","rates","fomc","screen","short_interest","funding_rounds","federal_awards","distribution_sources","valuation_claims","offerings","proxy","private_company_profile","fda","clinical_trials","federal_register","h1b_approvals","lca_positions","commodities","quote","reported_facts"],"type":"string"},"DatasetEntry":{"properties":{"attribution_required":{"description":"Whether its rows carry an `attribution` to show with them.","type":"boolean"},"description":{"type":"string"},"granted":{"type":"boolean"},"kind":{"$ref":"#/components/schemas/DatasetKind"},"name":{"description":"The name: a `result_types` value, an `exclude` value, a `datasets[].name`.","type":"string"},"required_tier":{"nullable":true,"type":"string"},"routes":{"items":{"type":"string"},"type":"array"},"source":{"description":"Who publishes the data.","type":"string"},"upgrade_required":{"type":"boolean"}},"required":["name","kind","description","routes","source","attribution_required","granted","upgrade_required"],"type":"object"},"DatasetKind":{"description":"What a vocabulary name is.","enum":["pool","dataset","route"],"type":"string"},"DatasetState":{"description":"A `SearchDataset`'s state for this search: a client treats a state it does not know as not searched.","enum":["searched","not_applicable","not_asked","excluded","not_in_plan","timed_out","unavailable","budget_exhausted","not_point_in_time"],"type":"string"},"DatasetsResponse":{"properties":{"results":{"description":"The pools, then the data-block datasets, then the route-only names, each in vocabulary order.","items":{"$ref":"#/components/schemas/DatasetEntry"},"type":"array"},"tier":{"description":"The tier the key's account resolves to. Absent when no entitlement can be proven; every `granted` is then `false`.","nullable":true,"type":"string"}},"required":["results"],"type":"object"},"DayView":{"description":"One UTC day that carries recorded rows.","properties":{"date":{"description":"`YYYY-MM-DD`, UTC.","type":"string"},"rows":{"format":"int64","minimum":0,"type":"integer"},"units":{"format":"int64","minimum":0,"type":"integer"}},"required":["date","units","rows"],"type":"object"},"DistributionSource":{"properties":{"accession":{"type":"string"},"basis":{"description":"`per_share` or `percent` (what the notice printed; on `percent` the per-share amounts are derived).","type":"string"},"cik":{"description":"The filer's CIK, 10 digits; on a multi-fund table, another fund's filing.","type":"string"},"distribution_per_share":{"format":"double","type":"number"},"document":{"type":"string"},"ex_date":{"nullable":true,"type":"string"},"filing_date":{"description":"`YYYY-MM-DD`.","type":"string"},"form":{"type":"string"},"ltcg_per_share":{"description":"Long-term capital gains, estimated.","format":"double","type":"number"},"nii_per_share":{"description":"Net investment income, estimated; 0 when the notice prints no such row.","format":"double","type":"number"},"pay_date":{"description":"`YYYY-MM-DD`, the payment the notice accompanies.","type":"string"},"record_date":{"nullable":true,"type":"string"},"roc_fraction":{"description":"Return of capital ÷ distribution, a **fraction** 0..1.","format":"double","type":"number"},"roc_per_share":{"description":"Return of capital, estimated.","format":"double","type":"number"},"stcg_per_share":{"description":"Short-term capital gains, estimated.","format":"double","type":"number"},"symbol":{"type":"string"}},"required":["symbol","pay_date","distribution_per_share","nii_per_share","stcg_per_share","ltcg_per_share","roc_per_share","roc_fraction","basis","cik","accession","document","form","filing_date"],"type":"object"},"DistributionSourcesResponse":{"description":"`GET /v1/funds/{symbol}/distributions`: a closed-end fund's Section 19(a) source-of-distribution notices, newest payment first.","properties":{"has_more":{"type":"boolean"},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"},"results":{"description":"By `pay_date` descending, at most `limit`, never before the plan's history window; may be empty.","items":{"$ref":"#/components/schemas/DistributionSource"},"type":"array"}},"required":["results","has_more"],"type":"object"},"EarningsCalendarEntry":{"properties":{"as_of":{"type":"string"},"company_name":{"nullable":true,"type":"string"},"eps_actual":{"format":"double","nullable":true,"type":"number"},"eps_estimate":{"format":"double","nullable":true,"type":"number"},"filing_ids":{"items":{"type":"string"},"type":"array"},"report_date":{"description":"`YYYY-MM-DD`. No session (before or after the market) is known.","type":"string"},"revenue_actual":{"format":"double","nullable":true,"type":"number"},"revenue_estimate":{"format":"double","nullable":true,"type":"number"},"source":{"description":"The calendar's label: `earnings_calendar_feed`.","type":"string"},"symbol":{"type":"string"}},"required":["symbol","report_date","source","as_of"],"type":"object"},"EarningsCalendarResponse":{"properties":{"has_more":{"type":"boolean"},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"},"results":{"description":"By `(report_date, symbol)` ascending, at most `limit` rows, may be empty.","items":{"$ref":"#/components/schemas/EarningsCalendarEntry"},"type":"array"}},"required":["results","has_more"],"type":"object"},"EarningsCard":{"properties":{"as_of":{"type":"string"},"eps_actual":{"description":"Per share, US dollars: the company's adjusted EPS where it reports one, else GAAP.","format":"double","nullable":true,"type":"number"},"eps_basis":{"description":"`gaap` or `adjusted`: the verified actual's basis. Verified actuals only.","nullable":true,"type":"string"},"eps_estimate":{"format":"double","nullable":true,"type":"number"},"eps_result":{"allOf":[{"$ref":"#/components/schemas/EarningsResult"}],"nullable":true},"eps_surprise":{"description":"`eps_actual - eps_estimate`, to the cent. Verified actuals only.","format":"double","nullable":true,"type":"number"},"eps_surprise_pct":{"description":"The surprise as a percent of |estimate|, one decimal. Verified actuals only, and absent when |estimate| < 0.10 or the actual and the estimate differ in sign.","format":"double","nullable":true,"type":"number"},"fiscal_quarter":{"description":"`Q1`..`Q4`, the reported quarter as the company names it.","nullable":true,"type":"string"},"fiscal_year":{"description":"The reported quarter's fiscal year as the company names it.","format":"int32","nullable":true,"type":"integer"},"price_base_close":{"format":"double","nullable":true,"type":"number"},"price_base_date":{"description":"`YYYY-MM-DD`: the last close before the reaction session.","nullable":true,"type":"string"},"price_change_pct":{"description":"`reaction_close / base_close - 1` in percent, two decimals; split-adjusted closes.","format":"double","nullable":true,"type":"number"},"price_reaction_close":{"format":"double","nullable":true,"type":"number"},"price_reaction_date":{"description":"`YYYY-MM-DD`: the reaction session's date.","nullable":true,"type":"string"},"price_session":{"description":"The session that priced the news first: `pre` (before the open on the reaction date), `intraday`, or `after` (the reaction is a later trading day). The `price_*` fields are all present or all absent.","nullable":true,"type":"string"},"report_date":{"description":"`YYYY-MM-DD`: the calendar row's report date, within a day of the filing.","type":"string"},"revenue_actual":{"description":"Total revenue, US dollars.","format":"double","nullable":true,"type":"number"},"revenue_estimate":{"format":"double","nullable":true,"type":"number"},"revenue_result":{"allOf":[{"$ref":"#/components/schemas/EarningsResult"}],"nullable":true},"revenue_surprise_pct":{"description":"As `eps_surprise_pct`.","format":"double","nullable":true,"type":"number"},"source":{"description":"The calendar's label: `earnings_calendar_feed`.","type":"string"}},"required":["report_date","source","as_of"],"type":"object"},"EarningsResult":{"description":"An actual against its estimate: EPS to the cent, revenue within ±0.5% is `inline`.","enum":["beat","miss","inline"],"type":"string"},"EnergyForecastObservation":{"description":"One period's STEO value in a vintage: EIA's history to date and its forecast ahead.","properties":{"attribution":{"description":"The citation to show with the value.","type":"string"},"frequency":{"description":"`M` (monthly), `Q` (quarterly) or `A` (annual).","type":"string"},"is_forecast":{"description":"`true` when the period is a forecast (a month after the vintage's last historical month); absent when EIA did not say.","nullable":true,"type":"boolean"},"period_start":{"description":"`YYYY-MM-DD`, the first day of the month, quarter or year.","type":"string"},"source_url":{"description":"The vintage's report PDF on eia.gov.","type":"string"},"unit":{"type":"string"},"value":{"description":"As published, in `unit`.","format":"double","type":"number"}},"required":["period_start","frequency","value","unit","source_url","attribution"],"type":"object"},"EnergyForecastResponse":{"description":"`GET /v1/energy/forecasts`: one series' STEO vintage, every period served.","properties":{"label":{"description":"The series' short label, as `GET /v1/energy/forecasts/series` gives it.","nullable":true,"type":"string"},"release_date":{"description":"`YYYY-MM-DD`, EIA's release date; absent when the vintage's release day is not recorded.","nullable":true,"type":"string"},"results":{"description":"By `period_start` ascending, the vintage's values at the asked frequency.","items":{"$ref":"#/components/schemas/EnergyForecastObservation"},"type":"array"},"series_id":{"type":"string"},"vintage":{"type":"string"}},"required":["series_id","vintage","results"],"type":"object"},"EnergyForecastSeries":{"properties":{"attribution":{"description":"The citation to show with any of its values.","type":"string"},"label":{"description":"A short human label, at most 40 characters (`WTI crude oil price (EIA STEO)`); EIA's `title` for a series not yet curated.","type":"string"},"series_id":{"description":"`steo_henry_hub_spot`, `steo_wti_spot`, `steo_brent_spot` or `steo_working_gas_storage`.","type":"string"},"source":{"description":"The publisher: `eia`.","type":"string"},"title":{"description":"EIA's own title of the series.","type":"string"},"unit":{"description":"The unit every value is in (`usd_per_mmbtu`, `usd_per_barrel`, `bcf`).","type":"string"},"vintages":{"description":"The STEO vintages published for the series, newest first.","items":{"$ref":"#/components/schemas/EnergyForecastVintage"},"type":"array"}},"required":["series_id","title","unit","source","attribution","vintages"],"type":"object"},"EnergyForecastSeriesResponse":{"description":"`GET /v1/energy/forecasts/series`: the EIA STEO forecast series served, by `series_id`, each with its vintages newest first.","properties":{"results":{"items":{"$ref":"#/components/schemas/EnergyForecastSeries"},"type":"array"}},"required":["results"],"type":"object"},"EnergyForecastVintage":{"description":"One STEO vintage of a series: the forecast month's report and, when captured live, its release day.","properties":{"release_date":{"description":"`YYYY-MM-DD`, EIA's release date; absent for archived vintages this service captured before it recorded release dates.","nullable":true,"type":"string"},"source_url":{"description":"The vintage's report PDF on eia.gov.","type":"string"},"vintage":{"description":"`YYYY-MM-DD`, the STEO's forecast month (`2026-10-01` = the October 2026 STEO).","type":"string"}},"required":["vintage","source_url"],"type":"object"},"EnrichmentStatus":{"enum":["pending","complete"],"type":"string"},"EntitlementView":{"discriminator":{"propertyName":"state"},"oneOf":[{"properties":{"limits":{"$ref":"#/components/schemas/LimitsView"},"state":{"enum":["granted"],"type":"string"},"tier":{"type":"string"}},"required":["tier","limits","state"],"type":"object"},{"properties":{"reason":{"$ref":"#/components/schemas/NotEntitledView"},"state":{"enum":["not_entitled"],"type":"string"}},"required":["reason","state"],"type":"object"}]},"EntityCoverage":{"description":"One named company and its page-1 coverage.","properties":{"matched":{"description":"The query's words that named it, as typed.","type":"string"},"name":{"nullable":true,"type":"string"},"results":{"description":"Page-1 results about it (its subject band, a filing or call of its).","format":"int32","minimum":0,"type":"integer"},"symbol":{"type":"string"}},"required":["symbol","matched","results"],"type":"object"},"EntityKind":{"description":"What a `SearchEntity` is. Finks API may add kinds.","enum":["company","fund","macro_series","commodity_series","private_company"],"type":"string"},"EntityMatch":{"enum":["any","all"],"type":"string"},"ErrorCode":{"enum":["auth.invalid_key","auth.revoked_key","auth.expired_key","request.invalid","rate_limit.exceeded","quota.exceeded","not_implemented","invalid_cursor","cursor_expired","content.unresolved","test_key.daily_cap_exceeded","invalid_filter","unsupported_subject","unsupported_field_for_subject","unresolvable_query","request.out_of_plan","withdrawn","not_found","request.too_large","spend_cap.exceeded","account.not_ready","auth.expired_token","model.unavailable","model.timeout","chart.unchartable","plan.upgrade_required","service.overloaded","request.timeout","key.scope_denied","key.ip_denied"],"type":"string"},"ErrorEnvelope":{"properties":{"error":{"$ref":"#/components/schemas/ApiError"}},"required":["error"],"type":"object"},"EventLedgerRecord":{"description":"`GET /v1/events/{ledger_event_id}`: one real-world event from the event ledger, with the filing record that currently states its facts.","properties":{"anchor_event_ids":{"description":"Every filing event (`e1:`) that proves this event, oldest first: the 8-K, then each 8-K/A (a Form 4, then each 4/A; a 13F, then its amendments).","items":{"type":"string"},"type":"array"},"current_event_id":{"description":"The filing event (`e1:`) whose facts are current: the newest anchor.","type":"string"},"event_subtype":{"description":"The 8-K item (`2.02`); a Form 4's transaction code (`S`, `P`, ...), a 13F's report kind (`report`, `restatement`, `new_holdings`), a 13D/13G's `activist` or `passive`.","nullable":true,"type":"string"},"event_type":{"type":"string"},"filing":{"allOf":[{"$ref":"#/components/schemas/ContentRecord"}],"nullable":true},"first_filed_at":{"description":"EDGAR acceptance of the first anchor filing, RFC 3339.","type":"string"},"last_filed_at":{"description":"EDGAR acceptance of the newest anchor filing, RFC 3339.","type":"string"},"ledger_event_id":{"description":"The event's current id. A retired alias asked for resolves to this one.","type":"string"},"occurred_on":{"description":"`YYYY-MM-DD`: the 8-K's date of the earliest event reported; a Form 4's transaction date, a 13F's period end, a 13D/13G's date of the event requiring the filing.","nullable":true,"type":"string"},"subject":{"$ref":"#/components/schemas/LedgerSubject"}},"required":["ledger_event_id","event_type","subject","first_filed_at","last_filed_at","current_event_id","anchor_event_ids"],"type":"object"},"EvidenceQuote":{"properties":{"is_exhibit":{"description":"The section is an exhibit (`EX-99.x`), not an item body.","type":"boolean"},"passage_end":{"description":"Unicode code-point offset, exclusive. Absent with `passage_start`.","format":"int32","minimum":0,"nullable":true,"type":"integer"},"passage_start":{"description":"Unicode code-point offset, inclusive, into that section's `text` on `GET /v1/content/{id}`: the start of the passage that contains the quote, not of the quote itself. Absent on `GET /v1/content`, which serves no section text, and wherever the served text does not hold the quote at these offsets.","format":"int32","minimum":0,"nullable":true,"type":"integer"},"quote":{"description":"Verbatim filing text: the filer's own words.","type":"string"},"section_id":{"description":"The section quoted: an item body or an exhibit, as `sections[].section_id` on `GET /v1/content/{id}`.","type":"string"}},"required":["quote","section_id","is_exhibit"],"type":"object"},"EvidenceRef":{"properties":{"kind":{"nullable":true,"type":"string"},"reference":{"type":"string"}},"required":["reference"],"type":"object"},"FdaRecord":{"properties":{"active_ingredients":{"items":{"type":"string"},"type":"array"},"advisory_committee":{"nullable":true,"type":"string"},"ao_statement":{"description":"PMA: the approval order's statement.","nullable":true,"type":"string"},"application_type":{"description":"Drug: `NDA`, `BLA` or `ANDA`.","nullable":true,"type":"string"},"attribution":{"description":"openFDA's citation and disclaimer: show it wherever the row is shown.","type":"string"},"brand_names":{"items":{"type":"string"},"type":"array"},"clearance_type":{"description":"510(k): `Traditional`, `Special`, `Abbreviated`.","nullable":true,"type":"string"},"date_received":{"description":"Device: `YYYY-MM-DD`.","nullable":true,"type":"string"},"decision_code":{"description":"Device: FDA's decision code (`SESE` substantially equivalent, `APPR`, `OK30`, …).","nullable":true,"type":"string"},"decision_date":{"description":"`YYYY-MM-DD`: a drug submission's status date, a device's decision date.","type":"string"},"device_class":{"description":"510(k): `1`, `2`, `3`, ….","nullable":true,"type":"string"},"device_name":{"description":"510(k): the device's name.","nullable":true,"type":"string"},"expedited_review_flag":{"nullable":true,"type":"boolean"},"generic_name":{"nullable":true,"type":"string"},"kind":{"description":"`drug`, `510k` or `pma`.","type":"string"},"letter_url":{"description":"Drug: FDA's action letter.","nullable":true,"type":"string"},"mapping_basis":{"description":"`self`, `parent_seed` (a reviewed parent mapping) or `unlisted_self`.","nullable":true,"type":"string"},"number":{"description":"The application (`NDA207924`, `BLA125514`), 510(k) (`K262913`) or PMA (`P860004`) number.","type":"string"},"product_code":{"description":"Device: FDA's product code.","nullable":true,"type":"string"},"record_key":{"description":"What pages: `drug:NDA207924:SUPPL:10`, `510k:K262913`, `pma:P860004:S462` (`pma:P860004:` the original approval).","type":"string"},"regulation_number":{"nullable":true,"type":"string"},"review_priority":{"description":"Drug: `STANDARD`, `PRIORITY`, ….","nullable":true,"type":"string"},"source_url":{"description":"openFDA's terms.","type":"string"},"sponsor_cik":{"description":"The SEC issuer that owns the sponsor today; absent when unresolved.","nullable":true,"type":"string"},"sponsor_name":{"description":"The sponsor or applicant as filed.","nullable":true,"type":"string"},"sponsor_own_cik":{"description":"The as-filed sponsor's own SEC CIK, when it has one.","nullable":true,"type":"string"},"sponsor_symbol":{"description":"That issuer's symbol; absent when it is unlisted.","nullable":true,"type":"string"},"submission_class_code":{"nullable":true,"type":"string"},"submission_class_description":{"nullable":true,"type":"string"},"submission_number":{"nullable":true,"type":"string"},"submission_status":{"description":"Drug: `AP` (approved) or `TA` (tentatively approved).","nullable":true,"type":"string"},"submission_type":{"description":"Drug: `ORIG` or `SUPPL`.","nullable":true,"type":"string"},"supplement_number":{"description":"PMA: `S462`; absent on the original approval.","nullable":true,"type":"string"},"supplement_reason":{"nullable":true,"type":"string"},"supplement_type":{"nullable":true,"type":"string"},"third_party_flag":{"nullable":true,"type":"boolean"},"trade_name":{"description":"PMA: the device's trade and generic names.","nullable":true,"type":"string"}},"required":["kind","record_key","number","decision_date","attribution","source_url"],"type":"object"},"FdaResponse":{"description":"`GET /v1/fda`: a company's FDA actions, newest decision first.","properties":{"attribution":{"description":"openFDA's citation and disclaimer, as on every row: show it wherever the data is shown. Absent on an empty page.","nullable":true,"type":"string"},"has_more":{"type":"boolean"},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"},"results":{"description":"By `(decision_date, record_key)` descending, at most `limit`, never before the plan's history window; may be empty.","items":{"$ref":"#/components/schemas/FdaRecord"},"type":"array"}},"required":["results","has_more"],"type":"object"},"FederalAward":{"properties":{"award_id":{"description":"The PIID.","type":"string"},"award_key":{"description":"USAspending's generated award id (an Other Transaction's is USAspending-shaped, `OT_AWD_…` or `OT_IDV_…`).","type":"string"},"award_type":{"type":"string"},"awarding_agency":{"nullable":true,"type":"string"},"awarding_office":{"description":"Other Transactions only.","nullable":true,"type":"string"},"awarding_sub_agency":{"nullable":true,"type":"string"},"ceiling_usd":{"description":"Other Transactions only: the latest action's base-and-all-options value, USD. Potential value of this award only: never sum it across awards or companies (an `ot_idv`'s ceiling can be shared by its orders).","format":"double","nullable":true,"type":"number"},"company_key":{"type":"string"},"company_name":{"type":"string"},"contract_award_type":{"nullable":true,"type":"string"},"description":{"nullable":true,"type":"string"},"first_action_on":{"description":"`YYYY-MM-DD`.","type":"string"},"last_action_on":{"description":"`YYYY-MM-DD`.","type":"string"},"match_basis":{"description":"How the recipient was matched to the company (reviewed UEIs only).","type":"string"},"naics":{"nullable":true,"type":"string"},"obligated_usd":{"description":"USD committed; can be net negative.","format":"double","type":"number"},"psc":{"nullable":true,"type":"string"},"publisher":{"type":"string"},"recipient_name":{"nullable":true,"type":"string"},"recipient_uei":{"type":"string"},"referenced_idv_id":{"description":"An `ot_order`'s Other Transaction IDV PIID.","nullable":true,"type":"string"},"source_type":{"type":"string"},"source_url":{"description":"The award's usaspending.gov page, or an Other Transaction's FPDS ATOM search by PIID.","type":"string"},"transaction_count":{"format":"int32","minimum":0,"type":"integer"},"type_of_agreement":{"description":"Other Transactions only: `PROTOTYPE`, `RESEARCH` or `PRODUCTION`, as FPDS files it.","nullable":true,"type":"string"},"value_kind":{"description":"`filed`: `obligated_usd` equals USAspending's (an Other Transaction's: FPDS's) own award total; `derived`: partial history (actions before 2007-10-01, or cut by an acquisition date).","type":"string"}},"required":["award_key","company_key","company_name","award_id","award_type","recipient_uei","first_action_on","last_action_on","obligated_usd","transaction_count","source_type","source_url","publisher","value_kind","match_basis"],"type":"object"},"FederalAwardsResponse":{"properties":{"has_more":{"type":"boolean"},"interpretation":{"allOf":[{"$ref":"#/components/schemas/SetReading"}],"nullable":true},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"},"results":{"description":"By `(last_action_on, award_key)` descending, at most `limit`, never before the plan's history window; may be empty.","items":{"$ref":"#/components/schemas/FederalAward"},"type":"array"}},"required":["results","has_more"],"type":"object"},"FederalRegisterDocument":{"properties":{"abstract":{"nullable":true,"type":"string"},"action":{"description":"`Final rule; correction.`","nullable":true,"type":"string"},"agency_names":{"items":{"type":"string"},"type":"array"},"agency_slugs":{"description":"federalregister.gov agency slugs and names, in the document's order.","items":{"type":"string"},"type":"array"},"attribution":{"description":"The Federal Register's attribution: show it wherever the row is shown.","type":"string"},"cfr_parts":{"items":{"nullable":true,"type":"string"},"type":"array"},"cfr_titles":{"items":{"format":"int32","nullable":true,"type":"integer"},"type":"array"},"citation":{"description":"`91 FR 66785`.","nullable":true,"type":"string"},"comments_close_on":{"nullable":true,"type":"string"},"correction_of":{"nullable":true,"type":"string"},"docket_ids":{"items":{"type":"string"},"type":"array"},"document_number":{"description":"`2026-21686`.","type":"string"},"effective_on":{"description":"`YYYY-MM-DD`.","nullable":true,"type":"string"},"executive_order_number":{"nullable":true,"type":"string"},"html_url":{"description":"The document on federalregister.gov, and its govinfo.gov PDF.","nullable":true,"type":"string"},"mention_names":{"description":"Every organisation name found in the title and abstract, resolved or not.","items":{"type":"string"},"type":"array"},"mentions":{"description":"The names among them that resolve to an SEC issuer.","items":{"$ref":"#/components/schemas/FederalRegisterMention"},"type":"array"},"page_length":{"format":"int32","nullable":true,"type":"integer"},"pdf_url":{"nullable":true,"type":"string"},"publication_date":{"description":"`YYYY-MM-DD`: what pages.","type":"string"},"regulation_id_numbers":{"items":{"type":"string"},"type":"array"},"significant":{"description":"Significant under EO 12866; absent when not stated (never a stated `false`).","nullable":true,"type":"boolean"},"signing_date":{"nullable":true,"type":"string"},"subtype":{"nullable":true,"type":"string"},"title":{"nullable":true,"type":"string"},"type":{"description":"`Rule`, `Proposed Rule`, `Notice` or `Presidential Document`.","type":"string"}},"required":["document_number","publication_date","type","attribution"],"type":"object"},"FederalRegisterMention":{"properties":{"cik":{"description":"The SEC issuer that owns the named entity today (not as of publication).","nullable":true,"type":"string"},"mapping_basis":{"description":"`self`, `parent_seed` or `unlisted_self`.","type":"string"},"mention_key":{"type":"string"},"mention_name":{"description":"The name as the document prints it.","type":"string"},"own_cik":{"description":"The named entity's own SEC CIK, when it has one.","nullable":true,"type":"string"},"symbol":{"description":"That issuer's symbol; absent when it is unlisted.","nullable":true,"type":"string"}},"required":["mention_key","mention_name","mapping_basis"],"type":"object"},"FederalRegisterResponse":{"description":"`GET /v1/federal-register`: Federal Register documents, newest publication first.","properties":{"attribution":{"description":"The Federal Register's attribution, as on every row: show it wherever the data is shown. Absent on an empty page.","nullable":true,"type":"string"},"has_more":{"type":"boolean"},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"},"results":{"description":"By `(publication_date, document_number)` descending, at most `limit`, never before the plan's history window; may be empty.","items":{"$ref":"#/components/schemas/FederalRegisterDocument"},"type":"array"}},"required":["results","has_more"],"type":"object"},"FieldDefinition":{"description":"One field and its one-sentence definition.","properties":{"definition":{"type":"string"},"name":{"type":"string"},"on":{"description":"Result fields: the types that carry it.","items":{"type":"string"},"type":"array"},"type":{"type":"string"},"values":{"description":"Closed vocabularies: the live values.","items":{"type":"string"},"nullable":true,"type":"array"}},"required":["name","type","definition"],"type":"object"},"FilingCitation":{"properties":{"accession":{"type":"string"},"anchor":{"allOf":[{"$ref":"#/components/schemas/CitationAnchor"}],"nullable":true},"citation_id":{"nullable":true,"type":"string"},"section_id":{"nullable":true,"type":"string"},"section_version":{"nullable":true,"type":"string"},"source_document":{"type":"string"},"source_url":{"type":"string"}},"required":["accession","source_document","source_url"],"type":"object"},"FilingFacets":{"properties":{"event_types":{"items":{"type":"string"},"type":"array"},"geos":{"items":{"type":"string"},"type":"array"},"impact_score":{"format":"double","nullable":true,"type":"number"},"sectors":{"items":{"type":"string"},"type":"array"},"severity":{"nullable":true,"type":"string"},"themes":{"items":{"type":"string"},"type":"array"}},"required":["sectors","themes","geos","event_types"],"type":"object"},"FilingPeriod":{"properties":{"calendar":{"type":"string"},"filer":{"type":"string"}},"required":["filer","calendar"],"type":"object"},"FilingRecord":{"properties":{"amended_by":{"nullable":true,"type":"string"},"amends":{"nullable":true,"type":"string"},"citation":{"$ref":"#/components/schemas/FilingCitation"},"citations":{"description":"The complete cited set; `citations[0]` is `citation`. Absent on a `pending` card, where no span citation has been minted yet.","items":{"$ref":"#/components/schemas/FilingCitation"},"nullable":true,"type":"array"},"co_registrants":{"description":"CIKs, exclusive of the resolved primary, never `entity_id`s. Guarantor subsidiaries frequently have neither a symbol nor a minted `entity_id`, so a CIK is the only value guaranteed to exist for every member of the set.","items":{"type":"string"},"type":"array"},"confidence":{"allOf":[{"$ref":"#/components/schemas/ConfidenceTier"}],"nullable":true},"confidence_detail":{"allOf":[{"$ref":"#/components/schemas/ConfidenceDetail"}],"nullable":true},"confidence_version":{"nullable":true,"type":"string"},"disclosure_status":{"nullable":true,"type":"string"},"earnings":{"allOf":[{"$ref":"#/components/schemas/EarningsCard"}],"nullable":true},"enrichment_status":{"$ref":"#/components/schemas/EnrichmentStatus"},"entity_id":{"nullable":true,"type":"string"},"event_id":{"type":"string"},"event_subtype":{"type":"string"},"event_type":{"nullable":true,"type":"string"},"facets":{"allOf":[{"$ref":"#/components/schemas/FilingFacets"}],"nullable":true},"filed_at":{"type":"string"},"flags":{"description":"Additive open vocabulary; consumers must tolerate unknown values.","items":{"type":"string"},"type":"array"},"form":{"type":"string"},"full_text":{"description":"Raw primary-document text, when every gate permits it. See `FullTextStatus` for why it did or did not serve, the two fields are read together.","nullable":true,"type":"string"},"full_text_status":{"$ref":"#/components/schemas/FullTextStatus"},"headline":{"description":"One-line title (finks-api#433): `<Issuer>, <form> Item <n>, <item name>`, or the form and item alone when the issuer is unnamed. Built from served fields; no model call.","type":"string"},"ledger_event_id":{"description":"The event ledger id (`le1:`) of the real-world event this filing proves, shared by an 8-K and its 8-K/As. Absent when the ledger holds no row for it.","nullable":true,"type":"string"},"lifecycle":{"$ref":"#/components/schemas/Lifecycle"},"payload":{"nullable":true},"payload_schema_version":{"description":"The version of `payload`; always absent with it.","nullable":true,"type":"string"},"period":{"allOf":[{"$ref":"#/components/schemas/FilingPeriod"}],"nullable":true},"rights_class":{"$ref":"#/components/schemas/RightsClass"},"summary":{"nullable":true,"type":"string"},"summary_evidence":{"description":"The verbatim filing quotes behind each sentence of `summary`; absent when no sentence has one. Here without passage offsets: this route serves no section text.","items":{"$ref":"#/components/schemas/SummaryEvidence"},"type":"array"},"symbol":{"nullable":true,"type":"string"},"track_a_ref":{"allOf":[{"$ref":"#/components/schemas/TrackARef"}],"nullable":true},"type":{"$ref":"#/components/schemas/ContentType"}},"required":["event_id","type","form","event_subtype","co_registrants","filed_at","citation","enrichment_status","flags","rights_class","full_text_status","lifecycle"],"type":"object"},"FilingSection":{"properties":{"section_id":{"type":"string"},"text":{"nullable":true,"type":"string"},"text_sha256":{"description":"Lower-hex SHA-256 of `text` exactly as served (UTF-8, no normalization); absent with `text`.","nullable":true,"type":"string"},"title":{"description":"The section's title (`Item 2.02, Results of Operations and Financial Condition`); an offering or proxy filing's section heading as filed (`USE OF PROCEEDS`).","type":"string"}},"required":["section_id","title"],"type":"object"},"FloatEstimate":{"properties":{"blockholder_shares":{"description":"Schedule 13D and Rule 13d-1(d) 13G stakes not already counted as insiders'.","format":"double","type":"number"},"blockholders":{"format":"int32","minimum":0,"type":"integer"},"cik":{"description":"The issuer's CIK, 10 digits.","type":"string"},"float_ratio":{"description":"A **fraction** 0..1 of `shares_outstanding` (`0.9993` = 99.93%).","format":"double","nullable":true,"type":"number"},"float_shares":{"description":"Absent by design when `null_reason` says why; never 100% for want of data.","format":"double","nullable":true,"type":"number"},"holdings_as_of":{"description":"`YYYY-MM-DD`, the quarter end the insider and blockholder holdings are as of.","type":"string"},"insider_owners":{"format":"int32","minimum":0,"type":"integer"},"insider_shares":{"description":"Common shares held by Section 16 insiders. Absent with `float_shares`.","format":"double","nullable":true,"type":"number"},"null_reason":{"description":"Why the float is absent: `no_section16_statement`, `foreign_private_issuer` or `holdings_exceed_outstanding`.","nullable":true,"type":"string"},"shares_accession":{"type":"string"},"shares_as_of":{"description":"`YYYY-MM-DD`, the cover-page date of `shares_outstanding`.","type":"string"},"shares_form":{"description":"The form that reported it (`10-Q`, `20-F`).","nullable":true,"type":"string"},"shares_outstanding":{"format":"double","type":"number"},"symbol":{"nullable":true,"type":"string"}},"required":["cik","shares_outstanding","shares_as_of","shares_accession","insider_owners","holdings_as_of","blockholder_shares","blockholders"],"type":"object"},"FomcDocument":{"properties":{"attribution":{"description":"The citation to show with the document.","type":"string"},"document_type":{"description":"`statement` or `minutes`.","type":"string"},"meeting_date":{"description":"`YYYY-MM-DD`, the meeting's (last) day.","type":"string"},"published_at":{"description":"RFC 3339 UTC; absent for some 2006-2008 documents.","nullable":true,"type":"string"},"published_date":{"description":"`YYYY-MM-DD`, US Eastern time.","type":"string"},"title":{"type":"string"},"url":{"description":"The document on federalreserve.gov, its id.","type":"string"}},"required":["url","document_type","meeting_date","published_date","title","attribution"],"type":"object"},"FomcDocumentsResponse":{"description":"`GET /v1/fomc/documents`: FOMC statements and minutes, newest published first.","properties":{"has_more":{"type":"boolean"},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"},"results":{"description":"By `(published_date, url)` descending, at most `limit`.","items":{"$ref":"#/components/schemas/FomcDocument"},"type":"array"}},"required":["results","has_more"],"type":"object"},"FormDFiling":{"properties":{"accession":{"description":"EDGAR accession number (`0000935836-26-000432`), the filing's id.","type":"string"},"amount_remaining":{"description":"Absent when the offering amount is indefinite.","format":"double","nullable":true,"type":"number"},"amount_sold":{"format":"double","nullable":true,"type":"number"},"cik":{"description":"The primary issuer's CIK, 10 digits zero-padded.","type":"string"},"entity_type":{"description":"As filed (`Limited Partnership`, `Corporation`).","nullable":true,"type":"string"},"exemptions":{"description":"Exemptions and exclusions claimed, as filed (`06b`, `3C`, `3C.7`).","items":{"type":"string"},"type":"array"},"file_number":{"description":"SEC file number (`021-252157`): the offering, shared by its amendments.","type":"string"},"filing_date":{"description":"`YYYY-MM-DD`, the EDGAR filing date.","type":"string"},"first_sale_date":{"description":"`YYYY-MM-DD`, the date of first sale.","nullable":true,"type":"string"},"industry_group":{"description":"As filed (`Pooled Investment Fund`, `Biotechnology`).","nullable":true,"type":"string"},"investment_fund_type":{"description":"Pooled funds only, as filed (`Hedge Fund`, `Venture Capital Fund`).","nullable":true,"type":"string"},"investors":{"description":"Investors who have already invested.","format":"int32","minimum":0,"nullable":true,"type":"integer"},"is_current":{"description":"This is the offering's current (latest) filing.","type":"boolean"},"issuer_name":{"type":"string"},"minimum_investment":{"format":"double","nullable":true,"type":"number"},"non_accredited_investors":{"format":"int32","minimum":0,"nullable":true,"type":"integer"},"offering_amount":{"description":"Total offering amount; absent when `offering_amount_indefinite`.","format":"double","nullable":true,"type":"number"},"offering_amount_indefinite":{"description":"The filing states the total offering amount as `Indefinite`.","type":"boolean"},"related_persons":{"description":"Executive officers, directors and promoters named on the filing, in filed order.","items":{"$ref":"#/components/schemas/FormDRelatedPerson"},"type":"array"},"security_types":{"description":"Types of securities offered (`equity`, `debt`, `pooled_investment_fund`).","items":{"type":"string"},"type":"array"},"source_url":{"description":"The filing's EDGAR index page.","type":"string"},"state_or_country":{"description":"The issuer's address state or country code, as filed (`CA`, `DE`).","nullable":true,"type":"string"},"symbol":{"description":"The issuer's ticker when it has exactly one; mostly absent (private issuers).","nullable":true,"type":"string"}},"required":["accession","file_number","cik","issuer_name","exemptions","security_types","filing_date","offering_amount_indefinite","related_persons","source_url","is_current"],"type":"object"},"FormDRelatedPerson":{"description":"A related person named on a Form D filing.","properties":{"name":{"type":"string"},"role":{"description":"The person's roles, comma-joined as filed (`Executive Officer,Director`).","type":"string"}},"required":["name","role"],"type":"object"},"FormDResponse":{"description":"`GET /v1/form-d`: SEC Form D exempt-offering filings, newest filing first.","properties":{"has_more":{"type":"boolean"},"interpretation":{"allOf":[{"$ref":"#/components/schemas/SetReading"}],"nullable":true},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"},"results":{"description":"By `(filing_date, accession)` descending, at most `limit` filings, may be empty.","items":{"$ref":"#/components/schemas/FormDFiling"},"type":"array"}},"required":["results","has_more"],"type":"object"},"FullTextStatus":{"enum":["not_requested","served","withheld_rights_class","withheld_rights_status","withheld_exhibit_counsel_gate","withheld_pending","withheld_disposition","unavailable"],"type":"string"},"FundHolding":{"properties":{"asset_category":{"description":"N-PORT's asset category code (`EC` equity common, `DBT` debt, ...).","nullable":true,"type":"string"},"balance":{"format":"double","nullable":true,"type":"number"},"balance_unit":{"nullable":true,"type":"string"},"country":{"description":"The issuer's country code (`US`).","nullable":true,"type":"string"},"currency":{"nullable":true,"type":"string"},"fair_value_level":{"description":"The fair-value hierarchy level (`1`, `2`, `3`).","nullable":true,"type":"string"},"filing_date":{"description":"`YYYY-MM-DD`, when that report was filed (N-PORT only).","nullable":true,"type":"string"},"holding_lei":{"nullable":true,"type":"string"},"holding_name":{"nullable":true,"type":"string"},"holding_symbol":{"description":"The security's ticker as reported (`BRK-B`, `7203.T`).","nullable":true,"type":"string"},"holding_title":{"nullable":true,"type":"string"},"is_restricted":{"nullable":true,"type":"boolean"},"issuer_category":{"description":"N-PORT's issuer category code (`CORP`, `UST`, ...).","nullable":true,"type":"string"},"ordinal":{"format":"int32","minimum":0,"type":"integer"},"payoff_profile":{"description":"`Long`, `Short` or `N/A`.","nullable":true,"type":"string"},"pct_of_net_assets":{"description":"**Percent** of the fund's net assets (`7.51` = 7.51%), as reported.","format":"double","nullable":true,"type":"number"},"report_date":{"description":"`YYYY-MM-DD`, the portfolio's report date.","type":"string"},"value_usd":{"format":"double","nullable":true,"type":"number"}},"required":["ordinal","report_date"],"type":"object"},"FundOwner":{"description":"One fund's position in the security asked for, its positions in it summed.","properties":{"fund_name":{"nullable":true,"type":"string"},"holdings_source":{"description":"`sec_nport` or `etf_holdings_feed`.","type":"string"},"pct_of_net_assets":{"description":"**Percent** of the fund's net assets, the positions' sum.","format":"double","nullable":true,"type":"number"},"portfolio_id":{"description":"The fund's portfolio (`GET /v1/funds/{symbol}` of any of `symbols` serves it whole).","type":"string"},"positions":{"description":"How many of the portfolio's positions the security is.","format":"int32","minimum":0,"type":"integer"},"registrant_name":{"nullable":true,"type":"string"},"report_date":{"description":"`YYYY-MM-DD`, the portfolio's report date.","type":"string"},"symbols":{"description":"The share classes served under this portfolio, sorted; empty for a fund no symbol maps to.","items":{"type":"string"},"type":"array"},"value_usd":{"format":"double","nullable":true,"type":"number"}},"required":["portfolio_id","holdings_source","symbols","report_date","positions"],"type":"object"},"FundOwnersResponse":{"description":"`GET /v1/funds?holding={symbol}`: the funds holding a security, largest position first.","properties":{"has_more":{"type":"boolean"},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"},"results":{"description":"By `value_usd` descending (a fund without one last), at most `limit`, may be empty.","items":{"$ref":"#/components/schemas/FundOwner"},"type":"array"}},"required":["results","has_more"],"type":"object"},"FundProfile":{"properties":{"acquired_fund_fees":{"format":"double","nullable":true,"type":"number"},"advisers":{"description":"From the N-CEN census, possibly empty.","items":{"type":"string"},"type":"array"},"census_accession":{"nullable":true,"type":"string"},"census_report_date":{"description":"`YYYY-MM-DD`, the N-CEN report the census columns come from.","nullable":true,"type":"string"},"cik":{"description":"The registrant's CIK, 10 digits.","nullable":true,"type":"string"},"class_id":{"nullable":true,"type":"string"},"class_name":{"nullable":true,"type":"string"},"distribution_12b1_fee":{"format":"double","nullable":true,"type":"number"},"fee_waiver":{"format":"double","nullable":true,"type":"number"},"fees_accession":{"nullable":true,"type":"string"},"fees_as_of_date":{"description":"`YYYY-MM-DD`, the fee table's as-of date.","nullable":true,"type":"string"},"fees_filing_date":{"description":"`YYYY-MM-DD`, when the prospectus carrying the fee table was filed.","nullable":true,"type":"string"},"fund_id":{"description":"The SEC fund: series id (`S000002839`), or the 10-digit registrant CIK of a fund without series (`0000884394`, SPY).","nullable":true,"type":"string"},"fund_name":{"nullable":true,"type":"string"},"gross_expense_ratio":{"format":"double","nullable":true,"type":"number"},"holdings_accession":{"description":"That report's accession.","nullable":true,"type":"string"},"holdings_source":{"nullable":true,"type":"string"},"inception_date":{"description":"`YYYY-MM-DD`; absent on about half the funds.","nullable":true,"type":"string"},"is_etf":{"type":"boolean"},"is_fund":{"type":"boolean"},"is_fund_of_funds":{"nullable":true,"type":"boolean"},"is_index_fund":{"nullable":true,"type":"boolean"},"is_interval_fund":{"nullable":true,"type":"boolean"},"is_money_market_fund":{"nullable":true,"type":"boolean"},"is_target_date_fund":{"nullable":true,"type":"boolean"},"management_fee":{"description":"Fraction of net assets a year (`0.0075` = 0.75%), as every fee below.","format":"double","nullable":true,"type":"number"},"net_assets":{"description":"USD, from the newest N-PORT report.","format":"double","nullable":true,"type":"number"},"net_assets_date":{"description":"`YYYY-MM-DD`, that report's date.","nullable":true,"type":"string"},"net_expense_ratio":{"description":"Gross less any waiver; the gross ratio when the prospectus states no waiver.","format":"double","nullable":true,"type":"number"},"nport_is_final_filing":{"description":"That report is the fund's final N-PORT filing.","nullable":true,"type":"boolean"},"other_expenses":{"format":"double","nullable":true,"type":"number"},"portfolio_id":{"description":"The fund's portfolio, shared by its share classes: the SEC fund id, or the symbol for an ETF SEC does not cover. Absent: no portfolio is served.","nullable":true,"type":"string"},"registrant_name":{"nullable":true,"type":"string"},"registration_form":{"description":"The registration form (`N-1A`, `N-2`, ...).","nullable":true,"type":"string"},"series_id":{"nullable":true,"type":"string"},"subadvisers":{"items":{"type":"string"},"type":"array"},"symbol":{"type":"string"},"waiver_expiry_date":{"description":"`YYYY-MM-DD`.","nullable":true,"type":"string"}},"required":["symbol","is_fund","is_etf"],"type":"object"},"FundResponse":{"description":"`GET /v1/funds/{symbol}`: one fund's profile and a page of its holdings, largest first.","properties":{"fund":{"$ref":"#/components/schemas/FundProfile"},"has_more":{"type":"boolean"},"holdings":{"description":"By `value_usd` descending (a position without one last, in filing order), at most `limit`, may be empty: a fund whose newest report lists no positions, or that has no portfolio (`portfolio_id` absent).","items":{"$ref":"#/components/schemas/FundHolding"},"type":"array"},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"}},"required":["fund","holdings","has_more"],"type":"object"},"FundTaxFactors":{"properties":{"attribution":{"description":"`Source: Global X Investments Canada Inc.`: show it with the factors.","type":"string"},"capital_gains":{"description":"T3 box 21.","format":"double","nullable":true,"type":"number"},"currency":{"description":"`USD` for a `.U` unit class, else `CAD`.","type":"string"},"document":{"description":"The issuer's published file the factors were read from.","type":"string"},"eligible_dividends":{"description":"T3 box 49.","format":"double","nullable":true,"type":"number"},"foreign_income":{"description":"T3 box 25.","format":"double","nullable":true,"type":"number"},"foreign_tax_paid":{"description":"T3 box 34, positive.","format":"double","nullable":true,"type":"number"},"issuer":{"description":"`globalx`.","type":"string"},"issuer_page_url":{"description":"The issuer's page publishing the summaries: link it with the factors.","type":"string"},"other_income":{"description":"T3 box 26.","format":"double","nullable":true,"type":"number"},"period":{"description":"`annual`: the year's total.","type":"string"},"return_of_capital":{"description":"T3 box 42.","format":"double","nullable":true,"type":"number"},"symbol":{"nullable":true,"type":"string"},"tax_year":{"format":"int32","type":"integer"},"ticker":{"description":"The fund's ticker as the issuer prints it (`BKCC`, `USCC.U`).","type":"string"},"total":{"description":"Total distribution per unit.","format":"double","type":"number"}},"required":["ticker","issuer","tax_year","period","currency","total","document","issuer_page_url","attribution"],"type":"object"},"FundTaxFactorsResponse":{"description":"`GET /v1/funds/{symbol}/tax-factors`: a Canadian ETF's T3 tax factors, newest tax year first.","properties":{"has_more":{"type":"boolean"},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"},"results":{"description":"By `tax_year` descending, at most `limit`, never bounded by the plan's history window; may be empty.","items":{"$ref":"#/components/schemas/FundTaxFactors"},"type":"array"}},"required":["results","has_more"],"type":"object"},"FundingRound":{"properties":{"accession":{"description":"The offering's current filing.","nullable":true,"type":"string"},"amount_kind":{"description":"`filed` (Form D), `as_reported` (news) or `derived`.","type":"string"},"amount_raised":{"description":"Form D: USD sold to date in the offering, cumulative; news: the round's amount as reported, in `currency`.","format":"double","nullable":true,"type":"number"},"announced_on":{"description":"`YYYY-MM-DD`, the earliest news report.","nullable":true,"type":"string"},"best_source_type":{"description":"`form_d`, `newsroom` or `brief`.","type":"string"},"cik":{"nullable":true,"type":"string"},"company_key":{"description":"A tracked company's slug (`anduril`), else `cik:<10 digits>` or `name:<normalized>`.","type":"string"},"company_name":{"type":"string"},"currency":{"description":"`USD` for Form D; as reported for news; absent when no amount is stated.","nullable":true,"type":"string"},"entity_id":{"description":"The Entity Graph id (`ent_…`), when it has one.","nullable":true,"type":"string"},"file_number":{"nullable":true,"type":"string"},"filings":{"format":"int32","nullable":true,"type":"integer"},"first_filed_on":{"nullable":true,"type":"string"},"first_sale_on":{"description":"`YYYY-MM-DD`, Form D's date of first sale.","nullable":true,"type":"string"},"industry_group":{"nullable":true,"type":"string"},"investor_count":{"format":"int32","nullable":true,"type":"integer"},"issuer_name":{"nullable":true,"type":"string"},"last_filed_on":{"nullable":true,"type":"string"},"offering_amount":{"description":"Form D's total offering amount; absent when indefinite or not filed.","format":"double","nullable":true,"type":"number"},"offering_amount_indefinite":{"nullable":true,"type":"boolean"},"round_date":{"nullable":true,"type":"string"},"round_id":{"description":"`formd:<SEC file number>` or `news:<sha>`.","type":"string"},"round_label":{"description":"As news reported it (`Series H`).","nullable":true,"type":"string"},"security_types":{"items":{"type":"string"},"type":"array"},"source_url":{"description":"The sec.gov index page, or the best news report.","type":"string"},"statements":{"items":{"$ref":"#/components/schemas/FundingRoundStatement"},"type":"array"},"status":{"description":"`filed`, `announced`, `reported`, `in_talks` or `seeking` (the last two: not raised).","type":"string"},"symbol":{"description":"Set when the issuer is listed (a listed issuer's Reg D placement).","nullable":true,"type":"string"}},"required":["round_id","company_key","company_name","status","amount_kind","best_source_type","source_url"],"type":"object"},"FundingRoundStatement":{"description":"One sourced fact about a funding round.","properties":{"accession":{"nullable":true,"type":"string"},"confidence":{"description":"0-100: filed and newsroom 100; a brief, its extractor's confidence.","format":"int32","minimum":0,"type":"integer"},"currency":{"nullable":true,"type":"string"},"evidence":{"description":"At most 300 characters.","type":"string"},"field":{"description":"`amount_sold`, `offering_amount`, `first_sale_on`, `investor_count`, `security_types` (Form D); `amount_raised`, `round_label`, `announced_on`, `valuation_post`, `valuation_pre`, `lead_investor`, `participant`, `total_raised_to_date` (news; the company's total across all rounds as the brief prints it, never a round's amount).","type":"string"},"observed_on":{"description":"`YYYY-MM-DD`, the filing date or the report's.","type":"string"},"round_id":{"type":"string"},"source_id":{"description":"The accession, brief id or newsroom post URL.","type":"string"},"source_type":{"description":"`form_d`, `brief` or `newsroom`.","type":"string"},"source_url":{"description":"The sec.gov page, the brief's first cited article, or the newsroom post.","type":"string"},"source_urls":{"items":{"type":"string"},"type":"array"},"statement_id":{"type":"string"},"status":{"type":"string"},"value_entity_id":{"description":"An investor's Entity Graph id, when resolved.","nullable":true,"type":"string"},"value_kind":{"description":"`filed`, `as_reported` or `derived`.","type":"string"},"value_num":{"format":"double","nullable":true,"type":"number"},"value_text":{"type":"string"}},"required":["statement_id","round_id","source_type","value_kind","status","field","value_text","source_id","source_url","observed_on","confidence","evidence"],"type":"object"},"FundingRoundsResponse":{"description":"`GET /v1/funding`: a company's funding rounds, newest `round_date` first; or, with `category`/`after`/`before`, the window's largest raisers (`SetReading`).","properties":{"has_more":{"type":"boolean"},"interpretation":{"allOf":[{"$ref":"#/components/schemas/SetReading"}],"nullable":true},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page (always, for a set).","nullable":true,"type":"string"},"results":{"description":"By `(round_date, round_id)` descending, at most `limit`, never before the plan's history window; may be empty. A set: one round per company (its largest in the window) for its members and its unsure companies, `amount_raised` descending.","items":{"$ref":"#/components/schemas/FundingRound"},"type":"array"}},"required":["results","has_more"],"type":"object"},"H1bEmployerYear":{"description":"One employer's H-1B petitions in one fiscal year, as USCIS publishes them. No tax id or personal field; an employer named after a person is not served.","properties":{"attribution":{"description":"`Source: USCIS H-1B Employer Data Hub`: show it with the row.","type":"string"},"city":{"nullable":true,"type":"string"},"company_key":{"description":"The tracked company's slug (`openai`), or `cik:<10 digits>` for a Form D issuer.","type":"string"},"continuing_approvals":{"format":"int64","type":"integer"},"continuing_denials":{"format":"int64","type":"integer"},"employer_key":{"description":"`<normalized name>|<state>` (`OPENAI OPCO LLC|CA`).","type":"string"},"employer_name":{"description":"As filed.","type":"string"},"fiscal_year":{"format":"int32","type":"integer"},"initial_approvals":{"format":"int64","type":"integer"},"initial_denials":{"format":"int64","type":"integer"},"match_basis":{"description":"How the employer was matched to the company (`employer_name_state_seed`, reviewed).","type":"string"},"naics2":{"description":"The two-digit NAICS sector USCIS lists.","nullable":true,"type":"string"},"observed_on":{"description":"`YYYY-MM-DD`.","type":"string"},"publisher":{"description":"`U.S. Citizenship and Immigration Services`.","type":"string"},"source_type":{"description":"`uscis_h1b_hub`.","type":"string"},"source_url":{"description":"The hub's CSV for FY2023 and before, else the hub page.","type":"string"},"state":{"type":"string"},"value_kind":{"description":"`filed`: USCIS's counts as filed.","type":"string"}},"required":["company_key","fiscal_year","employer_key","employer_name","state","initial_approvals","initial_denials","continuing_approvals","continuing_denials","source_type","source_url","publisher","attribution","value_kind","match_basis","observed_on"],"type":"object"},"H1bYear":{"properties":{"approvals":{"description":"`initial_approvals + continuing_approvals`.","format":"int64","type":"integer"},"attribution":{"description":"`Source: USCIS H-1B Employer Data Hub`: show it with the figures.","type":"string"},"continuing_approvals":{"description":"Continuation, change with the same employer, change of employer, amended petitions.","format":"int64","type":"integer"},"continuing_denials":{"format":"int64","type":"integer"},"denials":{"description":"`initial_denials + continuing_denials`.","format":"int64","type":"integer"},"employers":{"description":"The employers summed.","format":"int32","minimum":0,"type":"integer"},"fiscal_year":{"format":"int32","type":"integer"},"initial_approvals":{"description":"New employment and new concurrent employment.","format":"int64","type":"integer"},"initial_denials":{"format":"int64","type":"integer"},"observed_on":{"type":"string"}},"required":["fiscal_year","approvals","denials","initial_approvals","initial_denials","continuing_approvals","continuing_denials","employers","observed_on","attribution"],"type":"object"},"HiringResponse":{"description":"`GET /v1/hiring`: a company's US work-visa filings by fiscal year, the newest first.","properties":{"h1b_attribution":{"description":"USCIS's attribution, as on every H-1B row: show it wherever those figures are shown. Absent when the page has no H-1B row.","nullable":true,"type":"string"},"has_more":{"type":"boolean"},"lca_attribution":{"description":"The Department of Labor's attribution, as on every LCA row: show it wherever those figures are shown, implying no DOL endorsement. Absent when the page has no LCA row.","nullable":true,"type":"string"},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"},"results":{"description":"By `fiscal_year` descending, at most `limit` years, never a year that ended before the plan's history window; may be empty.","items":{"$ref":"#/components/schemas/HiringYear"},"type":"array"}},"required":["results","has_more"],"type":"object"},"HiringYear":{"description":"One US government fiscal year (October 1 of the year before to September 30) of a company's H-1B petitions and Labor Condition Applications.","properties":{"fiscal_year":{"description":"`2026`: FY2026 ran from 2025-10-01 to 2026-09-30.","format":"int32","type":"integer"},"h1b":{"allOf":[{"$ref":"#/components/schemas/H1bYear"}],"nullable":true},"h1b_employers":{"description":"The H-1B rows the totals sum, one per employer, by `employer_key`.","items":{"$ref":"#/components/schemas/H1bEmployerYear"},"type":"array"},"lca":{"allOf":[{"$ref":"#/components/schemas/LcaYear"}],"nullable":true},"lca_positions":{"description":"The LCA rows the totals sum, by `(employer_key, soc_major_group, visa_class)`.","items":{"$ref":"#/components/schemas/LcaPosition"},"type":"array"}},"required":["fiscal_year","h1b_employers","lca_positions"],"type":"object"},"Holder":{"description":"One 13F filer's position in the stock: its common-share lines (no options, no principal amounts) summed, from its current report plus later new-holdings amendments.","properties":{"accession":{"description":"The newest 13F filing behind the position (`0001067983-26-000001`).","type":"string"},"filer_cik":{"description":"The 13F filer's CIK, 10 digits.","type":"string"},"filer_name":{"nullable":true,"type":"string"},"shares":{"description":"Shares held.","format":"int64","type":"integer"},"value_usd":{"description":"US dollars, as reported for the quarter end (normalised from the filer's unit).","format":"int64","type":"integer"}},"required":["filer_cik","shares","value_usd","accession"],"type":"object"},"HoldersResponse":{"description":"`GET /v1/companies/{symbol}/holders`: the institutional managers that reported the stock on Form 13F for one quarter end, largest position first.","properties":{"has_more":{"type":"boolean"},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"},"period_of_report":{"description":"`YYYY-MM-DD`, the quarter end the positions are as of.","type":"string"},"results":{"description":"By `value_usd` descending, at most `limit`, may be empty.","items":{"$ref":"#/components/schemas/Holder"},"type":"array"}},"required":["period_of_report","results","has_more"],"type":"object"},"InsiderFacts":{"properties":{"officer_title":{"nullable":true,"type":"string"},"owner":{"description":"The reporting owner, as filed (`Parekh Kevan`).","type":"string"},"plan_10b5_1":{"description":"Whether the filing marks its transactions as made under a Rule 10b5-1 plan. Absent when the filing does not say.","nullable":true,"type":"boolean"},"roles":{"items":{"type":"string"},"type":"array"},"shares_owned_after":{"description":"Shares the owner holds after the filing's last transaction day. Absent when not filed, or when that day holds both an acquisition and a disposition (the table keeps no order within a day).","format":"double","nullable":true,"type":"number"},"transactions":{"items":{"$ref":"#/components/schemas/InsiderTransaction"},"type":"array"}},"required":["owner","roles","transactions"],"type":"object"},"InsiderTransaction":{"description":"What a Form 4 reports for one transaction day and direction.","properties":{"codes":{"description":"SEC transaction codes, as filed (`P` open-market purchase, `S` open-market sale, `A` grant or award, `M` option exercise, `F` tax withholding, `G` gift, …).","items":{"type":"string"},"type":"array"},"count":{"description":"How many transactions the filing lists for that day and direction.","format":"int32","minimum":0,"type":"integer"},"date":{"description":"`YYYY-MM-DD`.","type":"string"},"direction":{"description":"`acquired` or `disposed`.","type":"string"},"price":{"description":"US dollars per share, the value-weighted average. Absent when not filed (an award).","format":"double","nullable":true,"type":"number"},"shares":{"description":"Shares, summed. Absent when not filed.","format":"double","nullable":true,"type":"number"},"value":{"description":"US dollars, summed. Absent when not filed.","format":"double","nullable":true,"type":"number"}},"required":["date","direction","codes","count"],"type":"object"},"Interpretation":{"properties":{"beta":{"description":"`true` on every natural-language screen: a beta, served best effort. Read this interpretation and `normalized_query` before relying on the rows.","type":"boolean"},"compiler":{"nullable":true,"type":"string"},"defaults_applied":{"items":{"$ref":"#/components/schemas/AppliedDefault"},"type":"array"},"feasible":{"description":"Diagnostic: always `true` on a served page (an infeasible screen is a 400).","type":"boolean"},"mapped_symbols":{"items":{"$ref":"#/components/schemas/MappedSymbol"},"type":"array"},"unmapped_clauses":{"items":{"type":"string"},"type":"array"},"unsupported_clauses":{"items":{"$ref":"#/components/schemas/UnsupportedClause"},"type":"array"}},"required":["feasible"],"type":"object"},"KeyEnv":{"enum":["test","live"],"type":"string"},"KeyStatusView":{"description":"A key's lifecycle state, derived with the *same* predicates authentication uses: revoked wins over expired, exactly as in `src/auth.rs`.","enum":["active","revoked","expired"],"type":"string"},"KeysUnavailableReason":{"enum":["key_store_unreadable"],"type":"string"},"KeysView":{"description":"The account's keys. The list is a query against an eventually-consistent secondary index, so a key minted or revoked moments ago may be missing or stale here while authentication, which is strongly consistent, already reflects it.","discriminator":{"propertyName":"state"},"oneOf":[{"properties":{"keys":{"items":{"$ref":"#/components/schemas/MaskedKeyView"},"type":"array"},"state":{"enum":["listed"],"type":"string"}},"required":["keys","state"],"type":"object"},{"properties":{"reason":{"$ref":"#/components/schemas/KeysUnavailableReason"},"state":{"enum":["unavailable"],"type":"string"}},"required":["reason","state"],"type":"object"}]},"LcaPosition":{"description":"One employer's Labor Condition Applications in one fiscal year, SOC major group and visa class, aggregated from DOL's disclosure files. No case number, EIN or personal field.","properties":{"attribution":{"description":"`Source: U.S. Department of Labor, OFLC LCA disclosure data`: show it with the row; no DOL endorsement may be implied.","type":"string"},"cases_certified":{"format":"int64","type":"integer"},"cases_certified_withdrawn":{"format":"int64","type":"integer"},"cases_denied":{"format":"int64","type":"integer"},"cases_withdrawn":{"format":"int64","type":"integer"},"company_key":{"type":"string"},"employer_city":{"nullable":true,"type":"string"},"employer_key":{"type":"string"},"employer_name":{"type":"string"},"fiscal_year":{"format":"int32","type":"integer"},"match_basis":{"type":"string"},"naics_code":{"nullable":true,"type":"string"},"observed_on":{"description":"`YYYY-MM-DD`.","type":"string"},"positions_certified":{"description":"Positions on certified LCAs: an intent to hire, not a hire.","format":"int64","type":"integer"},"publisher":{"description":"`U.S. Department of Labor`.","type":"string"},"soc_major_group":{"description":"The SOC major group (`15`: computer and mathematical), or `unknown`.","type":"string"},"source_type":{"description":"`dol_oflc_lca`.","type":"string"},"source_url":{"description":"DOL OFLC's performance-data page.","type":"string"},"value_kind":{"type":"string"},"visa_class":{"description":"`H-1B`, `H-1B1 Chile`, `H-1B1 Singapore` or `E-3 Australian`.","type":"string"},"wage_cases":{"description":"The cases the median is over.","format":"int64","nullable":true,"type":"integer"},"wage_median_usd":{"description":"The median annualised offered wage of the certified full-time cases, USD. Absent when withheld (`wage_suppressed`) or when no case carries one: never show a wage then.","format":"double","nullable":true,"type":"number"},"wage_suppressed":{"description":"The median is withheld: fewer than 3 cases carry it.","type":"boolean"}},"required":["company_key","fiscal_year","employer_key","soc_major_group","visa_class","employer_name","cases_certified","cases_certified_withdrawn","cases_denied","cases_withdrawn","positions_certified","wage_suppressed","source_type","source_url","publisher","attribution","value_kind","match_basis","observed_on"],"type":"object"},"LcaVisaClassPositions":{"properties":{"positions_certified":{"format":"int64","type":"integer"},"visa_class":{"description":"`H-1B`, `H-1B1 Chile`, `H-1B1 Singapore` or `E-3 Australian`.","type":"string"}},"required":["visa_class","positions_certified"],"type":"object"},"LcaYear":{"properties":{"attribution":{"description":"`Source: U.S. Department of Labor, OFLC LCA disclosure data`: show it with the figures; no DOL endorsement may be implied.","type":"string"},"by_visa_class":{"description":"The certified positions per visa class, the most first.","items":{"$ref":"#/components/schemas/LcaVisaClassPositions"},"type":"array"},"cases_certified":{"format":"int64","type":"integer"},"cases_certified_withdrawn":{"format":"int64","type":"integer"},"cases_denied":{"format":"int64","type":"integer"},"cases_withdrawn":{"format":"int64","type":"integer"},"fiscal_year":{"format":"int32","type":"integer"},"observed_on":{"type":"string"},"positions_certified":{"description":"Positions on certified LCAs.","format":"int64","type":"integer"}},"required":["fiscal_year","positions_certified","cases_certified","cases_certified_withdrawn","cases_denied","cases_withdrawn","by_visa_class","observed_on","attribution"],"type":"object"},"LedgerSubject":{"description":"Whom a ledger event happened to: the 8-K filer, a Form 4's or 13D/13G's issuer, a 13F's filer.","properties":{"cik":{"description":"10-digit, zero-padded.","type":"string"},"name":{"description":"The name as filed.","nullable":true,"type":"string"},"symbol":{"nullable":true,"type":"string"}},"required":["cik"],"type":"object"},"Lifecycle":{"enum":["published","updated","unpublished"],"type":"string"},"LimitsView":{"properties":{"deep_search":{"nullable":true,"type":"boolean"},"heavy_rate_limit_per_minute":{"description":"The heavy routes' (search, screener, research, workflows) per-minute sub-limit, counted on the same window as `rate_limit_per_minute`.","format":"int32","minimum":0,"nullable":true,"type":"integer"},"history_window":{"format":"int32","minimum":0,"nullable":true,"type":"integer"},"included_units":{"format":"int64","minimum":0,"nullable":true,"type":"integer"},"page_cap":{"format":"int32","minimum":0,"nullable":true,"type":"integer"},"rate_limit_per_minute":{"format":"int32","minimum":0,"nullable":true,"type":"integer"},"redistribution":{"nullable":true,"type":"string"},"result_types":{"items":{"type":"string"},"nullable":true,"type":"array"},"routes":{"items":{"type":"string"},"nullable":true,"type":"array"},"streaming_enabled":{"nullable":true,"type":"boolean"}},"type":"object"},"LiveQuote":{"properties":{"as_of":{"description":"RFC 3339 UTC: the time of the trade behind `price`.","type":"string"},"basis":{"description":"Always `live`.","type":"string"},"change":{"description":"`price - previous_close`, USD.","format":"double","nullable":true,"type":"number"},"change_percentage":{"description":"The change as a **percent** of `previous_close` (`1.5` = 1.5%).","format":"double","nullable":true,"type":"number"},"market_cap":{"format":"double","nullable":true,"type":"number"},"previous_close":{"description":"The prior session's close, USD.","format":"double","nullable":true,"type":"number"},"price":{"description":"The last trade price, USD.","format":"double","type":"number"},"read_at":{"description":"RFC 3339 UTC: when the quote was read.","type":"string"},"session":{"description":"The US equity session at the request: `open` or `closed`.","type":"string"},"source":{"description":"Always `live_quote`.","type":"string"},"symbol":{"type":"string"},"volume":{"description":"Shares traded in the session so far (or the last session, when closed).","format":"double","nullable":true,"type":"number"}},"required":["symbol","price","as_of","read_at","session","basis","source"],"type":"object"},"MacroCalendarResponse":{"description":"`GET /v1/macro/calendar`: scheduled US macro releases, soonest first.","properties":{"has_more":{"type":"boolean"},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"},"results":{"description":"By `release_at`, then `event_id`, then `series_id`, at most `limit`.","items":{"$ref":"#/components/schemas/MacroRelease"},"type":"array"}},"required":["results","has_more"],"type":"object"},"MacroObservation":{"description":"One period's value, the agency's current vintage. Never converted: read `unit`.","properties":{"attribution":{"description":"The citation to show with the value.","type":"string"},"change":{"description":"`value` minus the previous period's, in `unit`; absent when that period is unpublished.","format":"double","nullable":true,"type":"number"},"change_pct":{"description":"Percent change on the previous period (2.0 = 2%); non-percent units only.","format":"double","nullable":true,"type":"number"},"change_pct_yoy":{"description":"Percent change on the same period a year earlier (2.0 = 2%); non-percent units only.","format":"double","nullable":true,"type":"number"},"period_start":{"description":"`YYYY-MM-DD`, the first day of the month or quarter.","type":"string"},"source":{"description":"The publisher: `bls`, `bea` or `census`.","type":"string"},"unit":{"type":"string"},"value":{"description":"As published, in `unit`.","format":"double","type":"number"}},"required":["period_start","value","unit","source","attribution"],"type":"object"},"MacroObservationsResponse":{"description":"`GET /v1/macro/series/{series_id}/observations`: one series, newest period first.","properties":{"has_more":{"type":"boolean"},"label":{"description":"The series' short label (`Nonfarm payrolls`), as `GET /v1/macro/series` gives it; absent for a series not yet curated.","nullable":true,"type":"string"},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"},"results":{"description":"By `period_start` descending, at most `limit`, may be empty.","items":{"$ref":"#/components/schemas/MacroObservation"},"type":"array"},"series_id":{"type":"string"}},"required":["series_id","results","has_more"],"type":"object"},"MacroRelease":{"properties":{"attribution":{"description":"The citation to show with `previous_value`: its series' attribution. Present whenever `previous_value` is.","nullable":true,"type":"string"},"event_id":{"description":"The release event's id; changes if the agency reschedules it.","type":"string"},"previous_change":{"format":"double","nullable":true,"type":"number"},"previous_change_pct":{"format":"double","nullable":true,"type":"number"},"previous_change_pct_yoy":{"format":"double","nullable":true,"type":"number"},"previous_period_start":{"description":"`YYYY-MM-DD`, the period of `previous_value`.","nullable":true,"type":"string"},"previous_value":{"description":"The series' latest value before this release's period (for the FOMC, before the decision day), in `unit`.","format":"double","nullable":true,"type":"number"},"reference_frequency":{"nullable":true,"type":"string"},"reference_period":{"description":"The period the release reports, as the agency names it.","nullable":true,"type":"string"},"reference_period_start":{"description":"`YYYY-MM-DD`.","nullable":true,"type":"string"},"release_at":{"description":"RFC 3339 UTC, when the release is published.","type":"string"},"release_date":{"description":"`YYYY-MM-DD`, the release day in US Eastern time.","type":"string"},"release_key":{"description":"`cpi`, `employment_situation`, `fomc_decision`, ...; absent when unmapped.","nullable":true,"type":"string"},"release_name":{"description":"The agency's title of the release.","type":"string"},"series_id":{"description":"The headline series: a `/v1/macro/series` id, or for the FOMC a `/v1/rates` series (`fed_funds_target_upper`).","nullable":true,"type":"string"},"source":{"description":"The publisher: `bls`, `bea`, `census` or `fed`.","type":"string"},"unit":{"description":"The unit of `previous_value`: the agency's for a macro series (`percent`: 4.2 = 4.2%), `fraction` for the FOMC target range (0.0375 = 3.75%).","nullable":true,"type":"string"}},"required":["event_id","source","release_name","release_at","release_date"],"type":"object"},"MacroSeries":{"properties":{"attribution":{"description":"The citation to show with any of its values (`Source: U.S. Bureau of Labor Statistics`).","type":"string"},"first_period_start":{"description":"`YYYY-MM-DD`, the first period served (history from 1913).","type":"string"},"frequency":{"description":"`M` (monthly) or `Q` (quarterly).","type":"string"},"label":{"description":"A short human label, at most 40 characters (`cpi_u_sa`: `CPI`); the agency's `title` for a series not yet curated.","type":"string"},"last_period_start":{"description":"`YYYY-MM-DD`, the latest period published.","type":"string"},"seasonal_adjustment":{"description":"`sa`, `nsa` or `saar`.","type":"string"},"series_id":{"description":"Finks' id (`cpi_u_sa`), the `{series_id}` of its observations route.","type":"string"},"source":{"description":"The publisher: `bls`, `bea` or `census`.","type":"string"},"source_code":{"description":"The publisher's own series code (`CUSR0000SA0`).","type":"string"},"title":{"description":"The agency's own title of the series.","type":"string"},"unit":{"description":"The unit every value is in, as the agency publishes it (`index`, `percent`, `thousands`, `usd`, `hours`, `usd_millions`, `usd_millions_chained`, `thousands_annual_rate`). A `percent` is a percent: 4.2 is 4.2%.","type":"string"}},"required":["series_id","title","unit","frequency","seasonal_adjustment","source","source_code","attribution","first_period_start","last_period_start"],"type":"object"},"MacroSeriesResponse":{"description":"`GET /v1/macro/series`: every US macro series served, by `series_id`.","properties":{"results":{"items":{"$ref":"#/components/schemas/MacroSeries"},"type":"array"}},"required":["results"],"type":"object"},"MappedSymbol":{"description":"A ticker a `symbol` predicate named that is another listing of a served company (a secondary share class, warrant, unit or right), and the company's served ticker the screen ran in its place: `GOOG` -> `GOOGL`, `BRK-A` -> `BRK-B`.","properties":{"primary":{"type":"string"},"symbol":{"type":"string"}},"required":["symbol","primary"],"type":"object"},"MaskedKeyView":{"properties":{"allowed_cidrs":{"description":"Opt-in client IP allow-list; `[]` is any IP.","items":{"type":"string"},"type":"array"},"created_at":{"nullable":true,"type":"string"},"expires_at":{"nullable":true,"type":"string"},"key_env":{"$ref":"#/components/schemas/KeyEnv"},"key_id":{"type":"string"},"masked_key":{"description":"A fixed mask. Reveals the credential mode and nothing else, because nothing else was ever stored.","type":"string"},"name":{"nullable":true,"type":"string"},"revoked_at":{"nullable":true,"type":"string"},"scopes":{"items":{"type":"string"},"type":"array"},"status":{"$ref":"#/components/schemas/KeyStatusView"}},"required":["key_id","masked_key","key_env","scopes","allowed_cidrs","status"],"type":"object"},"Matched":{"description":"Deep search: which half ranked a result.","enum":["card","passage","both"],"type":"string"},"MeteringView":{"description":"Whether usage is being counted. Always `on`: every billable response is recorded a few seconds after it is served, so the usage figures below include all billable usage except the last few seconds.","oneOf":[{"properties":{"state":{"enum":["on"],"type":"string"}},"required":["state"],"type":"object"}]},"MinConfidence":{"enum":["high","medium","low"],"type":"string"},"MultiEntityIntent":{"description":"What a query naming 2 or more companies asks for.","enum":["comparison","balanced_batch","unbalanced"],"type":"string"},"MultiEntitySource":{"description":"What decided a `MultiEntityIntent`: the word lists, or nothing (`default`: they could not tell, so the query ranks as one topic, `unbalanced`).","enum":["rules","default"],"type":"string"},"NormalizedQuery":{"additionalProperties":false,"properties":{"as_of":{"nullable":true,"type":"string"},"base_query_id":{"nullable":true,"type":"string"},"cursor":{"nullable":true,"type":"string"},"limit":{"format":"int32","minimum":0,"nullable":true,"type":"integer"},"operation":{"$ref":"#/components/schemas/Operation"},"patches":{"items":{},"type":"array"},"predicates":{"items":{"$ref":"#/components/schemas/Predicate"},"type":"array"},"query_version":{"format":"int32","minimum":0,"nullable":true,"type":"integer"},"ranking":{"items":{"$ref":"#/components/schemas/Ranking"},"type":"array"},"requested_fields":{"items":{"type":"string"},"type":"array"},"subject":{"$ref":"#/components/schemas/QuerySubject"},"universe":{"$ref":"#/components/schemas/Universe"}},"required":["operation","subject"],"type":"object"},"NotEntitledView":{"enum":["no_record","store_unavailable","no_tier","unknown_tier","unit_not_entitled"],"type":"string"},"NotRecordedView":{"description":"Why a figure is absent. Carried so support can tell the cases apart; never rendered as a number by anything downstream, because there is no number here to render.","enum":["no_rows_recorded","ledger_unavailable","ledger_not_configured"],"type":"string"},"NumberRange":{"additionalProperties":false,"properties":{"lower":{"format":"double","type":"number"},"upper":{"format":"double","type":"number"}},"required":["lower","upper"],"type":"object"},"Offering":{"properties":{"amount_kind":{"description":"Which figure `amount_usd` is: `gross_proceeds`, `max_aggregate_amount`, `price_times_shares` or `price_range_midpoint_times_shares`.","nullable":true,"type":"string"},"amount_usd":{"format":"double","nullable":true,"type":"number"},"cik":{"description":"The issuer's 10-digit CIK.","type":"string"},"company_name":{"nullable":true,"type":"string"},"file_number":{"description":"The registration's SEC file number (`333-299300`).","nullable":true,"type":"string"},"filings":{"description":"Its filings within the plan's history, newest first.","items":{"$ref":"#/components/schemas/OfferingFiling"},"type":"array"},"last_filed_on":{"description":"`YYYY-MM-DD`: its newest filing's date.","type":"string"},"offering_key":{"description":"The `file_number`, else the filing's accession: what pages.","type":"string"}},"required":["offering_key","cik","last_filed_on","filings"],"type":"object"},"OfferingFiling":{"description":"One offering filing's terms as model-read from it. Absent means not stated (a preliminary cover leaves the price and size blank). Amounts are USD only: absent when the filing prices in another `currency`.","properties":{"accession":{"type":"string"},"currency":{"description":"The currency the filing prices in: `usd`, `other` or `not_stated`.","nullable":true,"type":"string"},"exchange":{"nullable":true,"type":"string"},"extracted_at":{"description":"RFC 3339 UTC.","type":"string"},"extraction_model":{"description":"The model that read the terms (`jev-1.13.0`) and the question set (`ot.v1`).","type":"string"},"filed_at":{"description":"RFC 3339 UTC: SEC acceptance.","type":"string"},"filing_date":{"description":"`YYYY-MM-DD`.","type":"string"},"form":{"description":"`S-1`, `S-1/A`, `F-1`, `F-1/A`, `424B1`, `424B4` or `424B5`.","type":"string"},"gross_proceeds":{"format":"double","nullable":true,"type":"number"},"index_url":{"description":"The filing's sec.gov index page.","type":"string"},"is_amendment":{"type":"boolean"},"is_preliminary":{"type":"boolean"},"max_aggregate_amount":{"format":"double","nullable":true,"type":"number"},"net_proceeds_to_issuer":{"format":"double","nullable":true,"type":"number"},"offering_type":{"description":"`ipo`, `spac_ipo`, `follow_on`, `registered_direct`, `at_the_market`, `resale`, `rights_offering`, `debt` or `other`.","nullable":true,"type":"string"},"overallotment_securities":{"format":"double","nullable":true,"type":"number"},"price_per_security":{"format":"double","nullable":true,"type":"number"},"price_range_high":{"format":"double","nullable":true,"type":"number"},"price_range_low":{"format":"double","nullable":true,"type":"number"},"question_version":{"type":"string"},"securities_offered":{"format":"double","nullable":true,"type":"number"},"security_type":{"nullable":true,"type":"string"},"source_doc_sha256":{"nullable":true,"type":"string"},"source_document":{"type":"string"},"source_url":{"description":"The sec.gov primary document the terms were read from: show it with them.","type":"string"},"ticker":{"description":"As printed.","nullable":true,"type":"string"},"underwriters":{"description":"Canonical names, from the cover and the syndicate table (98.3% precision).","items":{"type":"string"},"type":"array"},"underwriting_discount_total":{"format":"double","nullable":true,"type":"number"}},"required":["accession","form","filing_date","filed_at","underwriters","is_preliminary","is_amendment","source_url","index_url","source_document","extraction_model","question_version","extracted_at"],"type":"object"},"OfferingsResponse":{"description":"`GET /v1/offerings`: a company's registered offerings, the most recently filed first.","properties":{"has_more":{"type":"boolean"},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"},"results":{"description":"By `(last_filed_on, offering_key)` descending, at most `limit`, never before the plan's history window; may be empty.","items":{"$ref":"#/components/schemas/Offering"},"type":"array"}},"required":["results","has_more"],"type":"object"},"Operation":{"enum":["filter","rank","compare","monitor"],"type":"string"},"Operator":{"enum":["eq","ne","gt","gte","lt","lte","between","in","not_in"],"type":"string"},"Passage":{"description":"Deep search: the passage of a result that best matches the query: a brief's or article's body, or one of a filing's sections.","properties":{"end":{"description":"Unicode code-point offset, exclusive. Absent with `start`.","format":"int32","minimum":0,"nullable":true,"type":"integer"},"section_id":{"description":"Filing only: the section the passage is from, one of the `sections[].section_id` `GET /v1/content/{id}` serves.","nullable":true,"type":"string"},"start":{"description":"Unicode code-point offset, inclusive, into the text `GET /v1/content/{id}` serves: a brief's or article's `body`, a filing's `text` of section `section_id`, a transcript's `body`. Absent when the offsets could not be verified against `text`.","format":"int32","minimum":0,"nullable":true,"type":"integer"},"text":{"description":"CommonMark. Brief, article: Finks-written, never a publisher's words. Filing: verbatim filing text.","type":"string"}},"required":["text"],"type":"object"},"PeriodView":{"description":"The billing period a figure belongs to, and when it rolls over.","properties":{"period":{"description":"UTC calendar month, `YYYY-MM`.","type":"string"},"resets_at":{"description":"The period reset date: the first instant of the next UTC calendar month. Arithmetic on the period, never a configured cycle length.","type":"string"},"starts_at":{"description":"First instant of the period, RFC 3339 UTC.","type":"string"}},"required":["period","starts_at","resets_at"],"type":"object"},"PointInTime":{"description":"The cutoff a point-in-time search (`as_of`) applied.","properties":{"as_of":{"description":"`YYYY-MM-DD`, as sent: facts filed on or before it.","type":"string"},"published_before":{"description":"RFC 3339 UTC, exclusive: the start of the New York day after `as_of`. Every result was published before it (a transcript's call is dated on or before `as_of`).","type":"string"}},"required":["as_of","published_before"],"type":"object"},"Predicate":{"additionalProperties":false,"properties":{"field":{"type":"string"},"operator":{"$ref":"#/components/schemas/Operator"},"value":{"$ref":"#/components/schemas/PredicateValue"}},"required":["field","operator","value"],"type":"object"},"PredicateValue":{"description":"A predicate's bound value.","oneOf":[{"format":"double","type":"number"},{"type":"string"},{"type":"boolean"},{"items":{"format":"double","type":"number"},"type":"array"},{"items":{"type":"string"},"type":"array"},{"$ref":"#/components/schemas/NumberRange"}]},"PrivateCompaniesResponse":{"description":"`GET /v1/private-companies?name=`: the profiles whose name or legal name is the name sent (case-insensitive), by `cluster_id`.","properties":{"has_more":{"type":"boolean"},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"},"results":{"description":"By `cluster_id` ascending, at most `limit`; may be empty.","items":{"$ref":"#/components/schemas/PrivateCompanyProfile"},"type":"array"}},"required":["results","has_more"],"type":"object"},"PrivateCompanyProfile":{"properties":{"ciks":{"description":"SEC CIKs, 10 digits.","items":{"type":"string"},"type":"array"},"cluster_id":{"description":"The canonical key: `lei:<LEI>`, else `cik:<10 digits>`, else the tracked slug. Built from exact links only (Form D CIK, GLEIF's EDGAR registration, SEC's LEI, N-PORT's holding LEI); a name never links two keys.","type":"string"},"company_name":{"description":"The tracked name, else the legal name.","type":"string"},"entity_id":{"description":"The Entity Graph id (`ent_…`), when its rounds carry one.","nullable":true,"type":"string"},"federal_awards":{"allOf":[{"$ref":"#/components/schemas/ProfileFederalAwards"}],"nullable":true},"form_d":{"allOf":[{"$ref":"#/components/schemas/ProfileFormD"}],"nullable":true},"fund_marks":{"allOf":[{"$ref":"#/components/schemas/ProfileFundMarks"}],"nullable":true},"gleif":{"allOf":[{"$ref":"#/components/schemas/ProfileGleif"}],"nullable":true},"latest_round":{"allOf":[{"$ref":"#/components/schemas/ProfileRound"}],"nullable":true},"latest_valuation_claim":{"allOf":[{"$ref":"#/components/schemas/ProfileValuationClaim"}],"nullable":true},"legal_name":{"type":"string"},"lei":{"nullable":true,"type":"string"},"name_source":{"description":"Where `legal_name` comes from: `gleif`, `form_d` or `seed`.","type":"string"},"omitted":{"items":{"type":"string"},"type":"array"},"signals":{"items":{"type":"string"},"type":"array"},"slug":{"description":"The tracked company's key in `/v1/funding` and `/v1/federal-awards` (`anthropic`); absent for the long tail.","nullable":true,"type":"string"}},"required":["cluster_id","company_name","legal_name","name_source"],"type":"object"},"ProfileFederalAwards":{"properties":{"award_count":{"description":"USAspending prime awards.","format":"int32","type":"integer"},"last_action_on":{"description":"`YYYY-MM-DD`, the newest action, prime or Other Transaction (the section's as-of).","type":"string"},"obligated_usd":{"description":"Obligations (money committed), not outlays; can be negative.","format":"double","nullable":true,"type":"number"},"ot_award_count":{"format":"int32","type":"integer"},"ot_last_action_on":{"nullable":true,"type":"string"},"ot_obligated_usd":{"format":"double","nullable":true,"type":"number"}},"required":["award_count","last_action_on","ot_award_count"],"type":"object"},"ProfileFormD":{"properties":{"amount_sold_usd":{"description":"The sum of each offering's total sold to date, USD as filed.","format":"double","nullable":true,"type":"number"},"filings":{"format":"int32","type":"integer"},"first_filed_on":{"description":"`YYYY-MM-DD`.","nullable":true,"type":"string"},"last_filed_on":{"description":"`YYYY-MM-DD`: the section's as-of.","nullable":true,"type":"string"},"offerings":{"format":"int32","type":"integer"},"source_url":{"description":"The newest filing's sec.gov index page.","type":"string"}},"required":["offerings","filings","source_url"],"type":"object"},"ProfileFundMarks":{"properties":{"as_of":{"description":"`YYYY-MM-DD`, the newest report (quarterly, ~60-day public lag).","type":"string"},"fund_count":{"description":"The funds whose newest holding report marks the company.","format":"int32","type":"integer"},"holding_value_usd":{"description":"The sum of those funds' fair values of their positions, USD. **Not a company valuation.**","format":"double","nullable":true,"type":"number"},"source_url":{"description":"An N-PORT filing on sec.gov.","type":"string"}},"required":["fund_count","as_of","source_url"],"type":"object"},"ProfileGleif":{"properties":{"as_of":{"description":"`YYYY-MM-DD`, GLEIF's snapshot.","type":"string"},"entity_status":{"nullable":true,"type":"string"},"jurisdiction":{"nullable":true,"type":"string"},"legal_country":{"nullable":true,"type":"string"},"registration_status":{"nullable":true,"type":"string"}},"required":["as_of"],"type":"object"},"ProfileRound":{"properties":{"amount":{"description":"As filed or reported, in `currency`; with `status`, never alone.","format":"double","nullable":true,"type":"number"},"currency":{"nullable":true,"type":"string"},"label":{"description":"As reported (`Series H`).","nullable":true,"type":"string"},"on":{"description":"`YYYY-MM-DD`: announced, else the offering's first filing.","type":"string"},"round_count":{"description":"Every round of the company, in or out of the window.","format":"int32","type":"integer"},"round_id":{"description":"`formd:<SEC file number>` or `news:<sha>`.","type":"string"},"source_type":{"description":"`form_d`, `brief` or `newsroom`.","type":"string"},"source_url":{"description":"The sec.gov index page, or the report.","type":"string"},"status":{"description":"`filed`, `announced`, `reported`, `in_talks` or `seeking`: `in_talks` and `seeking` were **not raised**.","type":"string"}},"required":["round_count","round_id","on","status","source_type","source_url"],"type":"object"},"ProfileValuationClaim":{"properties":{"amount":{"description":"As stated, in `currency`.","format":"double","type":"number"},"amount_usd":{"description":"`amount` when `currency` is `USD`; never converted.","format":"double","nullable":true,"type":"number"},"basis":{"description":"`post_money`, `pre_money`, `ipo_target`, `deal_value` or `not_stated`.","type":"string"},"claim_count":{"description":"The company's claims, prior and projection ones left out.","format":"int32","type":"integer"},"claim_id":{"type":"string"},"currency":{"type":"string"},"on":{"description":"`YYYY-MM-DD`, reported.","type":"string"},"source_kind":{"description":"`news_brief` or `sec_8k`.","type":"string"},"source_url":{"type":"string"},"status":{"description":"`completed`, `reported` or `in_talks` (not a valuation reached).","type":"string"}},"required":["claim_count","claim_id","amount","currency","basis","status","on","source_kind","source_url"],"type":"object"},"ProxiesResponse":{"description":"`GET /v1/proxies`: a company's proxy statements, newest filing first.","properties":{"has_more":{"type":"boolean"},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"},"results":{"description":"By `(filing_date, accession)` descending, at most `limit`, never before the plan's history window; may be empty.","items":{"$ref":"#/components/schemas/ProxyStatement"},"type":"array"}},"required":["results","has_more"],"type":"object"},"ProxyStatement":{"properties":{"accession":{"type":"string"},"auditor":{"nullable":true,"type":"string"},"cik":{"type":"string"},"company_name":{"nullable":true,"type":"string"},"equity_plan_on_ballot":{"nullable":true,"type":"boolean"},"extracted_at":{"description":"RFC 3339 UTC.","type":"string"},"extraction_model":{"type":"string"},"file_number":{"nullable":true,"type":"string"},"filed_at":{"description":"RFC 3339 UTC.","type":"string"},"filing_date":{"description":"`YYYY-MM-DD`: what pages.","type":"string"},"form":{"type":"string"},"frequency_recommended":{"description":"Years the board recommends between say-on-pay votes.","format":"int32","nullable":true,"type":"integer"},"index_url":{"description":"The filing's sec.gov index page.","type":"string"},"meeting_date":{"description":"`YYYY-MM-DD`; absent when not stated.","nullable":true,"type":"string"},"meeting_kind":{"description":"`annual`, `special` or `annual_and_special`.","nullable":true,"type":"string"},"proposal_count":{"format":"int32","type":"integer"},"proposal_types":{"description":"In ballot order (`director_election`, `say_on_pay`, `auditor_ratification`, …).","items":{"type":"string"},"type":"array"},"question_version":{"type":"string"},"say_on_frequency_on_ballot":{"nullable":true,"type":"boolean"},"say_on_pay_on_ballot":{"nullable":true,"type":"boolean"},"shareholder_proposal_count":{"format":"int32","nullable":true,"type":"integer"},"source_doc_sha256":{"nullable":true,"type":"string"},"source_document":{"type":"string"},"source_url":{"description":"The sec.gov primary document the terms were read from: show it with them.","type":"string"}},"required":["accession","cik","form","filing_date","filed_at","proposal_types","proposal_count","source_url","index_url","source_document","extraction_model","question_version","extracted_at"],"type":"object"},"QuerySubject":{"additionalProperties":false,"properties":{"adapter_version":{"nullable":true,"type":"string"},"subject_type":{"$ref":"#/components/schemas/SubjectType"},"subtype":{"items":{"type":"string"},"type":"array"}},"required":["subject_type"],"type":"object"},"Ranking":{"additionalProperties":false,"properties":{"direction":{"$ref":"#/components/schemas/SortDirection"},"field":{"type":"string"},"threshold":{"format":"double","nullable":true,"type":"number"},"weight":{"format":"double","nullable":true,"type":"number"}},"required":["field","direction"],"type":"object"},"RateCurvePoint":{"description":"One tenor of a curve.","properties":{"attribution":{"description":"The citation to show with the value.","type":"string"},"label":{"description":"The series' short label (`10-year Treasury yield`).","nullable":true,"type":"string"},"series":{"description":"The `/v1/rates` series (`ust_par_10y`).","type":"string"},"source":{"type":"string"},"tenor":{"description":"`1m`, `6w`, ..., `30y`.","type":"string"},"unit":{"type":"string"},"value":{"description":"The yield as a **fraction** (0.0433 is 4.33%).","format":"double","type":"number"}},"required":["series","tenor","value","unit","source","attribution"],"type":"object"},"RateCurveResponse":{"description":"`GET /v1/rates/curve`: one Treasury curve on one day, shortest tenor first.","properties":{"curve":{"description":"`ust_par` or `ust_real`.","type":"string"},"date":{"nullable":true,"type":"string"},"label":{"description":"The curve's short label (`Treasury par yield`, `TIPS real yield`).","nullable":true,"type":"string"},"points":{"items":{"$ref":"#/components/schemas/RateCurvePoint"},"type":"array"}},"required":["curve","points"],"type":"object"},"RateObservation":{"description":"One day's rate.","properties":{"attribution":{"description":"The citation to show with the value.","type":"string"},"date":{"description":"`YYYY-MM-DD`, the day the rate is for (a Bank of Canada weekly rate: the Wednesday; an annual average: January 1 of its year).","type":"string"},"source":{"description":"The publisher: `us_treasury`, `ny_fed`, `fed_board` or `bank_of_canada`.","type":"string"},"unit":{"type":"string"},"value":{"description":"A rate is an annualized **fraction** (`unit` `fraction`: 0.0433 is 4.33%); `sofr_index` is an index level (`unit` `index`); a Bank of Canada exchange rate is as published (`unit` `cad_per_unit`: 1.4025 Canadian dollars per US dollar).","format":"double","type":"number"}},"required":["date","value","unit","source","attribution"],"type":"object"},"RateObservationsResponse":{"description":"`GET /v1/rates/series/{series}/observations`: one series, newest day first.","properties":{"has_more":{"type":"boolean"},"label":{"description":"The series' short label, as `GET /v1/rates/series` gives it (a US series; absent for a Bank of Canada one).","nullable":true,"type":"string"},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"},"results":{"description":"By `date` descending, at most `limit`, may be empty.","items":{"$ref":"#/components/schemas/RateObservation"},"type":"array"},"series":{"type":"string"}},"required":["series","results","has_more"],"type":"object"},"RateSeries":{"properties":{"attribution":{"description":"The citation to show with any of its values.","type":"string"},"first_date":{"description":"`YYYY-MM-DD`, the first day served.","type":"string"},"frequency":{"description":"Bank of Canada only: `daily` (the Bank's daily average, business days), `weekly` (posted bank rates, dated the Wednesday) or `annual` (the year's average, dated January 1). A daily and an annual series are never interchangeable.","nullable":true,"type":"string"},"label":{"description":"A short human label (`ust_par_10y`: `10-year Treasury yield`, at most 40 characters). A Bank of Canada series' says what it is (`USD/CAD daily average exchange rate (Canadian dollars per US dollar)`; a weekly series says it is the typical rate the six major chartered banks post, not the Bank's policy rate), and may be longer. Always present.","nullable":true,"type":"string"},"last_date":{"description":"`YYYY-MM-DD`, the latest day published.","type":"string"},"pair":{"description":"Bank of Canada exchange rates only: the pair (`USDCAD`: Canadian dollars per 1 US dollar).","nullable":true,"type":"string"},"series":{"description":"`ust_par_10y`, `sofr`, `fed_funds_target_upper`, ...; a Bank of Canada series is the Bank's Valet id (`FXUSDCAD`, `FXAUSDCAD`, `V80691311`).","type":"string"},"source":{"description":"The publisher: `us_treasury`, `ny_fed`, `fed_board` or `bank_of_canada`.","type":"string"},"unit":{"description":"`fraction` (every rate: 0.0433 is 4.33%), `index` (`sofr_index`) or `cad_per_unit` (a Bank of Canada exchange rate as published: Canadian dollars per one unit of the pair's first currency).","type":"string"}},"required":["series","unit","source","attribution","first_date","last_date"],"type":"object"},"RateSeriesResponse":{"description":"`GET /v1/rates/series`: every rate series served, by `series`: the US rates and the Bank of Canada's.","properties":{"results":{"items":{"$ref":"#/components/schemas/RateSeries"},"type":"array"}},"required":["results"],"type":"object"},"RegulatorCard":{"properties":{"agency":{"type":"string"},"attribution":{"type":"string"},"doc_type":{"description":"The document type: `press_release`, `litigation_release`, `administrative_proceeding`, `enforcement_action`, `corporate_decision`, `conditional_approval`, `interpretive_letter`, `crs_report`. Open vocabulary.","type":"string"}},"required":["agency","doc_type","attribution"],"type":"object"},"RelatedRef":{"description":"One `related` ref: enough to show and cite it; `GET /v1/content/{id}` serves the rest.","properties":{"id":{"type":"string"},"published_at":{"type":"string"},"title":{"type":"string"},"type":{"$ref":"#/components/schemas/SearchType"},"url":{"type":"string"}},"required":["id","type","title","url","published_at"],"type":"object"},"ReportedFact":{"properties":{"accession":{"type":"string"},"concept":{"description":"The XBRL concept as filed (`NetCashProvidedByUsedInOperatingActivities`).","type":"string"},"filed_date":{"description":"`YYYY-MM-DD`.","type":"string"},"fiscal_period":{"nullable":true,"type":"string"},"fiscal_year":{"description":"The filing's fiscal year and period (`FY`, `Q1`-`Q3`), as the filer states them: a comparative period carries the filing's, not its own.","format":"int32","nullable":true,"type":"integer"},"form":{"description":"The filing's form (`10-Q`, `10-K`, `20-F`).","nullable":true,"type":"string"},"period_end":{"description":"`YYYY-MM-DD`: the duration's last day, or the instant.","type":"string"},"period_start":{"description":"`YYYY-MM-DD`; absent for an instant.","nullable":true,"type":"string"},"source_url":{"description":"The filing's index on sec.gov.","type":"string"},"taxonomy":{"description":"`us-gaap` or `ifrs-full`.","type":"string"},"unit":{"description":"As filed: `USD`, `USD/shares`, `shares`, or another currency for a foreign filer.","type":"string"},"value":{"description":"As filed, in `unit`: whole units (never thousands or millions); negative is an outflow or a loss.","format":"double","type":"number"}},"required":["concept","taxonomy","unit","value","period_end","accession","filed_date","source_url"],"type":"object"},"RequestId":{"description":"One request ID, generated once per request and echoed verbatim on every typed error. Never derived from or containing key material.","type":"string"},"ResearchAccepted":{"description":"`POST /v1/research`'s `202 Accepted`.","properties":{"poll_after_ms":{"description":"A suggested wait before the first poll, in milliseconds.","format":"int32","minimum":0,"type":"integer"},"research_id":{"description":"The job's id: `GET /v1/research/{research_id}` (also the `Location` header).","type":"string"},"search":{"$ref":"#/components/schemas/SearchResponse"},"status":{"$ref":"#/components/schemas/ResearchStatus"},"usage":{"$ref":"#/components/schemas/ResearchBilling"}},"required":["research_id","status","poll_after_ms","search","usage"],"type":"object"},"ResearchAnswer":{"description":"The verified answer. Every claim cites served text verbatim and carries the date of what it cites; anything that could not be verified was removed before it was stored.","properties":{"as_of":{"description":"The latest `as_of` among `claims`; absent when not found.","nullable":true,"type":"string"},"charts":{"description":"0-2 charts the writer asked for over structured rows this job fetched, each built by code from those rows (every value is a served row's), in `POST /v1/workflows/chart`'s shape. Empty when not found.","items":{"$ref":"#/components/schemas/ResearchChart"},"type":"array"},"claims":{"items":{"$ref":"#/components/schemas/ResearchClaim"},"type":"array"},"found":{"description":"`false`: nothing gathered supports an answer (then `claims` is empty and `text` says so).","type":"boolean"},"grounding":{"description":"With `output_schema` only: one entry per non-null leaf of `structured`.","items":{"$ref":"#/components/schemas/ResearchGrounding"},"type":"array"},"structured":{"description":"With `output_schema` only: the answer as that schema's JSON. Every non-null leaf is grounded by a verified quote (`grounding`); a value no verified quote supports is `null`, never a guess. Properties come in the schema's own order.","nullable":true,"type":"object"},"structured_errors":{"description":"With `output_schema` only: where `structured` does not meet the schema (a required or non-nullable leaf left `null` because nothing verified supports it). The job still succeeds.","items":{"$ref":"#/components/schemas/ResearchStructuredError"},"type":"array"},"text":{"description":"The answer in prose. When found, it is the verified draft, or the verified claims joined when the draft held anything unsupported.","type":"string"}},"required":["found","text","claims"],"type":"object"},"ResearchBilling":{"properties":{"beta":{"description":"`true` under the `beta` billing mode (served, not billed), and for every light job (`effort: \"light\"`, Agent Search: free during its beta, its `search_research` row at 0 credits). Billing itself is unchanged: `billed` says whether a row is written.","type":"boolean"},"billed":{"type":"boolean"},"unit":{"description":"Always `search_research`.","type":"string"}},"required":["unit","billed","beta"],"type":"object"},"ResearchChart":{"description":"One chart of an answer: `POST /v1/workflows/chart`'s `chart`, `sources` and `notes`.","properties":{"chart":{"$ref":"#/components/schemas/Chart"},"notes":{"description":"What was trimmed; absent when nothing was.","nullable":true,"type":"string"},"sources":{"description":"The route (path and query) the rows came from, or the rows' own links.","items":{"$ref":"#/components/schemas/ChartSource"},"type":"array"}},"required":["chart","sources"],"type":"object"},"ResearchCitation":{"description":"A verbatim quote of served text.","properties":{"as_of":{"description":"The cited source's date: a document's `published_at`, a series row's observation date.","nullable":true,"type":"string"},"attribution":{"nullable":true,"type":"string"},"display":{"description":"For a quote of a data route's row (`rows`, or a page's `data` block): the first figure in it with a known unit, formatted for display (`0.0494` fraction → `4.94%`). Absent when no quoted figure has one. Built in code from the served value.","nullable":true,"type":"string"},"end":{"minimum":0,"type":"integer"},"field":{"description":"Which served text: a search result's `title`, `summary` or `passage[<section_id>]`, deep search's `answer[<section_id>]`, a document's `sections[<section_id>].text`, `body` or `text` (`GET /v1/content/{id}`), a page's `data` block, or `rows` (a data response rendered `key: value; …`, one row per line, keys in name order, without record keys, filing plumbing, links and nested evidence, a string over 200 characters cut with `…`, then one `attribution: …` line per distinct publisher attribution; the first is also in `title`).","type":"string"},"quote":{"description":"Exact substring of the text `field` names.","type":"string"},"result_id":{"description":"The result or record the quote is from: a search result id (readable at `GET /v1/content/{id}`), or the data route's own key for a structured row.","type":"string"},"route":{"description":"The route that served the quoted text, e.g. `/v1/search`, `/v1/content/{id}`, `/v1/macro/series/{series_id}/observations`.","type":"string"},"start":{"description":"Character offsets of `quote` in that text: `quote` is exactly its characters `start..end`.","minimum":0,"type":"integer"},"terms_url":{"description":"The publisher's terms link when its rows carry one (openFDA: `https://open.fda.gov/terms/`).","nullable":true,"type":"string"},"title":{"type":"string"},"unit":{"description":"That figure's unit, in `POST /v1/workflows/chart`'s vocabulary (`fraction`, `percent`, `usd`, `usd_per_share`, `thousands`, …, as its source states it).","nullable":true,"type":"string"}},"required":["result_id","route","field","title","quote","start","end"],"type":"object"},"ResearchClaim":{"description":"One factual statement of the answer.","properties":{"as_of":{"description":"The latest `as_of` among its citations; absent only when no cited source is dated.","nullable":true,"type":"string"},"citations":{"description":"At least one.","items":{"$ref":"#/components/schemas/ResearchCitation"},"type":"array"},"derivation":{"description":"For a computed figure: the arithmetic over cited figures, recomputed by the service.","nullable":true,"type":"string"},"text":{"type":"string"}},"required":["text","citations"],"type":"object"},"ResearchDailyJobs":{"description":"`GET /v1/account`'s `research_daily_jobs`: today's research jobs against the account's daily cap.","properties":{"cap":{"description":"Jobs per UTC day the account's tier allows.","format":"int32","minimum":0,"type":"integer"},"resets_at":{"description":"When `used` resets: the next 00:00 UTC, RFC 3339.","type":"string"},"used":{"description":"Jobs started today (UTC), the counter `POST /v1/research` checks: every accepted `POST` that has not failed (a running or succeeded job); a `POST` whose page was not served, and a job that ends `failed`, are not counted.","format":"int32","minimum":0,"type":"integer"}},"required":["cap","used","resets_at"],"type":"object"},"ResearchEffort":{"description":"How much work a job may do.","enum":["light","full"],"type":"string"},"ResearchError":{"description":"Why a job failed.","properties":{"code":{"description":"`research.interrupted` (the worker stopped before finishing) or `research.model_unavailable` (the model did not answer).","type":"string"},"message":{"type":"string"}},"required":["code","message"],"type":"object"},"ResearchGrounding":{"allOf":[{"$ref":"#/components/schemas/ResearchCitation"},{"properties":{"claim_index":{"description":"The index in `answer.claims` of a claim citing the same text, when one does.","format":"int32","minimum":0,"nullable":true,"type":"integer"},"eid":{"description":"The evidence item the writer named (`E3`).","type":"string"},"path":{"description":"The leaf, e.g. `companies[0].amount_usd`.","type":"string"}},"required":["path","eid"],"type":"object"}],"description":"What grounds one leaf of `answer.structured`: its path and the verified quote, cited as a claim's citation is."},"ResearchJob":{"description":"`GET /v1/research/{research_id}`.","properties":{"answer":{"allOf":[{"$ref":"#/components/schemas/ResearchAnswer"}],"nullable":true},"created_at":{"description":"RFC 3339 UTC.","type":"string"},"error":{"allOf":[{"$ref":"#/components/schemas/ResearchError"}],"nullable":true},"finished_at":{"description":"RFC 3339 UTC; absent while `running`.","nullable":true,"type":"string"},"phase":{"allOf":[{"$ref":"#/components/schemas/ResearchPhase"}],"nullable":true},"query":{"description":"The question as asked.","type":"string"},"research_id":{"type":"string"},"status":{"$ref":"#/components/schemas/ResearchStatus"},"trace":{"description":"Every route call the job made, in the order each finished: the `POST`'s page first (`step` 0; deep for full, standard for light), then one entry per tool call as it finishes (at most 12 in all, 6 for light). Grows while `running`; always present (empty only for a job stored before it existed).","items":{"$ref":"#/components/schemas/ResearchTraceStep"},"type":"array"},"usage":{"allOf":[{"$ref":"#/components/schemas/ResearchUsage"}],"nullable":true}},"required":["research_id","status","query","created_at"],"type":"object"},"ResearchPhase":{"description":"A running job's phase. In loop order: `planning`, then `fetching` or `reading` for each planner turn's calls, then `writing` and `verifying`.","enum":["planning","fetching","reading","verifying","writing"],"type":"string"},"ResearchRequest":{"allOf":[{"$ref":"#/components/schemas/SearchRequest"},{"properties":{"effort":{"$ref":"#/components/schemas/ResearchEffort"},"output_schema":{"nullable":true,"type":"object"}},"type":"object"}],"description":"`POST /v1/research`'s body: a `/v1/search` body plus `effort`."},"ResearchStatus":{"description":"A job's state.","enum":["running","succeeded","failed"],"type":"string"},"ResearchStructuredError":{"description":"A place `answer.structured` does not meet the schema.","properties":{"path":{"type":"string"},"reason":{"type":"string"}},"required":["path","reason"],"type":"object"},"ResearchTraceError":{"description":"Why a trace step failed.","properties":{"code":{"type":"string"}},"required":["code"],"type":"object"},"ResearchTraceStep":{"description":"One route call a job made.","properties":{"error":{"allOf":[{"$ref":"#/components/schemas/ResearchTraceError"}],"nullable":true},"label":{"description":"A short human line for the step, built from the call by a fixed template per tool (never model text), e.g. `Searched briefs for Fed rate decision`.","type":"string"},"ms":{"description":"How long the call took, in milliseconds.","format":"int64","minimum":0,"type":"integer"},"result_ids":{"description":"On a search step: the ids of the results it returned, in rank order.","items":{"type":"string"},"nullable":true,"type":"array"},"results":{"description":"Results or rows the response carried (a document read is 1); 0 on a non-2xx.","format":"int32","minimum":0,"type":"integer"},"route":{"description":"The exact path and query called, e.g. `/v1/macro/series/PAYEMS/observations?limit=12`. A `GET` route can be called again as is with the caller's key; `/v1/search` and `/v1/screener` are `POST`s.","type":"string"},"status":{"description":"The HTTP status the route answered.","format":"int32","minimum":0,"type":"integer"},"step":{"description":"The planner turn that asked for it (1..=8); 0 is the `POST`'s page.","format":"int32","minimum":0,"type":"integer"},"tool":{"description":"The planner's tool: `search`, `read_document`, `macro_series`, `rates_series`, `company`, `fund`, `fund_owners`, `earnings`, `screener`, `filings`, `commodity`, `energy_forecast`, `fda`, `clinical_trials`, `federal_register`, `funding`, `valuations`, `offerings`, `federal_awards` or `form_d`.","type":"string"}},"required":["step","tool","label","route","status","results","ms"],"type":"object"},"ResearchUsage":{"allOf":[{"$ref":"#/components/schemas/ResearchBilling"},{"properties":{"duration_ms":{"format":"int64","minimum":0,"type":"integer"},"fallback":{"type":"boolean"},"input_tokens":{"format":"int64","minimum":0,"type":"integer"},"model":{"type":"string"},"output_tokens":{"format":"int64","minimum":0,"type":"integer"},"steps":{"description":"Planner turns (at most 8).","format":"int32","minimum":0,"type":"integer"},"tool_calls":{"description":"Tool calls, the page included (at most 12; 6 for light).","format":"int32","minimum":0,"type":"integer"}},"required":["steps","tool_calls","model","input_tokens","output_tokens","duration_ms"],"type":"object"}],"description":"What one job did."},"ResultFieldsView":{"properties":{"configured":{"type":"boolean"},"fields":{"items":{"type":"string"},"nullable":true,"type":"array"},"truncated":{"type":"boolean"}},"required":["configured","truncated"],"type":"object"},"RightsClass":{"enum":["licensed_news","public_disclosure"],"type":"string"},"RowStatus":{"enum":["matched","unmatched","unknown","unsupported"],"type":"string"},"ScreenerCoverage":{"properties":{"candidates":{"format":"int64","minimum":0,"type":"integer"},"evaluated":{"format":"int64","minimum":0,"type":"integer"},"matched":{"format":"int64","minimum":0,"type":"integer"},"source_coverage":{"additionalProperties":{"$ref":"#/components/schemas/SourceCoverage"},"type":"object"},"unknown":{"format":"int64","minimum":0,"type":"integer"},"unsupported":{"format":"int64","minimum":0,"type":"integer"}},"required":["candidates","evaluated","matched","unknown","unsupported"],"type":"object"},"ScreenerFieldCatalogEntry":{"properties":{"adapter_version":{"nullable":true,"type":"string"},"basis":{"description":"The basis this field is served under, e.g. `daily`, `ttm`, `fy`.","nullable":true,"type":"string"},"coverage":{"$ref":"#/components/schemas/ScreenerFieldCoverageStatus"},"data_type":{"$ref":"#/components/schemas/ScreenerFieldDataType"},"enum_values":{"items":{"type":"string"},"nullable":true,"type":"array"},"freshness":{"nullable":true,"type":"string"},"label":{"description":"A short human label, at most 40 characters (`revenue_growth_1year`: `1-year revenue growth`), for a chart or table header.","type":"string"},"name":{"type":"string"},"operators":{"items":{"$ref":"#/components/schemas/Operator"},"type":"array"},"rights":{"nullable":true,"type":"string"},"supported_subjects":{"items":{"$ref":"#/components/schemas/SubjectType"},"type":"array"},"unit":{"nullable":true,"type":"string"}},"required":["name","data_type","operators","supported_subjects","coverage"],"type":"object"},"ScreenerFieldCatalogResponse":{"properties":{"as_of":{"nullable":true,"type":"string"},"fields":{"items":{"$ref":"#/components/schemas/ScreenerFieldCatalogEntry"},"type":"array"}},"required":["fields"],"type":"object"},"ScreenerFieldCoverageStatus":{"discriminator":{"propertyName":"status"},"oneOf":[{"properties":{"status":{"enum":["available"],"type":"string"}},"required":["status"],"type":"object"},{"properties":{"detail":{"description":"Known field; the upstream snapshot it depends on has not landed yet.","type":"string"},"status":{"enum":["pending_upstream"],"type":"string"}},"required":["status","detail"],"type":"object"},{"properties":{"detail":{"description":"Known field; compatible with `rank` only, and execution is not yet implemented.","type":"string"},"status":{"enum":["rank_only"],"type":"string"}},"required":["status","detail"],"type":"object"}]},"ScreenerFieldDataType":{"enum":["number","text","bool","date"],"type":"string"},"ScreenerFieldValue":{"properties":{"as_of":{"nullable":true,"type":"string"},"attribution":{"description":"The ECB's attribution for the euro reference rate applied: present exactly when a rate was applied, and it must be shown wherever the value is.","nullable":true,"type":"string"},"basis":{"type":"string"},"currency":{"description":"`USD` on a money field converted from the filer's reporting currency (catalog `rights` names which fields). Absent on every other field.","nullable":true,"type":"string"},"null_reason":{"description":"Why a converted value is null: no reporting currency, no ECB rate for it, or the period's own source value is not reported. The raw local amount is never served in its place.","nullable":true,"type":"string"},"reported_currency":{"description":"The filer's reporting currency the converted value came from.","nullable":true,"type":"string"},"source":{"nullable":true,"type":"string"},"value":{}},"required":["value","basis"],"type":"object"},"ScreenerRequest":{"additionalProperties":false,"properties":{"natural_language":{"nullable":true,"type":"string","description":"The screen in words (beta). `interpretation` says how it was read."},"query":{"allOf":[{"$ref":"#/components/schemas/NormalizedQuery"}],"nullable":true,"description":"The screen. Send this or `natural_language`."}},"type":"object"},"ScreenerResponse":{"properties":{"coverage":{"$ref":"#/components/schemas/ScreenerCoverage"},"data":{"items":{"$ref":"#/components/schemas/ScreenerRow"},"type":"array"},"interpretation":{"allOf":[{"$ref":"#/components/schemas/Interpretation"}],"nullable":true},"next_cursor":{"nullable":true,"type":"string"},"normalized_query":{"$ref":"#/components/schemas/NormalizedQuery"},"query_id":{"description":"Identity of this immutable run.","type":"string"},"query_version":{"format":"int32","minimum":0,"type":"integer"},"total_count":{"format":"int64","minimum":0,"nullable":true,"type":"integer"},"usage":{"$ref":"#/components/schemas/ScreenerUsage"}},"required":["query_id","query_version","normalized_query","data","coverage","usage"],"type":"object"},"ScreenerRow":{"properties":{"evidence":{"items":{"$ref":"#/components/schemas/EvidenceRef"},"type":"array"},"fields":{"additionalProperties":{"$ref":"#/components/schemas/ScreenerFieldValue"},"type":"object"},"reason":{"nullable":true,"type":"string"},"scores":{"additionalProperties":{"$ref":"#/components/schemas/ScreenerScore"},"type":"object"},"status":{"$ref":"#/components/schemas/RowStatus"},"subject_ref":{"allOf":[{"$ref":"#/components/schemas/SubjectRef"}],"nullable":true},"unsupported_reason":{"allOf":[{"$ref":"#/components/schemas/UnsupportedReason"}],"nullable":true}},"required":["status"],"type":"object"},"ScreenerScore":{"properties":{"method":{"type":"string"},"threshold":{"format":"double","nullable":true,"type":"number"},"value":{"format":"double","type":"number"},"version":{"nullable":true,"type":"string"}},"required":["value","method"],"type":"object"},"ScreenerUsage":{"properties":{"billed":{"type":"boolean"},"unit":{"type":"string"}},"required":["unit","billed"],"type":"object"},"Seal":{"description":"One account's seal of one UTC day, as stored and as read.","properties":{"day":{"description":"The sealed UTC day, `YYYY-MM-DD`.","type":"string"},"late_count":{"description":"Rows recorded after their own day closed, sealed here instead.","format":"int64","minimum":0,"type":"integer"},"merkle_root":{"description":"Lowercase hex.","type":"string"},"prev_root":{"description":"The account's previous seal's `merkle_root`, or 64 zeros for its first.","type":"string"},"row_count":{"format":"int64","minimum":0,"type":"integer"},"sealed_at":{"description":"RFC 3339 UTC instant the seal was written.","type":"string"}},"required":["day","row_count","merkle_root","prev_root","sealed_at","late_count"],"type":"object"},"SearchAnswer":{"description":"Deep search's `answer`: a quote of a result's own text, with offsets into the text `GET /v1/content/{result_id}` serves (a brief's or article's `body`, a filing's `text` of section `section_id`, a transcript's `body`).","properties":{"end":{"description":"Unicode code-point offset, exclusive.","format":"int32","minimum":0,"type":"integer"},"model":{"type":"string"},"result_id":{"description":"The `id` of the result it quotes, one of page 1's ranked results (not always on the first page of `limit` results).","type":"string"},"section_id":{"description":"Filing only: the section quoted, one of the record's `sections[].section_id`.","nullable":true,"type":"string"},"start":{"description":"Unicode code-point offset, inclusive.","format":"int32","minimum":0,"type":"integer"},"text":{"description":"Exactly the served text between `start` and `end`. Brief, article: Finks-written; filing, transcript: the source's words.","type":"string"}},"required":["text","result_id","start","end","model"],"type":"object"},"SearchDataset":{"description":"What one search did with one name of its vocabulary (`exclude`, `types`).","properties":{"name":{"description":"`brief`, `article`, `filing`, `transcript`, then the `Dataset` names; more names may be added.","type":"string"},"state":{"$ref":"#/components/schemas/DatasetState"}},"required":["name","state"],"type":"object"},"SearchDepth":{"description":"How much of each item a search reads (deep search). `deep` also ranks every result by its best-matching passage (a brief's or article's body, a filing's sections, a transcript's text) and serves that passage; it is a plan right (`deep_search`).","enum":["standard","deep"],"type":"string"},"SearchEntity":{"description":"A company or fund the query names (its words, a ticker, a corrected typo, or the request's `symbols`), or a macro series it asks for.","properties":{"company_key":{"description":"A private company's `company_key` (`anduril`), the `company` of `GET /v1/funding` and `GET /v1/federal-awards`; present on `private_company` only.","nullable":true,"type":"string"},"corrected":{"description":"The name a typo in `matched` was read as (`nvdia` -> `nvidia`).","nullable":true,"type":"string"},"kind":{"$ref":"#/components/schemas/EntityKind"},"matched":{"description":"The text it came from: the query's words as typed, or the `symbols` value.","type":"string"},"name":{"description":"The listing's, fund's or series' name, when known.","nullable":true,"type":"string"},"series_id":{"description":"A macro series' `/v1/macro/series` id (`cpi_u_sa`); absent otherwise.","nullable":true,"type":"string"},"symbol":{"description":"The ticker the data block reads a company or fund by; absent on a macro series and a private company.","nullable":true,"type":"string"}},"required":["kind","matched"],"type":"object"},"SearchFieldsResponse":{"properties":{"key_result_fields":{"$ref":"#/components/schemas/ResultFieldsView"},"request_fields":{"items":{"$ref":"#/components/schemas/FieldDefinition"},"type":"array"},"result_fields":{"items":{"$ref":"#/components/schemas/FieldDefinition"},"type":"array"},"text_format":{"type":"string"},"types":{"description":"One entry per type whose pool is live right now, with its corpus depth.","items":{"$ref":"#/components/schemas/TypeCatalog"},"type":"array"}},"required":["request_fields","result_fields","types","text_format","key_result_fields"],"type":"object"},"SearchInterpretation":{"description":"How a search naming 2 or more companies was read, and what page 1 holds about each.","properties":{"entities":{"description":"The named companies, in query order.","items":{"$ref":"#/components/schemas/EntityCoverage"},"type":"array"},"intent":{"$ref":"#/components/schemas/MultiEntityIntent"},"joint":{"description":"Page-1 results about 2 or more of `entities`.","format":"int32","minimum":0,"type":"integer"},"source":{"$ref":"#/components/schemas/MultiEntitySource"}},"required":["intent","source","entities","joint"],"type":"object"},"SearchRanking":{"description":"Who ordered a page of `POST /v1/search`.","enum":["jev","judge","retrieval"],"type":"string"},"SearchRequest":{"properties":{"as_of":{"description":"`YYYY-MM-DD`, point in time (behind the account flag `api_point_in_time`): the search as published by the end of that New York day. Results published at or after the start of the next New York day are not served, `reported_facts` reads only facts filed on or before it (each period's latest version filed by then), and every other data-block dataset is not read (`not_point_in_time`). Not after today.","nullable":true,"type":"string"},"cursor":{"description":"The `next_cursor` of the previous page, sent with that search's body unchanged except `limit`. Leave it out for page 1.","nullable":true,"type":"string"},"data":{"allOf":[{"$ref":"#/components/schemas/DataScope"}],"nullable":true,"description":"`asked` (the default) or `all`: which company and fund datasets page 1's data block reads."},"depth":{"allOf":[{"$ref":"#/components/schemas/SearchDepth"}],"nullable":true,"description":"`standard` (the default) or `deep`, which also ranks each result by its best passage and returns it. Needs the `deep_search` plan right."},"enriched_after":{"nullable":true,"type":"string","description":"RFC 3339, exclusive: only items whose metadata was computed after this instant. Articles don't carry it yet, so this leaves them out."},"event_types":{"description":"Event-type slugs (`earnings`, `m_and_a`, ...): only items carrying any of them.","items":{"type":"string"},"type":"array"},"exclude":{"description":"Pools (`brief`, `article`, `filing`, `transcript`) or related datasets to leave out. GET /v1/search/fields lists them.","items":{"type":"string"},"type":"array"},"limit":{"format":"int32","minimum":0,"nullable":true,"type":"integer","description":"Results per page, up to your plan's page cap."},"published_after":{"description":"RFC 3339, inclusive.","nullable":true,"type":"string"},"published_before":{"description":"RFC 3339, exclusive.","nullable":true,"type":"string"},"query":{"type":"string","description":"What to find, in plain words."},"rerank":{"description":"Leave it out. `false` skips re-ranking, for comparisons.","nullable":true,"type":"boolean"},"sort":{"allOf":[{"$ref":"#/components/schemas/SearchSort"}],"nullable":true,"description":"`relevance` (best match first, the default) or `newest`."},"symbols":{"items":{"type":"string"},"type":"array","description":"Tickers: only items about any of them."},"types":{"items":{"$ref":"#/components/schemas/SearchType"},"type":"array","description":"The pools to search. Prefer `exclude`; naming a pool in both is a 400."}},"required":["query"],"type":"object"},"SearchResponse":{"properties":{"answer":{"allOf":[{"$ref":"#/components/schemas/SearchAnswer"}],"nullable":true},"data":{"description":"Page 1 only: the data block, one item per dataset and entity: the datasets the query's intent asks for first, then entity order, then vocabulary order. Never ranked with `results`. Absent on a later page.","items":{"$ref":"#/components/schemas/DataItem"},"nullable":true,"type":"array"},"datasets":{"description":"One entry per name in the search vocabulary, in vocabulary order (the pools, then the `Dataset`s), saying what this search did with it. On every page; a later page repeats page 1's. Finks API may add names: a client treats an unknown name as one more entry, never as an error.","items":{"$ref":"#/components/schemas/SearchDataset"},"type":"array"},"entities":{"description":"Page 1 only: what the data block is about, in query order: the companies and funds the query names, and the macro series it asks for. Absent on a later page.","items":{"$ref":"#/components/schemas/SearchEntity"},"nullable":true,"type":"array"},"floor_note":{"nullable":true,"type":"string"},"has_more":{"type":"boolean"},"interpretation":{"allOf":[{"$ref":"#/components/schemas/SearchInterpretation"}],"nullable":true},"next_cursor":{"description":"Opaque token for the next page of the same ranked set. `null` on the last page.","nullable":true,"type":"string"},"point_in_time":{"allOf":[{"$ref":"#/components/schemas/PointInTime"}],"nullable":true},"ranking":{"$ref":"#/components/schemas/SearchRanking"},"results":{"description":"Ranked best first, at most `limit` items, may be empty.","items":{"$ref":"#/components/schemas/SearchResult"},"type":"array"},"retrieval_note":{"description":"`depth: \"standard\"`, page 1 only: present when the query embedding did not answer within its 2.5 s budget and the page was ranked on keyword matching alone, without semantic similarity (and without filing excerpts). Absent otherwise.","nullable":true,"type":"string"},"sort_note":{"description":"`sort: newest`, page 1 only: why the page holds fewer than `limit` results. Present when fewer than `limit` items matched the query and the read that fills the page with its best relevance matches did not complete (timed out or failed), so the page serves the matches alone. Absent otherwise.","nullable":true,"type":"string"}},"required":["results","datasets","has_more","ranking"],"type":"object"},"SearchResult":{"properties":{"cik":{"nullable":true,"type":"string"},"citation_id":{"description":"Filing: permanent identifier of the cited source span.","nullable":true,"type":"string"},"confidence":{"allOf":[{"$ref":"#/components/schemas/ConfidenceTier"}],"nullable":true},"earnings":{"allOf":[{"$ref":"#/components/schemas/EarningsCard"}],"nullable":true},"enriched_at":{"nullable":true,"type":"string"},"event_subtype":{"nullable":true,"type":"string"},"event_type":{"description":"Filing: the event's type, one of the event-type allowlist's slugs (`earnings`, `insider_transaction` for a Form 4, `insider_sale_notice` for a Form 144, `beneficial_ownership` for a Schedule 13D/13G, `periodic_report`, ...). Absent on other types and when the filing's type is not on the allowlist.","nullable":true,"type":"string"},"excerpt":{"description":"Filing: verbatim text from the source document.","nullable":true,"type":"string"},"excerpt_citation_id":{"description":"Filing, beside `excerpt` only: the excerpt passage's citation id.","nullable":true,"type":"string"},"excerpt_sha256":{"description":"Filing, beside `excerpt` only: lower-hex SHA-256 of `excerpt` exactly as served (its UTF-8 bytes, no normalization).","nullable":true,"type":"string"},"excerpt_url":{"description":"Filing, beside `excerpt` only: the excerpt passage's document URL.","nullable":true,"type":"string"},"flags":{"items":{"type":"string"},"nullable":true,"type":"array"},"id":{"type":"string"},"insider":{"allOf":[{"$ref":"#/components/schemas/InsiderFacts"}],"nullable":true},"ledger_event_id":{"description":"Filing: the event ledger id (`le1:`) of the real-world event this filing proves, shared by an 8-K and its 8-K/As. Absent when the ledger holds no row for it. On a company-timeline brief or article: the event of the 8-K folded into it.","nullable":true,"type":"string"},"matched":{"allOf":[{"$ref":"#/components/schemas/Matched"}],"nullable":true},"passage":{"allOf":[{"$ref":"#/components/schemas/Passage"}],"nullable":true},"published_at":{"nullable":true,"type":"string"},"publishers":{"description":"Brief, article: publisher domains behind the text.","items":{"type":"string"},"nullable":true,"type":"array"},"regulator":{"allOf":[{"$ref":"#/components/schemas/RegulatorCard"}],"nullable":true},"related":{"items":{"$ref":"#/components/schemas/RelatedRef"},"type":"array"},"source_sha256":{"nullable":true,"type":"string"},"sources":{"items":{"type":"string"},"type":"array"},"summary":{"nullable":true,"type":"string"},"symbols":{"items":{"type":"string"},"type":"array"},"title":{"type":"string"},"type":{"$ref":"#/components/schemas/SearchType"},"url":{"nullable":true,"type":"string"},"url_kind":{"description":"Transcript: what `url` links to, e.g. `sec_8k` (the SEC EDGAR index page of the earnings-release 8-K the call discusses), never a transcript page. Other values may appear: treat an unknown one as another kind of source link. Absent without a `url`.","nullable":true,"type":"string"}},"required":["id","type","title","symbols"],"type":"object"},"SearchSort":{"enum":["relevance","newest"],"type":"string"},"SearchType":{"enum":["brief","article","filing","transcript","regulator"],"type":"string"},"SectionCitation":{"properties":{"citation_id":{"type":"string"},"end":{"format":"int32","minimum":0,"nullable":true,"type":"integer"},"section_id":{"type":"string"},"source_sha256":{"nullable":true,"type":"string"},"start":{"format":"int32","minimum":0,"nullable":true,"type":"integer"},"url":{"type":"string"}},"required":["citation_id","section_id","url"],"type":"object"},"SetReading":{"description":"How a set question was read and answered: \"which <category> companies raised …\" (`GET /v1/funding?category=`), the largest new Form D offerings (`GET /v1/form-d?order=amount`) and the largest federal awards made in a window (`GET /v1/federal-awards?after=`), and a search data block's item for each. The window's rows by `ranked_by`, one per company; with a category, each judged for it by Jev, our structured-judgment engine (cached per company and category).","properties":{"after":{"description":"`YYYY-MM-DD`: the window's first day (a round's `round_date`, a Form D's `filing_date`, an award's `first_action_on`), inclusive.","type":"string"},"before":{"description":"`YYYY-MM-DD`: the window's end, exclusive; absent: today.","nullable":true,"type":"string"},"candidates":{"format":"int32","minimum":0,"type":"integer"},"category":{"description":"The category as read, folded (`data`, `ai`, `fintech`); absent: every company.","nullable":true,"type":"string"},"ceiling":{"description":"What the set cannot see: a member whose largest round in the window is past the window's `ceiling`-th largest raiser is never read.","format":"int32","minimum":0,"type":"integer"},"judged_as":{"description":"What each candidate was judged against (`data software and data infrastructure (…)`).","nullable":true,"type":"string"},"members":{"description":"Judged in the category (every candidate, with no category); served first in `results`.","format":"int32","minimum":0,"type":"integer"},"order":{"description":"Always `amount`: largest `ranked_by` first.","type":"string"},"out":{"description":"Judged not in the category; not served.","format":"int32","minimum":0,"type":"integer"},"ranked_by":{"description":"The field ranked: `amount_raised`, `offering_amount`, `amount_sold` or `obligated_usd`.","type":"string"},"unjudged":{"description":"Not judged: Jev failed, was still judging when the page was served (the judging runs on and fills the cache for the next ask), or the page's members were found among larger companies first. Not served.","format":"int32","minimum":0,"type":"integer"},"unjudged_names":{"description":"The unjudged companies that could have been on the page (no `limit` members rank above them), by name, largest first, at most 20: possibly members, not judged yet.","items":{"type":"string"},"type":"array"},"unsure":{"description":"Judged neither in nor out, by name, in amount order; served after every member. Possibly in the category: say so rather than count them as members.","items":{"type":"string"},"type":"array"},"window_note":{"description":"Present when the window read is not the one asked: a current calendar period (`this month`) with nothing dated in it yet reads the trailing window of its length, and `after`/`before` are that window's (`no funding rounds dated in November yet; showing the past 30 days`).","nullable":true,"type":"string"}},"required":["after","order","ranked_by","candidates","members","unsure","out","unjudged","ceiling"],"type":"object"},"SettingView":{"discriminator":{"propertyName":"state"},"oneOf":[{"properties":{"reason":{"$ref":"#/components/schemas/UnsetReason"},"state":{"enum":["unset"],"type":"string"}},"required":["reason","state"],"type":"object"}]},"ShortInterest":{"properties":{"attribution":{"description":"Show with every figure.","type":"string"},"avg_daily_volume":{"format":"double","nullable":true,"type":"number"},"days_to_cover":{"description":"As FINRA publishes it; `999.99` is FINRA's cap when volume is about zero.","format":"double","nullable":true,"type":"number"},"exportable":{"description":"Always `false`: no export or download in an app.","type":"boolean"},"finra_symbol":{"description":"FINRA's symbol (`BRKB` for `BRK-B`).","type":"string"},"previous_short_interest":{"format":"double","nullable":true,"type":"number"},"revised":{"type":"boolean"},"settlement_date":{"description":"`YYYY-MM-DD`, FINRA's settlement date.","type":"string"},"short_interest":{"description":"Shares sold short and not yet covered at settlement.","format":"double","type":"number"},"source":{"description":"`FINRA`.","type":"string"},"split_flag":{"type":"boolean"},"symbol":{"type":"string"}},"required":["symbol","settlement_date","finra_symbol","short_interest","split_flag","revised","source","attribution","exportable"],"type":"object"},"ShortInterestResponse":{"description":"`GET /v1/companies/{symbol}/short-interest`: a stock's FINRA short interest, newest settlement first.","properties":{"has_more":{"type":"boolean"},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"},"results":{"description":"By `settlement_date` descending, at most `limit`, never before the plan's history window; may be empty.","items":{"$ref":"#/components/schemas/ShortInterest"},"type":"array"}},"required":["results","has_more"],"type":"object"},"SortDirection":{"enum":["asc","desc"],"type":"string"},"SourceCoverage":{"properties":{"considered":{"format":"int64","minimum":0,"type":"integer"},"covered":{"format":"int64","minimum":0,"type":"integer"}},"required":["considered","covered"],"type":"object"},"SubjectRef":{"properties":{"display_name":{"nullable":true,"type":"string"},"id_namespace":{"type":"string"},"listings":{"items":{"type":"string"},"type":"array"},"subject_id":{"type":"string"},"subject_type":{"$ref":"#/components/schemas/SubjectType"},"symbols":{"items":{"type":"string"},"type":"array"}},"required":["subject_type","id_namespace","subject_id"],"type":"object"},"SubjectType":{"enum":["company","security","fund","person"],"type":"string"},"SummaryEvidence":{"properties":{"quotes":{"items":{"$ref":"#/components/schemas/EvidenceQuote"},"type":"array"},"sentence":{"description":"The sentence, verbatim as it appears in the record's `summary`.","type":"string"}},"required":["sentence","quotes"],"type":"object"},"TaxBasisAction":{"properties":{"action_date":{"description":"`YYYY-MM-DD`, the action's effective date (box 8).","nullable":true,"type":"string"},"action_type":{"description":"`return_of_capital`, `taxable_exchange`, `spin_off`, `reverse_split`, `stock_split` or `merger`.","nullable":true,"type":"string"},"attribution":{"description":"`Source: issuer IRS Form 8937 (IRC 6045B)`: show it with the facts.","type":"string"},"basis_pct":{"description":"A spin-off: percent of the pre-action aggregate basis allocated to this security (the issuer's illustrative allocation).","format":"double","nullable":true,"type":"number"},"confidence":{"description":"`high` or `low` (the parser read something it could not fully resolve).","type":"string"},"flags":{"description":"What the parser could not read (`no_ein`, `no_action_date`); may be empty.","items":{"type":"string"},"type":"array"},"fmv":{"description":"A taxable exchange: the issuer's suggested fair market value per share, in `fmv_currency` on `fmv_venue` for `fmv_date`.","format":"double","nullable":true,"type":"number"},"fmv_currency":{"nullable":true,"type":"string"},"fmv_date":{"nullable":true,"type":"string"},"fmv_venue":{"nullable":true,"type":"string"},"issuer_ein":{"description":"Box 2.","nullable":true,"type":"string"},"issuer_name":{"description":"Box 1.","nullable":true,"type":"string"},"issuer_pdf_url":{"description":"The issuer's own Form 8937 PDF: link it with the facts.","type":"string"},"ordinal":{"description":"The row's position in the document (0..); a row is `(issuer_pdf_url, ordinal)`.","format":"int32","type":"integer"},"per_shares_held":{"format":"int32","nullable":true,"type":"integer"},"roc_pct":{"description":"A return of capital: percent of the tax year's distributions per share that is return of capital.","format":"double","nullable":true,"type":"number"},"role":{"description":"`retained`, `received` or `held`: the holder's position in the action.","nullable":true,"type":"string"},"security":{"description":"The security the row is about (`Solventum common stock`).","type":"string"},"shares_received":{"description":"The distribution ratio: `shares_received` new shares per `per_shares_held` held.","format":"int32","nullable":true,"type":"integer"},"source_page":{"description":"The issuer's IR page that links the PDF.","type":"string"},"split_date":{"nullable":true,"type":"string"},"split_denominator":{"format":"double","nullable":true,"type":"number"},"split_numerator":{"format":"double","nullable":true,"type":"number"},"split_type":{"nullable":true,"type":"string"},"symbol":{"description":"The issuer's symbol when the document was posted (`MMM`, `MEG.TO`).","type":"string"},"tax_year":{"format":"int32","nullable":true,"type":"integer"},"ticker":{"description":"Box 12.","nullable":true,"type":"string"}},"required":["symbol","ordinal","security","confidence","flags","issuer_pdf_url","source_page","attribution"],"type":"object"},"TaxBasisResponse":{"description":"`GET /v1/companies/{symbol}/tax-basis`: the issuer's Form 8937 rows, newest action first.","properties":{"has_more":{"type":"boolean"},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"},"results":{"description":"By the action's date descending (`action_date`, else the end of `tax_year`), then each document's rows in `ordinal` order; at most `limit`, never bounded by the plan's history window (a cost-basis fact holds for as long as the shares are held); may be empty.","items":{"$ref":"#/components/schemas/TaxBasisAction"},"type":"array"}},"required":["results","has_more"],"type":"object"},"TrackARef":{"properties":{"calendar_period":{"type":"string"},"entity_id":{"type":"string"}},"required":["entity_id","calendar_period"],"type":"object"},"TypeCatalog":{"description":"One live type: what may be quoted, what must be attributed, and corpus depth.","properties":{"attribute":{"type":"string"},"earliest_published_at":{"nullable":true,"type":"string"},"items":{"format":"int64","minimum":0,"type":"integer"},"latest_published_at":{"nullable":true,"type":"string"},"quote":{"type":"string"},"type":{"$ref":"#/components/schemas/SearchType"}},"required":["type","quote","attribute","items"],"type":"object"},"UnitStateView":{"description":"One registered billable unit's complete state.","properties":{"credit_balance":{"$ref":"#/components/schemas/CreditBalanceView"},"entitlement":{"$ref":"#/components/schemas/EntitlementView"},"unit":{"type":"string"},"usage":{"$ref":"#/components/schemas/UsageView"}},"required":["unit","entitlement","usage","credit_balance"],"type":"object"},"Universe":{"additionalProperties":false,"properties":{"countries":{"items":{"type":"string"},"type":"array"},"exchanges":{"items":{"type":"string"},"type":"array"},"market_cap_ceiling":{"format":"double","nullable":true,"type":"number"},"market_cap_floor":{"format":"double","nullable":true,"type":"number"}},"type":"object"},"UnsetReason":{"enum":["no_store_in_this_slice"],"type":"string"},"UnsupportedClause":{"properties":{"clause":{"type":"string"},"reason":{"type":"string"}},"required":["clause","reason"],"type":"object"},"UnsupportedReason":{"enum":["identity_unmapped","subject_type_disabled","field_unavailable_for_subject"],"type":"string"},"UsageView":{"description":"What the ledger says about one account, one unit, one period.","discriminator":{"propertyName":"state"},"oneOf":[{"description":"Rows were read back. `units` is their exact sum and `rows` their count, so the figure reconciles against the ledger itself.","properties":{"daily":{"$ref":"#/components/schemas/DailyView"},"rows":{"format":"int64","minimum":0,"type":"integer"},"state":{"enum":["recorded"],"type":"string"},"units":{"format":"int64","minimum":0,"type":"integer"}},"required":["units","rows","daily","state"],"type":"object"},{"description":"No figure, and no number anywhere in this variant.","properties":{"reason":{"$ref":"#/components/schemas/NotRecordedView"},"state":{"enum":["not_recorded"],"type":"string"}},"required":["reason","state"],"type":"object"}]},"UseCase":{"enum":["own_tool","user_facing_app","internal_research","ai_agent","other"],"type":"string"},"ValuationClaim":{"properties":{"amount":{"description":"As stated, in `currency`.","format":"double","type":"number"},"amount_text":{"description":"The amount as the source wrote it (`$1.5 trillion`).","type":"string"},"amount_usd":{"description":"`amount` when `currency` is `USD`; never converted.","format":"double","nullable":true,"type":"number"},"basis":{"description":"What the amount is: `post_money`, `pre_money`, `ipo_target`, `deal_value` or `not_stated`.","type":"string"},"claim_id":{"description":"Stable for the same statement in the same source.","type":"string"},"company_key":{"description":"The issuer's name key (`anthropic`, `ai moonshot`): its name folded, legal forms dropped, words sorted. What `GET /v1/valuations?company=` matches.","type":"string"},"confidence":{"description":"0..1: how sure the reading of the amount and its status is.","format":"double","type":"number"},"currency":{"description":"`USD`, `EUR`, `GBP` or `other`.","type":"string"},"evidence_text":{"description":"The source's words around the amount, at most about 300 characters.","type":"string"},"issuer_confidence":{"description":"0..1: how sure the reading of the issuer is.","format":"double","type":"number"},"issuer_name":{"description":"The issuer as the source names it (`Moonshot AI`).","type":"string"},"reported_at":{"description":"RFC 3339 UTC: when the source reported it (the brief's publish time, the 8-K's acceptance).","type":"string"},"reported_on":{"description":"`YYYY-MM-DD` of `reported_at`: what pages and windows.","type":"string"},"round_amount":{"format":"double","nullable":true,"type":"number"},"round_amount_usd":{"description":"`round_amount` when `round_currency` is `USD`.","format":"double","nullable":true,"type":"number"},"round_currency":{"nullable":true,"type":"string"},"round_label":{"description":"As reported (`Series F`).","nullable":true,"type":"string"},"section_key":{"description":"An 8-K's section (`accession|document|8-k/item-7.01`).","nullable":true,"type":"string"},"source_count":{"description":"How many sources the brief cites.","format":"int32","type":"integer"},"source_id":{"description":"The brief id, or the 8-K's accession.","type":"string"},"source_kind":{"description":"`news_brief` or `sec_8k`.","type":"string"},"source_urls":{"description":"The brief's cited articles, or the 8-K's sec.gov index page; never empty.","items":{"type":"string"},"type":"array"},"status":{"description":"`completed`, `reported`, `in_talks`, `projection` or `prior` (an earlier valuation the report mentions).","type":"string"}},"required":["claim_id","company_key","issuer_name","amount","currency","amount_text","basis","status","reported_at","reported_on","source_kind","source_id","source_urls","source_count","evidence_text","confidence","issuer_confidence"],"type":"object"},"ValuationClaimsResponse":{"description":"`GET /v1/valuations`: a private company's valuation claims, newest report first.","properties":{"has_more":{"type":"boolean"},"next_cursor":{"description":"Opaque keyset token for the next page. `null` on the last page.","nullable":true,"type":"string"},"results":{"description":"By `(reported_on, claim_id)` descending, at most `limit`, never before the plan's history window; may be empty.","items":{"$ref":"#/components/schemas/ValuationClaim"},"type":"array"}},"required":["results","has_more"],"type":"object"},"WorkflowChartRequest":{"additionalProperties":false,"description":"`POST /v1/workflows/chart` body.","properties":{"data":{"description":"The previous block's JSON output (any shape; at most 2 MB).","type":"object"},"intent":{"description":"What the chart should show (`compare yields over time`); at most 500 characters.","nullable":true,"type":"string"},"route":{"description":"The route `data` came from (`/v1/rates/series/ust_par_10y/observations`): cited in `sources` when the rows carry no link of their own.","nullable":true,"type":"string"}},"required":["data"],"type":"object"},"WorkflowChartResponse":{"description":"`POST /v1/workflows/chart` answer.","properties":{"chart":{"$ref":"#/components/schemas/Chart"},"demo":{"description":"Always `true`.","type":"boolean"},"fallback":{"description":"Present (`true`) only when the second provider planned because the first failed.","type":"boolean"},"model":{"description":"The model whose plan was built; absent when the table fallback served.","nullable":true,"type":"string"},"notes":{"description":"What was trimmed, aggregated or fallen back from; absent when nothing was.","nullable":true,"type":"string"},"sources":{"items":{"$ref":"#/components/schemas/ChartSource"},"type":"array"},"usage":{"allOf":[{"$ref":"#/components/schemas/WorkflowModelUsage"}],"nullable":true}},"required":["chart","sources","demo"],"type":"object"},"WorkflowModelRequest":{"additionalProperties":false,"description":"`POST /v1/workflows/model` body.","properties":{"prompt":{"description":"1 to 20,000 characters, not blank.","type":"string"}},"required":["prompt"],"type":"object"},"WorkflowModelResponse":{"description":"`POST /v1/workflows/model` answer.","properties":{"demo":{"description":"Always `true`: a demo surface, not a product route.","type":"boolean"},"fallback":{"description":"Present (`true`) only when the second provider answered because the first failed.","type":"boolean"},"model":{"type":"string"},"text":{"type":"string"},"truncated":{"type":"boolean"},"usage":{"$ref":"#/components/schemas/WorkflowModelUsage"}},"required":["text","model","usage","demo"],"type":"object"},"WorkflowModelUsage":{"properties":{"input_tokens":{"format":"int64","minimum":0,"type":"integer"},"output_tokens":{"format":"int64","minimum":0,"type":"integer"}},"required":["input_tokens","output_tokens"],"type":"object"}},"securitySchemes":{"bearerAuth":{"description":"Your Finks API key, sent as `Authorization: Bearer $FINKS_API_KEY`.","scheme":"bearer","type":"http"}}}}