SearchParse
How a query is read. Nothing is run.
Fields
Nested fields are written with dots; [] marks the items of an array.
| Field | Type | Always present | Description |
|---|---|---|---|
ast | object | null | no | The query tree under the syntax you asked for: sexpr and tree. |
differs | boolean | no | True when the two readings differ. |
edgar | object | no | How EDGAR would read it: ast, echo (the query EDGAR would build) and error when it does not parse. |
filters | object | no | The filters after alias mapping and ticker lookup. |
match | string | no | One of: exact, stem. |
normalized | string | no | The query in normalized form. |
prefixes | array of object | no | Each item's fields follow, as prefixes[].…. |
prefixes[].capped | boolean | no | — |
prefixes[].expansions | integer | no | — |
prefixes[].in_span | boolean | no | True inside NEAR or a phrase, where a prefix expands to at most 1,024 terms. |
prefixes[].prefix | string | no | — |
prefixes[].top | array of array of any | no | Up to 20 pairs of [term, number of documents]. |
resolved | object | no | How tickers were matched to CIKs, as {tickers: {TICKER: [cik, ...]}}. |
shards | array of integer | no | The index years the query would search. |
syntax | string | no | One of: sb, edgar. |
warnings | array of SearchWarning | no | — |
Used by
- Returned by
GET /v3/search/parse.
Markdown version: /docs/reference/schemas/search-parse.md