Skip to content

SearchResults

Fields

Nested fields are written with dots; [] marks the items of an array.

FieldTypeAlways presentDescription
dataarray of SearchHityesOne result. With group=document, a document with its filing's details. With group=filing, a filing with documents_matched, documents, and collapsed. fields can trim its members.
facetsSearchFacetsnoCounts for the facets named in facets=. Counts are documents with group=document and filings with group=filing. A result counts once under each of its values. At most facet_size buckets each, largest first.
has_morebooleanyes—
indexSearchIndexInfoyesThe index that answered.
next_cursorstring | nullyesPass it back as cursor with the same query, filters, sort, and group. Null when nothing follows, and always null with from above 0.
resolvedobjectyesHow tickers were matched to CIKs, as {tickers: {TICKER: [cik, ...]}}.
resolved.tickersobjectno—
took_msintegeryes—
totalSearchTotalsyesExact counts for the whole query, all pages. All counts are null with totals=false.
warningsarray of SearchWarningyes—

Used by

Markdown version: /docs/reference/schemas/search-results.md