Skip to content

SearchHit

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.

Fields

FieldTypeAlways presentDescription
accepted_atdate-time (RFC 3339, UTC) | nullno—
accepted_at_sourcestring | nullno—
accessionstringno—
collapsedobject | nullnoOnly with collapse=true. Null, or {cluster_id, matched} when this result stands for matched results built from the same template.
descriptionstring | nullno—
doc_classstring | nullno—
doc_idstringno—
doc_typestring | nullno—
documentsarray of SearchDocumentnoA matching document. fields can trim its members.
documents_matchedintegerno—
entitiesarray of objectno—
filenamestring | nullno—
filing_datedate (YYYY-MM-DD) | nullno—
form_typestring | nullno—
is_primaryboolean | nullno—
provisionalbooleanno—
scorenumberno—
seqintegerno—
snippetsarray of SearchSnippetno—
statusstringnoThe filing's status. Filings SEC deleted are searchable too; use status= to narrow. One of: provisional, final, deleted.
urlstringno—

Used by

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