Trade and quote conditions
Condition codes that qualify US stock trades and quotes, with their securities information processor mappings and whether a trade updates high, low, open, close and volume. Default order: type ascending, then id ascending. Results are limited to the entitled scope. Served from the OHLC security master, exchange calendars and reference tables. Access requires the operation capability on the API key.
/v1/conditions- Required capability
- reference.read
- Data timing
- As published by the source
- Credits
- 5 credits per request.
Parameters
typesstringoptional · query- Condition types, such as sale_condition or quote_condition.
data_typesstringoptional · query- Data types: trade, bbo or nbbo.
limitintegeroptional · query- Maximum records per page.Default:
100 cursorstringoptional · query- Opaque cursor, expires after one hour; binds filters, order, resolved as_of, account/key and entitlement. Repeat the original query unchanged.
formatstringoptional · query- Response format. csv returns the data rows with a header row, for spreadsheet functions such as IMPORTDATA; nested fields become dotted columns and lists one JSON array cell, the next page cursor is returned in X-Next-Cursor and meta.errors in X-Meta-Errors. A result without rows is the header row alone, listing the documented fields of a row. Default json, or csv when format is omitted and the Accept header ranks text/csv above JSON; a format the Accept header does not admit returns 406 not-acceptable.
jsoncsv
Response fields
Returns data as an array of records. All example values are illustrative.
idinteger- Condition ID as it appears on trades and quotes. Trade and quote conditions reuse IDs, so read it with type.
typestring- Condition type, such as sale_condition, quote_condition or financial_status_indicator.
namestring- Condition name.
descriptionstring · null- What the condition means.
asset_classstring- Asset class.
data_typesarray- Data the condition appears on: trade prints, exchange best bid and offer, or the national best bid and offer.
sip_mappingobject- Code each securities information processor (CTA, UTP, FINRA_TDDS) uses for the condition.
exchangeinteger · null- Exchange the condition is specific to; null for all.
legacyboolean- Whether the condition is no longer in use.
update_rulesobject · null- Whether a trade with the condition updates the consolidated and market-center high/low, open/close and volume; null for quote conditions.
Response metadata
Responses include meta.timezone. Dataset responses include next_cursor; health and exports have their own metadata. Request tracing uses the X-Request-ID header.
When something goes wrong
An empty data: [] is a successful query with no matching records. Invalid symbols, permissions and malformed parameters produce an RFC 9457 problem with an actionable detail.
Plans
Requires reference.read. Access, recency and history depth come from the plan definitions the API enforces.
| Plan | Access | Recency | History |
|---|---|---|---|
| Free | Included | As published | Not date-bounded |
| Developer | Included | As published | Not date-bounded |
| Pro | Included | As published | Not date-bounded |
| Commercial | Included | As published | Not date-bounded |
| Scale | Included | As published | Not date-bounded |
Free requests are limited to AAPL, NVDA, JNJ, PEP, MSFT, SPY, QQQ.
History is how far back a plan may request. How far records actually go for a symbol is history_from in dataset coverage. Nothing is real-time. Compare plans