Instrument Data
Retrieve instrument analytics, market data, news, and related reference data.
Get All Instrument Events
Get Instrument Events
Get Instrument Fundamentals
Get Instrument Balance Sheet Statements
Get Instrument Income Statements
Get Instrument Analyst Consensus
Get Instrument Cash Flow Statements
ModelsExpand Collapse
instrument_all_events_data: object { event_dates }
All-events payload grouped by date.
Events grouped by date in descending order.
Flat event envelopes for this date.
dividend_event_data: optional object { adjusted_dividend_amount, ex_date, declaration_date, 5 more }
Dividend payload when type is DIVIDEND. When a null/undefined value is observed, it indicates it does not apply.
declaration_date: optional string
The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.
dividend_amount: optional string
The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.
dividend_yield: optional string
The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.
frequency: optional string
The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.
earnings_event_data: optional object { date, eps_actual, eps_estimate, 4 more }
Earnings payload when type is EARNINGS. When a null/undefined value is observed, it indicates it does not apply.
eps_actual: optional string
The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_estimate: optional string
The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_surprise_percent: optional string
The percentage difference between actual and estimated EPS When a null/undefined value is observed, it indicates that there is no available data.
revenue_actual: optional string
The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.
instrument_id: optional string
Instrument identifier, when available. When a null/undefined value is observed, it indicates that there is no available data.
ipo_event_data: optional object { actions, announced_at, company, 4 more }
IPO payload when type is IPO. When a null/undefined value is observed, it indicates it does not apply.
actions: optional string
IPO action. When a null/undefined value is observed, it indicates that there is no available data.
announced_at: optional string
IPO announced timestamp. When a null/undefined value is observed, it indicates that there is no available data.
company: optional string
IPO company name. When a null/undefined value is observed, it indicates that there is no available data.
exchange: optional string
IPO exchange. When a null/undefined value is observed, it indicates that there is no available data.
market_cap: optional string
IPO market cap. When a null/undefined value is observed, it indicates that there is no available data.
name: optional string
Instrument name associated with the event, when available. When a null/undefined value is observed, it indicates that there is no available data.
reporting_currency: optional string
The currency used for reporting financial data. When a null/undefined value is observed, it indicates that there is no available data.
instrument_analyst_consensus: object { date, distribution, price_target, rating }
Aggregated analyst consensus metrics
distribution: optional object { buy, hold, sell, 2 more }
Count of individual analyst recommendations by category When a null/undefined value is observed, it indicates that there is no available data.
instrument_balance_sheet_statement: object { accepted_date, filing_date, period, 55 more }
instrument_balance_sheet_statement_list: array of InstrumentBalanceSheetStatement { accepted_date, filing_date, period, 55 more }
instrument_cash_flow_statement: object { accepted_date, filing_date, period, 42 more }
instrument_cash_flow_statement_list: array of InstrumentCashFlowStatement { accepted_date, filing_date, period, 42 more }
instrument_dividend_event: object { adjusted_dividend_amount, ex_date, declaration_date, 5 more }
Represents a dividend event for an instrument
declaration_date: optional string
The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.
dividend_amount: optional string
The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.
dividend_yield: optional string
The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.
frequency: optional string
The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.
instrument_earnings: object { date, eps_actual, eps_estimate, 4 more }
Represents instrument earnings data
eps_actual: optional string
The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_estimate: optional string
The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_surprise_percent: optional string
The percentage difference between actual and estimated EPS When a null/undefined value is observed, it indicates that there is no available data.
revenue_actual: optional string
The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.
instrument_event_envelope: object { symbol, type, dividend_event_data, 6 more }
Unified envelope for the all-events response.
dividend_event_data: optional object { adjusted_dividend_amount, ex_date, declaration_date, 5 more }
Dividend payload when type is DIVIDEND. When a null/undefined value is observed, it indicates it does not apply.
declaration_date: optional string
The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.
dividend_amount: optional string
The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.
dividend_yield: optional string
The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.
frequency: optional string
The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.
earnings_event_data: optional object { date, eps_actual, eps_estimate, 4 more }
Earnings payload when type is EARNINGS. When a null/undefined value is observed, it indicates it does not apply.
eps_actual: optional string
The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_estimate: optional string
The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_surprise_percent: optional string
The percentage difference between actual and estimated EPS When a null/undefined value is observed, it indicates that there is no available data.
revenue_actual: optional string
The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.
instrument_id: optional string
Instrument identifier, when available. When a null/undefined value is observed, it indicates that there is no available data.
ipo_event_data: optional object { actions, announced_at, company, 4 more }
IPO payload when type is IPO. When a null/undefined value is observed, it indicates it does not apply.
actions: optional string
IPO action. When a null/undefined value is observed, it indicates that there is no available data.
announced_at: optional string
IPO announced timestamp. When a null/undefined value is observed, it indicates that there is no available data.
company: optional string
IPO company name. When a null/undefined value is observed, it indicates that there is no available data.
exchange: optional string
IPO exchange. When a null/undefined value is observed, it indicates that there is no available data.
market_cap: optional string
IPO market cap. When a null/undefined value is observed, it indicates that there is no available data.
name: optional string
Instrument name associated with the event, when available. When a null/undefined value is observed, it indicates that there is no available data.
reporting_currency: optional string
The currency used for reporting financial data. When a null/undefined value is observed, it indicates that there is no available data.
instrument_event_ipo_item: object { actions, announced_at, company, 4 more }
IPO event in the all-events date grouping response.
actions: optional string
IPO action. When a null/undefined value is observed, it indicates that there is no available data.
announced_at: optional string
IPO announced timestamp. When a null/undefined value is observed, it indicates that there is no available data.
company: optional string
IPO company name. When a null/undefined value is observed, it indicates that there is no available data.
exchange: optional string
IPO exchange. When a null/undefined value is observed, it indicates that there is no available data.
market_cap: optional string
IPO market cap. When a null/undefined value is observed, it indicates that there is no available data.
instrument_events_by_date: object { date, events }
Instrument events for a single date.
Flat event envelopes for this date.
dividend_event_data: optional object { adjusted_dividend_amount, ex_date, declaration_date, 5 more }
Dividend payload when type is DIVIDEND. When a null/undefined value is observed, it indicates it does not apply.
declaration_date: optional string
The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.
dividend_amount: optional string
The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.
dividend_yield: optional string
The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.
frequency: optional string
The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.
earnings_event_data: optional object { date, eps_actual, eps_estimate, 4 more }
Earnings payload when type is EARNINGS. When a null/undefined value is observed, it indicates it does not apply.
eps_actual: optional string
The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_estimate: optional string
The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_surprise_percent: optional string
The percentage difference between actual and estimated EPS When a null/undefined value is observed, it indicates that there is no available data.
revenue_actual: optional string
The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.
instrument_id: optional string
Instrument identifier, when available. When a null/undefined value is observed, it indicates that there is no available data.
ipo_event_data: optional object { actions, announced_at, company, 4 more }
IPO payload when type is IPO. When a null/undefined value is observed, it indicates it does not apply.
actions: optional string
IPO action. When a null/undefined value is observed, it indicates that there is no available data.
announced_at: optional string
IPO announced timestamp. When a null/undefined value is observed, it indicates that there is no available data.
company: optional string
IPO company name. When a null/undefined value is observed, it indicates that there is no available data.
exchange: optional string
IPO exchange. When a null/undefined value is observed, it indicates that there is no available data.
market_cap: optional string
IPO market cap. When a null/undefined value is observed, it indicates that there is no available data.
name: optional string
Instrument name associated with the event, when available. When a null/undefined value is observed, it indicates that there is no available data.
reporting_currency: optional string
The currency used for reporting financial data. When a null/undefined value is observed, it indicates that there is no available data.
instrument_events_data: object { dividends, earnings, instrument_id, 2 more }
Grouped instrument events by type
dividends: array of InstrumentDividendEvent { adjusted_dividend_amount, ex_date, declaration_date, 5 more }
Dividend distribution events
declaration_date: optional string
The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.
dividend_amount: optional string
The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.
dividend_yield: optional string
The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.
frequency: optional string
The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.
Earnings announcement events
eps_actual: optional string
The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_estimate: optional string
The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.
eps_surprise_percent: optional string
The percentage difference between actual and estimated EPS When a null/undefined value is observed, it indicates that there is no available data.
revenue_actual: optional string
The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.
instrument_fundamentals: object { average_volume, beta, description, 12 more }
Supplemental fundamentals and company profile data for an instrument.
average_volume: optional number
The average daily trading volume over the past 30 days When a null/undefined value is observed, it indicates that there is no available data.
beta: optional string
The beta value, measuring the instrument’s volatility relative to the overall market When a null/undefined value is observed, it indicates that there is no available data.
description: optional string
A detailed description of the instrument or company When a null/undefined value is observed, it indicates that there is no available data.
dividend_yield: optional string
The trailing twelve months (TTM) dividend yield When a null/undefined value is observed, it indicates that there is no available data.
earnings_per_share: optional string
The trailing twelve months (TTM) earnings per share When a null/undefined value is observed, it indicates that there is no available data.
fifty_two_week_high: optional string
The highest price over the last 52 weeks When a null/undefined value is observed, it indicates that there is no available data.
fifty_two_week_low: optional string
The lowest price over the last 52 weeks When a null/undefined value is observed, it indicates that there is no available data.
industry: optional string
The specific industry of the instrument’s issuer When a null/undefined value is observed, it indicates that there is no available data.
list_date: optional string
The date the instrument was first listed When a null/undefined value is observed, it indicates that there is no available data.
logo_url: optional string
URL to a representative logo image for the instrument or issuer When a null/undefined value is observed, it indicates that there is no available data.
market_cap: optional string
The total market capitalization When a null/undefined value is observed, it indicates that there is no available data.
previous_close: optional string
The closing price from the previous trading day When a null/undefined value is observed, it indicates that there is no available data.
price_to_earnings: optional string
The price-to-earnings (P/E) ratio for the trailing twelve months (TTM) When a null/undefined value is observed, it indicates that there is no available data.
instrument_income_statement: object { accepted_date, filing_date, period, 34 more }
A quarterly income statement for an instrument.
instrument_income_statement_list: array of InstrumentIncomeStatement { accepted_date, filing_date, period, 34 more }
Instrument DataMarket Data
Retrieve instrument analytics, market data, news, and related reference data.
Get Daily Aggregate Summaries
ModelsExpand Collapse
daily_summary: object { instrument_id, high, low, 4 more }
Daily aggregate (OHLV) summary for a single instrument.
Returned by GET /market-data/daily-summary. Every field except
instrument_id is Option:
- Unresolvable
instrument_id→ all other fieldsNone(includingsymbol). - Resolvable
instrument_idwith no realtime cache entry →symbolpopulated, OHLV/trade_dateNone. trade_datereflects the session the OHLV represents (today during trading hours, the last trading date during weekends/holidays).
high: optional string
Session high. When a null/undefined value is observed, it indicates that there is no available data.
low: optional string
Session low. When a null/undefined value is observed, it indicates that there is no available data.
open: optional string
Opening price for the session. When a null/undefined value is observed, it indicates that there is no available data.
symbol: optional string
Display symbol for the security. None for unresolvable IDs.
When a null/undefined value is observed, it indicates that there is no available data.
high: optional string
Session high. When a null/undefined value is observed, it indicates that there is no available data.
low: optional string
Session low. When a null/undefined value is observed, it indicates that there is no available data.
open: optional string
Opening price for the session. When a null/undefined value is observed, it indicates that there is no available data.
symbol: optional string
Display symbol for the security. None for unresolvable IDs.
When a null/undefined value is observed, it indicates that there is no available data.
market_data_snapshot: object { instrument_id, symbol, cumulative_volume, 5 more }
Market data snapshot for a single security.
cumulative_volume: optional number
Cumulative traded volume reported on the most recent trade, in shares for equities or contracts for options. Absent when no trade is available. When a null/undefined value is observed, it indicates that there is no available data.
greeks: optional object { delta, gamma, iv, 5 more }
Theoretical price and Greeks for option instruments. None for
equities, and for options whose Greeks have not yet been observed
When a null/undefined value is observed, it indicates that there is no available data.
last_quote: optional object { ask, ask_size, bid, 2 more }
Most recent quote if available. When a null/undefined value is observed, it indicates that there is no available data.
ask: optional string
Current best ask. Absent when no ask is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.
ask_size: optional number
Size at the best ask, in shares. When a null/undefined value is observed, it indicates that there is no available data.
bid: optional string
Current best bid. Absent when no bid is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.
name: optional string
Security name if available. When a null/undefined value is observed, it indicates that there is no available data.
market_data_snapshot_list: array of MarketDataSnapshot { instrument_id, symbol, cumulative_volume, 5 more }
cumulative_volume: optional number
Cumulative traded volume reported on the most recent trade, in shares for equities or contracts for options. Absent when no trade is available. When a null/undefined value is observed, it indicates that there is no available data.
greeks: optional object { delta, gamma, iv, 5 more }
Theoretical price and Greeks for option instruments. None for
equities, and for options whose Greeks have not yet been observed
When a null/undefined value is observed, it indicates that there is no available data.
last_quote: optional object { ask, ask_size, bid, 2 more }
Most recent quote if available. When a null/undefined value is observed, it indicates that there is no available data.
ask: optional string
Current best ask. Absent when no ask is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.
ask_size: optional number
Size at the best ask, in shares. When a null/undefined value is observed, it indicates that there is no available data.
bid: optional string
Current best bid. Absent when no bid is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.
name: optional string
Security name if available. When a null/undefined value is observed, it indicates that there is no available data.
snapshot_quote: object { ask, ask_size, bid, 2 more }
L1 quote fields for a market data snapshot.
ask: optional string
Current best ask. Absent when no ask is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.
ask_size: optional number
Size at the best ask, in shares. When a null/undefined value is observed, it indicates that there is no available data.
bid: optional string
Current best bid. Absent when no bid is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.
Instrument DataNews
Retrieve instrument analytics, market data, news, and related reference data.
ModelsExpand Collapse
news_item: object { instruments, news_type, published_at, 6 more }
A single news item and its associated instruments.
image_url: optional string
URL of an associated image if provided by the source. When a null/undefined value is observed, it indicates that there is no available data.
image_url: optional string
URL of an associated image if provided by the source. When a null/undefined value is observed, it indicates that there is no available data.