SearchResults
Fields
Nested fields are written with dots; [] marks the items of an array.
| Field | Type | Always present | Description |
|---|---|---|---|
data | array of SearchHit | yes | One 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. |
facets | SearchFacets | no | Counts 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_more | boolean | yes | — |
index | SearchIndexInfo | yes | The index that answered. |
next_cursor | string | null | yes | Pass it back as cursor with the same query, filters, sort, and group. Null when nothing follows, and always null with from above 0. |
resolved | object | yes | How tickers were matched to CIKs, as {tickers: {TICKER: [cik, ...]}}. |
resolved.tickers | object | no | — |
took_ms | integer | yes | — |
total | SearchTotals | yes | Exact counts for the whole query, all pages. All counts are null with totals=false. |
warnings | array of SearchWarning | yes | — |
Used by
- Returned by
GET /v3/search.
Markdown version: /docs/reference/schemas/search-results.md