Skip to content

SearchParse

How a query is read. Nothing is run.

Fields

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

FieldTypeAlways presentDescription
astobject | nullnoThe query tree under the syntax you asked for: sexpr and tree.
differsbooleannoTrue when the two readings differ.
edgarobjectnoHow EDGAR would read it: ast, echo (the query EDGAR would build) and error when it does not parse.
filtersobjectnoThe filters after alias mapping and ticker lookup.
matchstringnoOne of: exact, stem.
normalizedstringnoThe query in normalized form.
prefixesarray of objectnoEach item's fields follow, as prefixes[].….
prefixes[].cappedbooleanno—
prefixes[].expansionsintegerno—
prefixes[].in_spanbooleannoTrue inside NEAR or a phrase, where a prefix expands to at most 1,024 terms.
prefixes[].prefixstringno—
prefixes[].toparray of array of anynoUp to 20 pairs of [term, number of documents].
resolvedobjectnoHow tickers were matched to CIKs, as {tickers: {TICKER: [cik, ...]}}.
shardsarray of integernoThe index years the query would search.
syntaxstringnoOne of: sb, edgar.
warningsarray of SearchWarningno—

Used by

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