Skip to content
Clear Street Clear Street
Start Trading
API Reference
V1

Instrument Data

Retrieve instrument analytics, market data, news, and related reference data.

Get All Instrument Events
v1.instrument_data.get_all_instrument_events(InstrumentDataGetAllInstrumentEventsParams**kwargs) -> InstrumentDataGetAllInstrumentEventsResponse
GET/v1/instruments/events
Get Instrument Events
v1.instrument_data.get_instrument_events(InstrumentIDOrSymbolinstrument_id, InstrumentDataGetInstrumentEventsParams**kwargs) -> InstrumentDataGetInstrumentEventsResponse
GET/v1/instruments/{instrument_id}/events
Get Instrument Fundamentals
v1.instrument_data.get_instrument_fundamentals(InstrumentIDOrSymbolinstrument_id) -> InstrumentDataGetInstrumentFundamentalsResponse
GET/v1/instruments/{instrument_id}/fundamentals
Get Instrument Balance Sheet Statements
v1.instrument_data.get_instrument_balance_sheet_statements(InstrumentIDOrSymbolinstrument_id, InstrumentDataGetInstrumentBalanceSheetStatementsParams**kwargs) -> InstrumentDataGetInstrumentBalanceSheetStatementsResponse
GET/v1/instruments/{instrument_id}/balance-sheets
Get Instrument Income Statements
v1.instrument_data.get_instrument_income_statements(InstrumentIDOrSymbolinstrument_id, InstrumentDataGetInstrumentIncomeStatementsParams**kwargs) -> InstrumentDataGetInstrumentIncomeStatementsResponse
GET/v1/instruments/{instrument_id}/income-statements
Get Instrument Analyst Consensus
v1.instrument_data.get_instrument_analyst_consensus(InstrumentIDOrSymbolinstrument_id, InstrumentDataGetInstrumentAnalystConsensusParams**kwargs) -> InstrumentDataGetInstrumentAnalystConsensusResponse
GET/v1/instruments/{instrument_id}/analyst-reporting
Get Instrument Cash Flow Statements
v1.instrument_data.get_instrument_cash_flow_statements(InstrumentIDOrSymbolinstrument_id, InstrumentDataGetInstrumentCashFlowStatementsParams**kwargs) -> InstrumentDataGetInstrumentCashFlowStatementsResponse
GET/v1/instruments/{instrument_id}/cash-flow-statements
ModelsExpand Collapse
Literal["EARNINGS", "DIVIDEND", "STOCK_SPLIT", "IPO"]

Event types supported by the all-events endpoint.

One of the following:
"EARNINGS"
"DIVIDEND"
"STOCK_SPLIT"
"IPO"
class AnalystDistribution: …

Analyst recommendation distribution

buy: int

Number of buy recommendations

formatint64
hold: int

Number of hold recommendations

formatint64
sell: int

Number of sell recommendations

formatint64
strong_buy: int

Number of strong buy recommendations

formatint64
strong_sell: int

Number of strong sell recommendations

formatint64
Literal["STRONG_BUY", "BUY", "HOLD", 2 more]

Analyst rating category

One of the following:
"STRONG_BUY"
"BUY"
"HOLD"
"SELL"
"STRONG_SELL"
Literal["QUARTERLY", "ANNUAL", "TTM", "BIANNUAL"]

Fiscal period type for earnings reports

One of the following:
"QUARTERLY"
"ANNUAL"
"TTM"
"BIANNUAL"
class InstrumentAllEventsData: …

All-events payload grouped by date.

event_dates: List[InstrumentEventsByDate]

Events grouped by date in descending order.

date: date

Event date.

formatdate

Flat event envelopes for this date.

symbol: str

Symbol associated with the event.

Event type discriminator.

One of the following:
"EARNINGS"
"DIVIDEND"
"STOCK_SPLIT"
"IPO"
dividend_event_data: Optional[InstrumentDividendEvent]

Dividend payload when type is DIVIDEND. When a null/undefined value is observed, it indicates it does not apply.

adjusted_dividend_amount: str

The adjusted dividend amount accounting for any splits.

ex_date: date

The day the stock starts trading without the right to receive that dividend.

formatdate
declaration_date: Optional[date]

The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.

formatdate
dividend_amount: Optional[str]

The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.

dividend_yield: Optional[str]

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[str]

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.

payment_date: Optional[date]

The payment date is the date on which a declared stock dividend is scheduled to be paid. When a null/undefined value is observed, it indicates that there is no available data.

formatdate
record_date: Optional[date]

The record date, set by a company’s board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. When a null/undefined value is observed, it indicates that there is no available data.

formatdate
earnings_event_data: Optional[InstrumentEarnings]

Earnings payload when type is EARNINGS. When a null/undefined value is observed, it indicates it does not apply.

date: date

The date when the earnings report was published

formatdate
eps_actual: Optional[str]

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[str]

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[str]

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[str]

The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.

revenue_estimate: Optional[str]

The estimated total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.

revenue_surprise_percent: Optional[str]

The percentage difference between actual and estimated revenue When a null/undefined value is observed, it indicates that there is no available data.

instrument_id: Optional[str]

Instrument identifier, when available. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid
ipo_event_data: Optional[InstrumentEventIpoItem]

IPO payload when type is IPO. When a null/undefined value is observed, it indicates it does not apply.

actions: Optional[str]

IPO action. When a null/undefined value is observed, it indicates that there is no available data.

announced_at: Optional[datetime]

IPO announced timestamp. When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time
company: Optional[str]

IPO company name. When a null/undefined value is observed, it indicates that there is no available data.

exchange: Optional[str]

IPO exchange. When a null/undefined value is observed, it indicates that there is no available data.

market_cap: Optional[str]

IPO market cap. When a null/undefined value is observed, it indicates that there is no available data.

price_range: Optional[str]

IPO price range. When a null/undefined value is observed, it indicates that there is no available data.

shares: Optional[str]

IPO shares offered. When a null/undefined value is observed, it indicates that there is no available data.

name: Optional[str]

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[str]

The currency used for reporting financial data. When a null/undefined value is observed, it indicates that there is no available data.

stock_split_event_data: Optional[InstrumentSplitEvent]

Stock split payload when type is STOCK_SPLIT. When a null/undefined value is observed, it indicates it does not apply.

date: date

The date of the stock split

formatdate
denominator: str

The denominator of the split ratio

numerator: str

The numerator of the split ratio

split_type: str

The type of stock split (e.g., “stock-split”, “stock-dividend”, “bonus-issue”)

class InstrumentAnalystConsensus: …

Aggregated analyst consensus metrics

date: date

The date the consensus snapshot was generated

formatdate
distribution: Optional[AnalystDistribution]

Count of individual analyst recommendations by category When a null/undefined value is observed, it indicates that there is no available data.

buy: int

Number of buy recommendations

formatint64
hold: int

Number of hold recommendations

formatint64
sell: int

Number of sell recommendations

formatint64
strong_buy: int

Number of strong buy recommendations

formatint64
strong_sell: int

Number of strong sell recommendations

formatint64
price_target: Optional[PriceTarget]

Aggregated analyst price target statistics When a null/undefined value is observed, it indicates that there is no available data.

average: str

Average analyst price target

currency: str

ISO 4217 currency code of the price targets

high: str

Highest analyst price target

low: str

Lowest analyst price target

rating: Optional[AnalystRating]

Consensus analyst rating When a null/undefined value is observed, it indicates that there is no available data.

One of the following:
"STRONG_BUY"
"BUY"
"HOLD"
"SELL"
"STRONG_SELL"
class InstrumentBalanceSheetStatement: …

A quarterly balance sheet statement for an instrument.

accepted_date: datetime

The date and time when the filing was accepted by the SEC

formatdate-time
filing_date: date

The date the financial statement was filed

formatdate
period: str

The fiscal period identifier (e.g., “Q1”, “Q2”, “Q3”, “Q4”)

period_type: FiscalPeriodType

The type of fiscal period

One of the following:
"QUARTERLY"
"ANNUAL"
"TTM"
"BIANNUAL"
reported_currency: str

The currency in which the statement is reported (ISO 4217)

year: int

The fiscal year of the statement

formatint32
account_payables: Optional[str]

Account payables

accounts_receivables: Optional[str]

Accounts receivables

accrued_expenses: Optional[str]

Accrued expenses

accumulated_other_comprehensive_income_loss: Optional[str]

Accumulated other comprehensive income/loss

additional_paid_in_capital: Optional[str]

Additional paid-in capital

capital_lease_obligations: Optional[str]

Capital lease obligations (total)

capital_lease_obligations_current: Optional[str]

Capital lease obligations (current portion)

cash_and_cash_equivalents: Optional[str]

Cash and cash equivalents

cash_and_short_term_investments: Optional[str]

Cash and short-term investments combined

common_stock: Optional[str]

Common stock

deferred_revenue: Optional[str]

Deferred revenue

deferred_revenue_non_current: Optional[str]

Deferred revenue (non-current)

deferred_tax_liabilities_non_current: Optional[str]

Deferred tax liabilities (non-current)

goodwill: Optional[str]

Goodwill

goodwill_and_intangible_assets: Optional[str]

Goodwill and intangible assets combined

intangible_assets: Optional[str]

Intangible assets

inventory: Optional[str]

Inventory

long_term_debt: Optional[str]

Long-term debt

long_term_investments: Optional[str]

Long-term investments

minority_interest: Optional[str]

Minority interest

net_debt: Optional[str]

Net debt (total debt minus cash)

net_receivables: Optional[str]

Net receivables

other_assets: Optional[str]

Other assets

other_current_assets: Optional[str]

Other current assets

other_current_liabilities: Optional[str]

Other current liabilities

other_liabilities: Optional[str]

Other liabilities

other_non_current_assets: Optional[str]

Other non-current assets

other_non_current_liabilities: Optional[str]

Other non-current liabilities

other_payables: Optional[str]

Other payables

other_receivables: Optional[str]

Other receivables

other_total_stockholders_equity: Optional[str]

Other total stockholders equity

preferred_stock: Optional[str]

Preferred stock

prepaids: Optional[str]

Prepaids

property_plant_and_equipment_net: Optional[str]

Property, plant and equipment net of depreciation

retained_earnings: Optional[str]

Retained earnings

short_term_debt: Optional[str]

Short-term debt

short_term_investments: Optional[str]

Short-term investments

tax_assets: Optional[str]

Tax assets

tax_payables: Optional[str]

Tax payables

total_assets: Optional[str]

Total assets

total_current_assets: Optional[str]

Total current assets

total_current_liabilities: Optional[str]

Total current liabilities

total_debt: Optional[str]

Total debt

total_equity: Optional[str]

Total equity

total_investments: Optional[str]

Total investments

total_liabilities: Optional[str]

Total liabilities

total_liabilities_and_total_equity: Optional[str]

Total liabilities and total equity

total_non_current_assets: Optional[str]

Total non-current assets

total_non_current_liabilities: Optional[str]

Total non-current liabilities

total_payables: Optional[str]

Total payables

total_stockholders_equity: Optional[str]

Total stockholders equity

treasury_stock: Optional[str]

Treasury stock

accepted_date: datetime

The date and time when the filing was accepted by the SEC

formatdate-time
filing_date: date

The date the financial statement was filed

formatdate
period: str

The fiscal period identifier (e.g., “Q1”, “Q2”, “Q3”, “Q4”)

period_type: FiscalPeriodType

The type of fiscal period

One of the following:
"QUARTERLY"
"ANNUAL"
"TTM"
"BIANNUAL"
reported_currency: str

The currency in which the statement is reported (ISO 4217)

year: int

The fiscal year of the statement

formatint32
account_payables: Optional[str]

Account payables

accounts_receivables: Optional[str]

Accounts receivables

accrued_expenses: Optional[str]

Accrued expenses

accumulated_other_comprehensive_income_loss: Optional[str]

Accumulated other comprehensive income/loss

additional_paid_in_capital: Optional[str]

Additional paid-in capital

capital_lease_obligations: Optional[str]

Capital lease obligations (total)

capital_lease_obligations_current: Optional[str]

Capital lease obligations (current portion)

cash_and_cash_equivalents: Optional[str]

Cash and cash equivalents

cash_and_short_term_investments: Optional[str]

Cash and short-term investments combined

common_stock: Optional[str]

Common stock

deferred_revenue: Optional[str]

Deferred revenue

deferred_revenue_non_current: Optional[str]

Deferred revenue (non-current)

deferred_tax_liabilities_non_current: Optional[str]

Deferred tax liabilities (non-current)

goodwill: Optional[str]

Goodwill

goodwill_and_intangible_assets: Optional[str]

Goodwill and intangible assets combined

intangible_assets: Optional[str]

Intangible assets

inventory: Optional[str]

Inventory

long_term_debt: Optional[str]

Long-term debt

long_term_investments: Optional[str]

Long-term investments

minority_interest: Optional[str]

Minority interest

net_debt: Optional[str]

Net debt (total debt minus cash)

net_receivables: Optional[str]

Net receivables

other_assets: Optional[str]

Other assets

other_current_assets: Optional[str]

Other current assets

other_current_liabilities: Optional[str]

Other current liabilities

other_liabilities: Optional[str]

Other liabilities

other_non_current_assets: Optional[str]

Other non-current assets

other_non_current_liabilities: Optional[str]

Other non-current liabilities

other_payables: Optional[str]

Other payables

other_receivables: Optional[str]

Other receivables

other_total_stockholders_equity: Optional[str]

Other total stockholders equity

preferred_stock: Optional[str]

Preferred stock

prepaids: Optional[str]

Prepaids

property_plant_and_equipment_net: Optional[str]

Property, plant and equipment net of depreciation

retained_earnings: Optional[str]

Retained earnings

short_term_debt: Optional[str]

Short-term debt

short_term_investments: Optional[str]

Short-term investments

tax_assets: Optional[str]

Tax assets

tax_payables: Optional[str]

Tax payables

total_assets: Optional[str]

Total assets

total_current_assets: Optional[str]

Total current assets

total_current_liabilities: Optional[str]

Total current liabilities

total_debt: Optional[str]

Total debt

total_equity: Optional[str]

Total equity

total_investments: Optional[str]

Total investments

total_liabilities: Optional[str]

Total liabilities

total_liabilities_and_total_equity: Optional[str]

Total liabilities and total equity

total_non_current_assets: Optional[str]

Total non-current assets

total_non_current_liabilities: Optional[str]

Total non-current liabilities

total_payables: Optional[str]

Total payables

total_stockholders_equity: Optional[str]

Total stockholders equity

treasury_stock: Optional[str]

Treasury stock

class InstrumentCashFlowStatement: …

A quarterly cash flow statement for an instrument.

accepted_date: datetime

The date and time when the filing was accepted by the SEC

formatdate-time
filing_date: date

The date the financial statement was filed

formatdate
period: str

The fiscal period identifier (e.g., “Q1”, “Q2”, “Q3”, “Q4”)

period_type: FiscalPeriodType

The type of fiscal period

One of the following:
"QUARTERLY"
"ANNUAL"
"TTM"
"BIANNUAL"
reported_currency: str

The currency in which the statement is reported (ISO 4217)

year: int

The fiscal year of the statement

formatint32
accounts_payables: Optional[str]

Change in accounts payables

accounts_receivables: Optional[str]

Change in accounts receivables

acquisitions_net: Optional[str]

Net acquisitions

capital_expenditure: Optional[str]

Capital expenditure

cash_at_beginning_of_period: Optional[str]

Cash and cash equivalents at beginning of period

cash_at_end_of_period: Optional[str]

Cash and cash equivalents at end of period

change_in_working_capital: Optional[str]

Change in working capital

common_dividends_paid: Optional[str]

Common dividends paid

common_stock_issuance: Optional[str]

Common stock issuance

common_stock_repurchased: Optional[str]

Common stock repurchased (buybacks)

deferred_income_tax: Optional[str]

Deferred income tax expense

depreciation_and_amortization: Optional[str]

Depreciation and amortization expense

effect_of_forex_changes_on_cash: Optional[str]

Effect of foreign exchange changes on cash

free_cash_flow: Optional[str]

Free cash flow (operating cash flow minus capital expenditure)

income_taxes_paid: Optional[str]

Income taxes paid

interest_paid: Optional[str]

Interest paid

inventory: Optional[str]

Change in inventory

investments_in_property_plant_and_equipment: Optional[str]

Investments in property, plant, and equipment

long_term_net_debt_issuance: Optional[str]

Long-term net debt issuance

net_cash_provided_by_financing_activities: Optional[str]

Net cash provided by financing activities

net_cash_provided_by_investing_activities: Optional[str]

Net cash provided by investing activities

net_cash_provided_by_operating_activities: Optional[str]

Net cash provided by operating activities

net_change_in_cash: Optional[str]

Net change in cash during the period

net_common_stock_issuance: Optional[str]

Net common stock issuance

net_debt_issuance: Optional[str]

Net debt issuance (long-term + short-term)

net_dividends_paid: Optional[str]

Net dividends paid (common + preferred)

net_income: Optional[str]

Net income for the period

net_preferred_stock_issuance: Optional[str]

Net preferred stock issuance

net_stock_issuance: Optional[str]

Net stock issuance (common + preferred)

operating_cash_flow: Optional[str]

Operating cash flow (alternative calculation)

other_financing_activities: Optional[str]

Other financing activities

other_investing_activities: Optional[str]

Other investing activities

other_non_cash_items: Optional[str]

Other non-cash items

other_working_capital: Optional[str]

Change in other working capital

preferred_dividends_paid: Optional[str]

Preferred dividends paid

purchases_of_investments: Optional[str]

Purchases of investments

sales_maturities_of_investments: Optional[str]

Sales and maturities of investments

short_term_net_debt_issuance: Optional[str]

Short-term net debt issuance

stock_based_compensation: Optional[str]

Stock-based compensation expense

accepted_date: datetime

The date and time when the filing was accepted by the SEC

formatdate-time
filing_date: date

The date the financial statement was filed

formatdate
period: str

The fiscal period identifier (e.g., “Q1”, “Q2”, “Q3”, “Q4”)

period_type: FiscalPeriodType

The type of fiscal period

One of the following:
"QUARTERLY"
"ANNUAL"
"TTM"
"BIANNUAL"
reported_currency: str

The currency in which the statement is reported (ISO 4217)

year: int

The fiscal year of the statement

formatint32
accounts_payables: Optional[str]

Change in accounts payables

accounts_receivables: Optional[str]

Change in accounts receivables

acquisitions_net: Optional[str]

Net acquisitions

capital_expenditure: Optional[str]

Capital expenditure

cash_at_beginning_of_period: Optional[str]

Cash and cash equivalents at beginning of period

cash_at_end_of_period: Optional[str]

Cash and cash equivalents at end of period

change_in_working_capital: Optional[str]

Change in working capital

common_dividends_paid: Optional[str]

Common dividends paid

common_stock_issuance: Optional[str]

Common stock issuance

common_stock_repurchased: Optional[str]

Common stock repurchased (buybacks)

deferred_income_tax: Optional[str]

Deferred income tax expense

depreciation_and_amortization: Optional[str]

Depreciation and amortization expense

effect_of_forex_changes_on_cash: Optional[str]

Effect of foreign exchange changes on cash

free_cash_flow: Optional[str]

Free cash flow (operating cash flow minus capital expenditure)

income_taxes_paid: Optional[str]

Income taxes paid

interest_paid: Optional[str]

Interest paid

inventory: Optional[str]

Change in inventory

investments_in_property_plant_and_equipment: Optional[str]

Investments in property, plant, and equipment

long_term_net_debt_issuance: Optional[str]

Long-term net debt issuance

net_cash_provided_by_financing_activities: Optional[str]

Net cash provided by financing activities

net_cash_provided_by_investing_activities: Optional[str]

Net cash provided by investing activities

net_cash_provided_by_operating_activities: Optional[str]

Net cash provided by operating activities

net_change_in_cash: Optional[str]

Net change in cash during the period

net_common_stock_issuance: Optional[str]

Net common stock issuance

net_debt_issuance: Optional[str]

Net debt issuance (long-term + short-term)

net_dividends_paid: Optional[str]

Net dividends paid (common + preferred)

net_income: Optional[str]

Net income for the period

net_preferred_stock_issuance: Optional[str]

Net preferred stock issuance

net_stock_issuance: Optional[str]

Net stock issuance (common + preferred)

operating_cash_flow: Optional[str]

Operating cash flow (alternative calculation)

other_financing_activities: Optional[str]

Other financing activities

other_investing_activities: Optional[str]

Other investing activities

other_non_cash_items: Optional[str]

Other non-cash items

other_working_capital: Optional[str]

Change in other working capital

preferred_dividends_paid: Optional[str]

Preferred dividends paid

purchases_of_investments: Optional[str]

Purchases of investments

sales_maturities_of_investments: Optional[str]

Sales and maturities of investments

short_term_net_debt_issuance: Optional[str]

Short-term net debt issuance

stock_based_compensation: Optional[str]

Stock-based compensation expense

class InstrumentDividendEvent: …

Represents a dividend event for an instrument

adjusted_dividend_amount: str

The adjusted dividend amount accounting for any splits.

ex_date: date

The day the stock starts trading without the right to receive that dividend.

formatdate
declaration_date: Optional[date]

The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.

formatdate
dividend_amount: Optional[str]

The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.

dividend_yield: Optional[str]

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[str]

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.

payment_date: Optional[date]

The payment date is the date on which a declared stock dividend is scheduled to be paid. When a null/undefined value is observed, it indicates that there is no available data.

formatdate
record_date: Optional[date]

The record date, set by a company’s board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. When a null/undefined value is observed, it indicates that there is no available data.

formatdate
class InstrumentEarnings: …

Represents instrument earnings data

date: date

The date when the earnings report was published

formatdate
eps_actual: Optional[str]

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[str]

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[str]

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[str]

The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.

revenue_estimate: Optional[str]

The estimated total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.

revenue_surprise_percent: Optional[str]

The percentage difference between actual and estimated revenue When a null/undefined value is observed, it indicates that there is no available data.

class InstrumentEventEnvelope: …

Unified envelope for the all-events response.

symbol: str

Symbol associated with the event.

Event type discriminator.

One of the following:
"EARNINGS"
"DIVIDEND"
"STOCK_SPLIT"
"IPO"
dividend_event_data: Optional[InstrumentDividendEvent]

Dividend payload when type is DIVIDEND. When a null/undefined value is observed, it indicates it does not apply.

adjusted_dividend_amount: str

The adjusted dividend amount accounting for any splits.

ex_date: date

The day the stock starts trading without the right to receive that dividend.

formatdate
declaration_date: Optional[date]

The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.

formatdate
dividend_amount: Optional[str]

The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.

dividend_yield: Optional[str]

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[str]

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.

payment_date: Optional[date]

The payment date is the date on which a declared stock dividend is scheduled to be paid. When a null/undefined value is observed, it indicates that there is no available data.

formatdate
record_date: Optional[date]

The record date, set by a company’s board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. When a null/undefined value is observed, it indicates that there is no available data.

formatdate
earnings_event_data: Optional[InstrumentEarnings]

Earnings payload when type is EARNINGS. When a null/undefined value is observed, it indicates it does not apply.

date: date

The date when the earnings report was published

formatdate
eps_actual: Optional[str]

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[str]

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[str]

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[str]

The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.

revenue_estimate: Optional[str]

The estimated total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.

revenue_surprise_percent: Optional[str]

The percentage difference between actual and estimated revenue When a null/undefined value is observed, it indicates that there is no available data.

instrument_id: Optional[str]

Instrument identifier, when available. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid
ipo_event_data: Optional[InstrumentEventIpoItem]

IPO payload when type is IPO. When a null/undefined value is observed, it indicates it does not apply.

actions: Optional[str]

IPO action. When a null/undefined value is observed, it indicates that there is no available data.

announced_at: Optional[datetime]

IPO announced timestamp. When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time
company: Optional[str]

IPO company name. When a null/undefined value is observed, it indicates that there is no available data.

exchange: Optional[str]

IPO exchange. When a null/undefined value is observed, it indicates that there is no available data.

market_cap: Optional[str]

IPO market cap. When a null/undefined value is observed, it indicates that there is no available data.

price_range: Optional[str]

IPO price range. When a null/undefined value is observed, it indicates that there is no available data.

shares: Optional[str]

IPO shares offered. When a null/undefined value is observed, it indicates that there is no available data.

name: Optional[str]

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[str]

The currency used for reporting financial data. When a null/undefined value is observed, it indicates that there is no available data.

stock_split_event_data: Optional[InstrumentSplitEvent]

Stock split payload when type is STOCK_SPLIT. When a null/undefined value is observed, it indicates it does not apply.

date: date

The date of the stock split

formatdate
denominator: str

The denominator of the split ratio

numerator: str

The numerator of the split ratio

split_type: str

The type of stock split (e.g., “stock-split”, “stock-dividend”, “bonus-issue”)

class InstrumentEventIpoItem: …

IPO event in the all-events date grouping response.

actions: Optional[str]

IPO action. When a null/undefined value is observed, it indicates that there is no available data.

announced_at: Optional[datetime]

IPO announced timestamp. When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time
company: Optional[str]

IPO company name. When a null/undefined value is observed, it indicates that there is no available data.

exchange: Optional[str]

IPO exchange. When a null/undefined value is observed, it indicates that there is no available data.

market_cap: Optional[str]

IPO market cap. When a null/undefined value is observed, it indicates that there is no available data.

price_range: Optional[str]

IPO price range. When a null/undefined value is observed, it indicates that there is no available data.

shares: Optional[str]

IPO shares offered. When a null/undefined value is observed, it indicates that there is no available data.

class InstrumentEventsByDate: …

Instrument events for a single date.

date: date

Event date.

formatdate

Flat event envelopes for this date.

symbol: str

Symbol associated with the event.

Event type discriminator.

One of the following:
"EARNINGS"
"DIVIDEND"
"STOCK_SPLIT"
"IPO"
dividend_event_data: Optional[InstrumentDividendEvent]

Dividend payload when type is DIVIDEND. When a null/undefined value is observed, it indicates it does not apply.

adjusted_dividend_amount: str

The adjusted dividend amount accounting for any splits.

ex_date: date

The day the stock starts trading without the right to receive that dividend.

formatdate
declaration_date: Optional[date]

The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.

formatdate
dividend_amount: Optional[str]

The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.

dividend_yield: Optional[str]

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[str]

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.

payment_date: Optional[date]

The payment date is the date on which a declared stock dividend is scheduled to be paid. When a null/undefined value is observed, it indicates that there is no available data.

formatdate
record_date: Optional[date]

The record date, set by a company’s board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. When a null/undefined value is observed, it indicates that there is no available data.

formatdate
earnings_event_data: Optional[InstrumentEarnings]

Earnings payload when type is EARNINGS. When a null/undefined value is observed, it indicates it does not apply.

date: date

The date when the earnings report was published

formatdate
eps_actual: Optional[str]

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[str]

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[str]

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[str]

The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.

revenue_estimate: Optional[str]

The estimated total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.

revenue_surprise_percent: Optional[str]

The percentage difference between actual and estimated revenue When a null/undefined value is observed, it indicates that there is no available data.

instrument_id: Optional[str]

Instrument identifier, when available. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid
ipo_event_data: Optional[InstrumentEventIpoItem]

IPO payload when type is IPO. When a null/undefined value is observed, it indicates it does not apply.

actions: Optional[str]

IPO action. When a null/undefined value is observed, it indicates that there is no available data.

announced_at: Optional[datetime]

IPO announced timestamp. When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time
company: Optional[str]

IPO company name. When a null/undefined value is observed, it indicates that there is no available data.

exchange: Optional[str]

IPO exchange. When a null/undefined value is observed, it indicates that there is no available data.

market_cap: Optional[str]

IPO market cap. When a null/undefined value is observed, it indicates that there is no available data.

price_range: Optional[str]

IPO price range. When a null/undefined value is observed, it indicates that there is no available data.

shares: Optional[str]

IPO shares offered. When a null/undefined value is observed, it indicates that there is no available data.

name: Optional[str]

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[str]

The currency used for reporting financial data. When a null/undefined value is observed, it indicates that there is no available data.

stock_split_event_data: Optional[InstrumentSplitEvent]

Stock split payload when type is STOCK_SPLIT. When a null/undefined value is observed, it indicates it does not apply.

date: date

The date of the stock split

formatdate
denominator: str

The denominator of the split ratio

numerator: str

The numerator of the split ratio

split_type: str

The type of stock split (e.g., “stock-split”, “stock-dividend”, “bonus-issue”)

class InstrumentEventsData: …

Grouped instrument events by type

dividends: List[InstrumentDividendEvent]

Dividend distribution events

adjusted_dividend_amount: str

The adjusted dividend amount accounting for any splits.

ex_date: date

The day the stock starts trading without the right to receive that dividend.

formatdate
declaration_date: Optional[date]

The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.

formatdate
dividend_amount: Optional[str]

The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.

dividend_yield: Optional[str]

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[str]

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.

payment_date: Optional[date]

The payment date is the date on which a declared stock dividend is scheduled to be paid. When a null/undefined value is observed, it indicates that there is no available data.

formatdate
record_date: Optional[date]

The record date, set by a company’s board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. When a null/undefined value is observed, it indicates that there is no available data.

formatdate
earnings: List[InstrumentEarnings]

Earnings announcement events

date: date

The date when the earnings report was published

formatdate
eps_actual: Optional[str]

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[str]

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[str]

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[str]

The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.

revenue_estimate: Optional[str]

The estimated total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.

revenue_surprise_percent: Optional[str]

The percentage difference between actual and estimated revenue When a null/undefined value is observed, it indicates that there is no available data.

instrument_id: str

Instrument identifier

formatuuid
splits: List[InstrumentSplitEvent]

Stock split events

date: date

The date of the stock split

formatdate
denominator: str

The denominator of the split ratio

numerator: str

The numerator of the split ratio

split_type: str

The type of stock split (e.g., “stock-split”, “stock-dividend”, “bonus-issue”)

reporting_currency: Optional[str]

The currency used for reporting financial data When a null/undefined value is observed, it indicates that there is no available data.

class InstrumentFundamentals: …

Supplemental fundamentals and company profile data for an instrument.

average_volume: Optional[int]

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.

formatint64
beta: Optional[str]

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[str]

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[str]

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[str]

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[str]

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[str]

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[str]

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[date]

The date the instrument was first listed When a null/undefined value is observed, it indicates that there is no available data.

formatdate
logo_url: Optional[str]

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[str]

The total market capitalization When a null/undefined value is observed, it indicates that there is no available data.

previous_close: Optional[str]

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[str]

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.

reporting_currency: Optional[str]

The currency used for reporting financial data When a null/undefined value is observed, it indicates that there is no available data.

sector: Optional[str]

The business sector of the instrument’s issuer When a null/undefined value is observed, it indicates that there is no available data.

class InstrumentIncomeStatement: …

A quarterly income statement for an instrument.

accepted_date: datetime

The date and time when the filing was accepted by the SEC

formatdate-time
filing_date: date

The date the financial statement was filed

formatdate
period: str

The fiscal period identifier (e.g., “Q1”, “Q2”, “Q3”, “Q4”)

period_type: FiscalPeriodType

The type of fiscal period

One of the following:
"QUARTERLY"
"ANNUAL"
"TTM"
"BIANNUAL"
reported_currency: str

The currency in which the statement is reported (ISO 4217)

year: int

The fiscal year of the statement

formatint32
bottom_line_net_income: Optional[str]

Bottom line net income after all adjustments

cost_and_expenses: Optional[str]

Total costs and expenses

cost_of_revenue: Optional[str]

Direct costs attributable to producing goods sold

depreciation_and_amortization: Optional[str]

Depreciation and amortization expenses

ebit: Optional[str]

Earnings before interest and taxes

ebitda: Optional[str]

Earnings before interest, taxes, depreciation, and amortization

eps: Optional[str]

Basic earnings per share

eps_diluted: Optional[str]

Diluted earnings per share

general_and_administrative_expenses: Optional[str]

General administrative overhead expenses

gross_profit: Optional[str]

Revenue minus cost of revenue

income_before_tax: Optional[str]

Income before income tax expense

income_tax_expense: Optional[str]

Income tax expense for the period

interest_expense: Optional[str]

Interest paid on debt

interest_income: Optional[str]

Interest earned on investments and cash

net_income: Optional[str]

Total net income for the period

net_income_deductions: Optional[str]

Deductions from net income

net_income_from_continuing_operations: Optional[str]

Net income from continuing operations

net_income_from_discontinued_operations: Optional[str]

Net income from discontinued operations

net_interest_income: Optional[str]

Net interest income (interest income minus interest expense)

non_operating_income_excluding_interest: Optional[str]

Non-operating income excluding interest

operating_expenses: Optional[str]

Total operating expenses

operating_income: Optional[str]

Income from core business operations

other_adjustments_to_net_income: Optional[str]

Other adjustments to net income

other_expenses: Optional[str]

Other miscellaneous expenses

research_and_development_expenses: Optional[str]

Expenditure on research and development activities

revenue: Optional[str]

Total revenue from sales of goods and services

selling_and_marketing_expenses: Optional[str]

Expenditure on marketing and sales activities

selling_general_and_administrative_expenses: Optional[str]

Combined selling, general, and administrative expenses

total_other_income_expenses_net: Optional[str]

Net of other income and expenses

weighted_average_shs_out: Optional[str]

Weighted average shares outstanding (basic)

weighted_average_shs_out_dil: Optional[str]

Weighted average shares outstanding (diluted)

accepted_date: datetime

The date and time when the filing was accepted by the SEC

formatdate-time
filing_date: date

The date the financial statement was filed

formatdate
period: str

The fiscal period identifier (e.g., “Q1”, “Q2”, “Q3”, “Q4”)

period_type: FiscalPeriodType

The type of fiscal period

One of the following:
"QUARTERLY"
"ANNUAL"
"TTM"
"BIANNUAL"
reported_currency: str

The currency in which the statement is reported (ISO 4217)

year: int

The fiscal year of the statement

formatint32
bottom_line_net_income: Optional[str]

Bottom line net income after all adjustments

cost_and_expenses: Optional[str]

Total costs and expenses

cost_of_revenue: Optional[str]

Direct costs attributable to producing goods sold

depreciation_and_amortization: Optional[str]

Depreciation and amortization expenses

ebit: Optional[str]

Earnings before interest and taxes

ebitda: Optional[str]

Earnings before interest, taxes, depreciation, and amortization

eps: Optional[str]

Basic earnings per share

eps_diluted: Optional[str]

Diluted earnings per share

general_and_administrative_expenses: Optional[str]

General administrative overhead expenses

gross_profit: Optional[str]

Revenue minus cost of revenue

income_before_tax: Optional[str]

Income before income tax expense

income_tax_expense: Optional[str]

Income tax expense for the period

interest_expense: Optional[str]

Interest paid on debt

interest_income: Optional[str]

Interest earned on investments and cash

net_income: Optional[str]

Total net income for the period

net_income_deductions: Optional[str]

Deductions from net income

net_income_from_continuing_operations: Optional[str]

Net income from continuing operations

net_income_from_discontinued_operations: Optional[str]

Net income from discontinued operations

net_interest_income: Optional[str]

Net interest income (interest income minus interest expense)

non_operating_income_excluding_interest: Optional[str]

Non-operating income excluding interest

operating_expenses: Optional[str]

Total operating expenses

operating_income: Optional[str]

Income from core business operations

other_adjustments_to_net_income: Optional[str]

Other adjustments to net income

other_expenses: Optional[str]

Other miscellaneous expenses

research_and_development_expenses: Optional[str]

Expenditure on research and development activities

revenue: Optional[str]

Total revenue from sales of goods and services

selling_and_marketing_expenses: Optional[str]

Expenditure on marketing and sales activities

selling_general_and_administrative_expenses: Optional[str]

Combined selling, general, and administrative expenses

total_other_income_expenses_net: Optional[str]

Net of other income and expenses

weighted_average_shs_out: Optional[str]

Weighted average shares outstanding (basic)

weighted_average_shs_out_dil: Optional[str]

Weighted average shares outstanding (diluted)

class InstrumentSplitEvent: …

Represents a stock split event for an instrument

date: date

The date of the stock split

formatdate
denominator: str

The denominator of the split ratio

numerator: str

The numerator of the split ratio

split_type: str

The type of stock split (e.g., “stock-split”, “stock-dividend”, “bonus-issue”)

class PriceTarget: …

Analyst price target statistics

average: str

Average analyst price target

currency: str

ISO 4217 currency code of the price targets

high: str

Highest analyst price target

low: str

Lowest analyst price target

class InstrumentDataGetAllInstrumentEventsResponse: …

All-events payload grouped by date.

event_dates: List[InstrumentEventsByDate]

Events grouped by date in descending order.

date: date

Event date.

formatdate

Flat event envelopes for this date.

symbol: str

Symbol associated with the event.

Event type discriminator.

One of the following:
"EARNINGS"
"DIVIDEND"
"STOCK_SPLIT"
"IPO"
dividend_event_data: Optional[InstrumentDividendEvent]

Dividend payload when type is DIVIDEND. When a null/undefined value is observed, it indicates it does not apply.

adjusted_dividend_amount: str

The adjusted dividend amount accounting for any splits.

ex_date: date

The day the stock starts trading without the right to receive that dividend.

formatdate
declaration_date: Optional[date]

The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.

formatdate
dividend_amount: Optional[str]

The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.

dividend_yield: Optional[str]

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[str]

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.

payment_date: Optional[date]

The payment date is the date on which a declared stock dividend is scheduled to be paid. When a null/undefined value is observed, it indicates that there is no available data.

formatdate
record_date: Optional[date]

The record date, set by a company’s board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. When a null/undefined value is observed, it indicates that there is no available data.

formatdate
earnings_event_data: Optional[InstrumentEarnings]

Earnings payload when type is EARNINGS. When a null/undefined value is observed, it indicates it does not apply.

date: date

The date when the earnings report was published

formatdate
eps_actual: Optional[str]

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[str]

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[str]

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[str]

The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.

revenue_estimate: Optional[str]

The estimated total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.

revenue_surprise_percent: Optional[str]

The percentage difference between actual and estimated revenue When a null/undefined value is observed, it indicates that there is no available data.

instrument_id: Optional[str]

Instrument identifier, when available. When a null/undefined value is observed, it indicates that there is no available data.

formatuuid
ipo_event_data: Optional[InstrumentEventIpoItem]

IPO payload when type is IPO. When a null/undefined value is observed, it indicates it does not apply.

actions: Optional[str]

IPO action. When a null/undefined value is observed, it indicates that there is no available data.

announced_at: Optional[datetime]

IPO announced timestamp. When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time
company: Optional[str]

IPO company name. When a null/undefined value is observed, it indicates that there is no available data.

exchange: Optional[str]

IPO exchange. When a null/undefined value is observed, it indicates that there is no available data.

market_cap: Optional[str]

IPO market cap. When a null/undefined value is observed, it indicates that there is no available data.

price_range: Optional[str]

IPO price range. When a null/undefined value is observed, it indicates that there is no available data.

shares: Optional[str]

IPO shares offered. When a null/undefined value is observed, it indicates that there is no available data.

name: Optional[str]

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[str]

The currency used for reporting financial data. When a null/undefined value is observed, it indicates that there is no available data.

stock_split_event_data: Optional[InstrumentSplitEvent]

Stock split payload when type is STOCK_SPLIT. When a null/undefined value is observed, it indicates it does not apply.

date: date

The date of the stock split

formatdate
denominator: str

The denominator of the split ratio

numerator: str

The numerator of the split ratio

split_type: str

The type of stock split (e.g., “stock-split”, “stock-dividend”, “bonus-issue”)

class InstrumentDataGetInstrumentEventsResponse: …

Grouped instrument events by type

dividends: List[InstrumentDividendEvent]

Dividend distribution events

adjusted_dividend_amount: str

The adjusted dividend amount accounting for any splits.

ex_date: date

The day the stock starts trading without the right to receive that dividend.

formatdate
declaration_date: Optional[date]

The declaration date of the dividend When a null/undefined value is observed, it indicates that there is no available data.

formatdate
dividend_amount: Optional[str]

The dividend amount per share. When a null/undefined value is observed, it indicates that there is no available data.

dividend_yield: Optional[str]

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[str]

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.

payment_date: Optional[date]

The payment date is the date on which a declared stock dividend is scheduled to be paid. When a null/undefined value is observed, it indicates that there is no available data.

formatdate
record_date: Optional[date]

The record date, set by a company’s board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. When a null/undefined value is observed, it indicates that there is no available data.

formatdate
earnings: List[InstrumentEarnings]

Earnings announcement events

date: date

The date when the earnings report was published

formatdate
eps_actual: Optional[str]

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[str]

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[str]

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[str]

The actual total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.

revenue_estimate: Optional[str]

The estimated total revenue for the period When a null/undefined value is observed, it indicates that there is no available data.

revenue_surprise_percent: Optional[str]

The percentage difference between actual and estimated revenue When a null/undefined value is observed, it indicates that there is no available data.

instrument_id: str

Instrument identifier

formatuuid
splits: List[InstrumentSplitEvent]

Stock split events

date: date

The date of the stock split

formatdate
denominator: str

The denominator of the split ratio

numerator: str

The numerator of the split ratio

split_type: str

The type of stock split (e.g., “stock-split”, “stock-dividend”, “bonus-issue”)

reporting_currency: Optional[str]

The currency used for reporting financial data When a null/undefined value is observed, it indicates that there is no available data.

class InstrumentDataGetInstrumentFundamentalsResponse: …

Supplemental fundamentals and company profile data for an instrument.

average_volume: Optional[int]

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.

formatint64
beta: Optional[str]

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[str]

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[str]

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[str]

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[str]

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[str]

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[str]

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[date]

The date the instrument was first listed When a null/undefined value is observed, it indicates that there is no available data.

formatdate
logo_url: Optional[str]

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[str]

The total market capitalization When a null/undefined value is observed, it indicates that there is no available data.

previous_close: Optional[str]

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[str]

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.

reporting_currency: Optional[str]

The currency used for reporting financial data When a null/undefined value is observed, it indicates that there is no available data.

sector: Optional[str]

The business sector of the instrument’s issuer When a null/undefined value is observed, it indicates that there is no available data.

class InstrumentDataGetInstrumentBalanceSheetStatementsResponse: …
accepted_date: datetime

The date and time when the filing was accepted by the SEC

formatdate-time
filing_date: date

The date the financial statement was filed

formatdate
period: str

The fiscal period identifier (e.g., “Q1”, “Q2”, “Q3”, “Q4”)

period_type: FiscalPeriodType

The type of fiscal period

One of the following:
"QUARTERLY"
"ANNUAL"
"TTM"
"BIANNUAL"
reported_currency: str

The currency in which the statement is reported (ISO 4217)

year: int

The fiscal year of the statement

formatint32
account_payables: Optional[str]

Account payables

accounts_receivables: Optional[str]

Accounts receivables

accrued_expenses: Optional[str]

Accrued expenses

accumulated_other_comprehensive_income_loss: Optional[str]

Accumulated other comprehensive income/loss

additional_paid_in_capital: Optional[str]

Additional paid-in capital

capital_lease_obligations: Optional[str]

Capital lease obligations (total)

capital_lease_obligations_current: Optional[str]

Capital lease obligations (current portion)

cash_and_cash_equivalents: Optional[str]

Cash and cash equivalents

cash_and_short_term_investments: Optional[str]

Cash and short-term investments combined

common_stock: Optional[str]

Common stock

deferred_revenue: Optional[str]

Deferred revenue

deferred_revenue_non_current: Optional[str]

Deferred revenue (non-current)

deferred_tax_liabilities_non_current: Optional[str]

Deferred tax liabilities (non-current)

goodwill: Optional[str]

Goodwill

goodwill_and_intangible_assets: Optional[str]

Goodwill and intangible assets combined

intangible_assets: Optional[str]

Intangible assets

inventory: Optional[str]

Inventory

long_term_debt: Optional[str]

Long-term debt

long_term_investments: Optional[str]

Long-term investments

minority_interest: Optional[str]

Minority interest

net_debt: Optional[str]

Net debt (total debt minus cash)

net_receivables: Optional[str]

Net receivables

other_assets: Optional[str]

Other assets

other_current_assets: Optional[str]

Other current assets

other_current_liabilities: Optional[str]

Other current liabilities

other_liabilities: Optional[str]

Other liabilities

other_non_current_assets: Optional[str]

Other non-current assets

other_non_current_liabilities: Optional[str]

Other non-current liabilities

other_payables: Optional[str]

Other payables

other_receivables: Optional[str]

Other receivables

other_total_stockholders_equity: Optional[str]

Other total stockholders equity

preferred_stock: Optional[str]

Preferred stock

prepaids: Optional[str]

Prepaids

property_plant_and_equipment_net: Optional[str]

Property, plant and equipment net of depreciation

retained_earnings: Optional[str]

Retained earnings

short_term_debt: Optional[str]

Short-term debt

short_term_investments: Optional[str]

Short-term investments

tax_assets: Optional[str]

Tax assets

tax_payables: Optional[str]

Tax payables

total_assets: Optional[str]

Total assets

total_current_assets: Optional[str]

Total current assets

total_current_liabilities: Optional[str]

Total current liabilities

total_debt: Optional[str]

Total debt

total_equity: Optional[str]

Total equity

total_investments: Optional[str]

Total investments

total_liabilities: Optional[str]

Total liabilities

total_liabilities_and_total_equity: Optional[str]

Total liabilities and total equity

total_non_current_assets: Optional[str]

Total non-current assets

total_non_current_liabilities: Optional[str]

Total non-current liabilities

total_payables: Optional[str]

Total payables

total_stockholders_equity: Optional[str]

Total stockholders equity

treasury_stock: Optional[str]

Treasury stock

class InstrumentDataGetInstrumentIncomeStatementsResponse: …
accepted_date: datetime

The date and time when the filing was accepted by the SEC

formatdate-time
filing_date: date

The date the financial statement was filed

formatdate
period: str

The fiscal period identifier (e.g., “Q1”, “Q2”, “Q3”, “Q4”)

period_type: FiscalPeriodType

The type of fiscal period

One of the following:
"QUARTERLY"
"ANNUAL"
"TTM"
"BIANNUAL"
reported_currency: str

The currency in which the statement is reported (ISO 4217)

year: int

The fiscal year of the statement

formatint32
bottom_line_net_income: Optional[str]

Bottom line net income after all adjustments

cost_and_expenses: Optional[str]

Total costs and expenses

cost_of_revenue: Optional[str]

Direct costs attributable to producing goods sold

depreciation_and_amortization: Optional[str]

Depreciation and amortization expenses

ebit: Optional[str]

Earnings before interest and taxes

ebitda: Optional[str]

Earnings before interest, taxes, depreciation, and amortization

eps: Optional[str]

Basic earnings per share

eps_diluted: Optional[str]

Diluted earnings per share

general_and_administrative_expenses: Optional[str]

General administrative overhead expenses

gross_profit: Optional[str]

Revenue minus cost of revenue

income_before_tax: Optional[str]

Income before income tax expense

income_tax_expense: Optional[str]

Income tax expense for the period

interest_expense: Optional[str]

Interest paid on debt

interest_income: Optional[str]

Interest earned on investments and cash

net_income: Optional[str]

Total net income for the period

net_income_deductions: Optional[str]

Deductions from net income

net_income_from_continuing_operations: Optional[str]

Net income from continuing operations

net_income_from_discontinued_operations: Optional[str]

Net income from discontinued operations

net_interest_income: Optional[str]

Net interest income (interest income minus interest expense)

non_operating_income_excluding_interest: Optional[str]

Non-operating income excluding interest

operating_expenses: Optional[str]

Total operating expenses

operating_income: Optional[str]

Income from core business operations

other_adjustments_to_net_income: Optional[str]

Other adjustments to net income

other_expenses: Optional[str]

Other miscellaneous expenses

research_and_development_expenses: Optional[str]

Expenditure on research and development activities

revenue: Optional[str]

Total revenue from sales of goods and services

selling_and_marketing_expenses: Optional[str]

Expenditure on marketing and sales activities

selling_general_and_administrative_expenses: Optional[str]

Combined selling, general, and administrative expenses

total_other_income_expenses_net: Optional[str]

Net of other income and expenses

weighted_average_shs_out: Optional[str]

Weighted average shares outstanding (basic)

weighted_average_shs_out_dil: Optional[str]

Weighted average shares outstanding (diluted)

class InstrumentDataGetInstrumentAnalystConsensusResponse: …

Aggregated analyst consensus metrics

date: date

The date the consensus snapshot was generated

formatdate
distribution: Optional[AnalystDistribution]

Count of individual analyst recommendations by category When a null/undefined value is observed, it indicates that there is no available data.

buy: int

Number of buy recommendations

formatint64
hold: int

Number of hold recommendations

formatint64
sell: int

Number of sell recommendations

formatint64
strong_buy: int

Number of strong buy recommendations

formatint64
strong_sell: int

Number of strong sell recommendations

formatint64
price_target: Optional[PriceTarget]

Aggregated analyst price target statistics When a null/undefined value is observed, it indicates that there is no available data.

average: str

Average analyst price target

currency: str

ISO 4217 currency code of the price targets

high: str

Highest analyst price target

low: str

Lowest analyst price target

rating: Optional[AnalystRating]

Consensus analyst rating When a null/undefined value is observed, it indicates that there is no available data.

One of the following:
"STRONG_BUY"
"BUY"
"HOLD"
"SELL"
"STRONG_SELL"
class InstrumentDataGetInstrumentCashFlowStatementsResponse: …
accepted_date: datetime

The date and time when the filing was accepted by the SEC

formatdate-time
filing_date: date

The date the financial statement was filed

formatdate
period: str

The fiscal period identifier (e.g., “Q1”, “Q2”, “Q3”, “Q4”)

period_type: FiscalPeriodType

The type of fiscal period

One of the following:
"QUARTERLY"
"ANNUAL"
"TTM"
"BIANNUAL"
reported_currency: str

The currency in which the statement is reported (ISO 4217)

year: int

The fiscal year of the statement

formatint32
accounts_payables: Optional[str]

Change in accounts payables

accounts_receivables: Optional[str]

Change in accounts receivables

acquisitions_net: Optional[str]

Net acquisitions

capital_expenditure: Optional[str]

Capital expenditure

cash_at_beginning_of_period: Optional[str]

Cash and cash equivalents at beginning of period

cash_at_end_of_period: Optional[str]

Cash and cash equivalents at end of period

change_in_working_capital: Optional[str]

Change in working capital

common_dividends_paid: Optional[str]

Common dividends paid

common_stock_issuance: Optional[str]

Common stock issuance

common_stock_repurchased: Optional[str]

Common stock repurchased (buybacks)

deferred_income_tax: Optional[str]

Deferred income tax expense

depreciation_and_amortization: Optional[str]

Depreciation and amortization expense

effect_of_forex_changes_on_cash: Optional[str]

Effect of foreign exchange changes on cash

free_cash_flow: Optional[str]

Free cash flow (operating cash flow minus capital expenditure)

income_taxes_paid: Optional[str]

Income taxes paid

interest_paid: Optional[str]

Interest paid

inventory: Optional[str]

Change in inventory

investments_in_property_plant_and_equipment: Optional[str]

Investments in property, plant, and equipment

long_term_net_debt_issuance: Optional[str]

Long-term net debt issuance

net_cash_provided_by_financing_activities: Optional[str]

Net cash provided by financing activities

net_cash_provided_by_investing_activities: Optional[str]

Net cash provided by investing activities

net_cash_provided_by_operating_activities: Optional[str]

Net cash provided by operating activities

net_change_in_cash: Optional[str]

Net change in cash during the period

net_common_stock_issuance: Optional[str]

Net common stock issuance

net_debt_issuance: Optional[str]

Net debt issuance (long-term + short-term)

net_dividends_paid: Optional[str]

Net dividends paid (common + preferred)

net_income: Optional[str]

Net income for the period

net_preferred_stock_issuance: Optional[str]

Net preferred stock issuance

net_stock_issuance: Optional[str]

Net stock issuance (common + preferred)

operating_cash_flow: Optional[str]

Operating cash flow (alternative calculation)

other_financing_activities: Optional[str]

Other financing activities

other_investing_activities: Optional[str]

Other investing activities

other_non_cash_items: Optional[str]

Other non-cash items

other_working_capital: Optional[str]

Change in other working capital

preferred_dividends_paid: Optional[str]

Preferred dividends paid

purchases_of_investments: Optional[str]

Purchases of investments

sales_maturities_of_investments: Optional[str]

Sales and maturities of investments

short_term_net_debt_issuance: Optional[str]

Short-term net debt issuance

stock_based_compensation: Optional[str]

Stock-based compensation expense

Instrument DataMarket Data

Retrieve instrument analytics, market data, news, and related reference data.

Get Snapshots
v1.instrument_data.market_data.get_snapshots(MarketDataGetSnapshotsParams**kwargs) -> MarketDataGetSnapshotsResponse
GET/v1/market-data/snapshot
Get Daily Aggregate Summaries
v1.instrument_data.market_data.get_daily_summaries(MarketDataGetDailySummariesParams**kwargs) -> MarketDataGetDailySummariesResponse
GET/v1/market-data/daily-summary
ModelsExpand Collapse
class DailySummary: …

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 fields None (including symbol).
  • Resolvable instrument_id with no realtime cache entry → symbol populated, OHLV/trade_date None.
  • trade_date reflects the session the OHLV represents (today during trading hours, the last trading date during weekends/holidays).
instrument_id: str

Unique instrument identifier. Always populated; echoes the request ID.

formatuuid
high: Optional[str]

Session high. When a null/undefined value is observed, it indicates that there is no available data.

low: Optional[str]

Session low. When a null/undefined value is observed, it indicates that there is no available data.

open: Optional[str]

Opening price for the session. When a null/undefined value is observed, it indicates that there is no available data.

symbol: Optional[str]

Display symbol for the security. None for unresolvable IDs. When a null/undefined value is observed, it indicates that there is no available data.

trade_date: Optional[date]

Session date the OHLV represents, US/Eastern. When a null/undefined value is observed, it indicates that there is no available data.

formatdate
volume: Optional[int]

Session cumulative trading volume. When a null/undefined value is observed, it indicates that there is no available data.

formatint64
instrument_id: str

Unique instrument identifier. Always populated; echoes the request ID.

formatuuid
high: Optional[str]

Session high. When a null/undefined value is observed, it indicates that there is no available data.

low: Optional[str]

Session low. When a null/undefined value is observed, it indicates that there is no available data.

open: Optional[str]

Opening price for the session. When a null/undefined value is observed, it indicates that there is no available data.

symbol: Optional[str]

Display symbol for the security. None for unresolvable IDs. When a null/undefined value is observed, it indicates that there is no available data.

trade_date: Optional[date]

Session date the OHLV represents, US/Eastern. When a null/undefined value is observed, it indicates that there is no available data.

formatdate
volume: Optional[int]

Session cumulative trading volume. When a null/undefined value is observed, it indicates that there is no available data.

formatint64
class MarketDataSnapshot: …

Market data snapshot for a single security.

instrument_id: str

Unique instrument identifier.

symbol: str

Display symbol for the security.

cumulative_volume: Optional[int]

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.

formatint64
minimum0
greeks: Optional[SnapshotGreeks]

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.

delta: str

Delta: ∂V/∂S, range [-1, 1].

gamma: str

Gamma: ∂²V/∂S².

iv: str

Implied volatility, annualized (0.20 == 20%).

rho: str

Rho per 1.0 rate point.

theo_price: str

Theoretical option price in USD per share.

theta: str

Theta per trading day.

timestamp: datetime

Timestamp when the Greeks were calculated.

formatdate-time
vega: str

Vega per 1.0 vol point.

last_quote: Optional[SnapshotQuote]

Most recent quote if available. When a null/undefined value is observed, it indicates that there is no available data.

ask: Optional[str]

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[int]

Size at the best ask, in shares. When a null/undefined value is observed, it indicates that there is no available data.

formatint32
minimum0
bid: Optional[str]

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.

bid_size: Optional[int]

Size at the best bid, in shares. When a null/undefined value is observed, it indicates that there is no available data.

formatint32
minimum0
midpoint: Optional[str]

Midpoint of bid and ask. Absent when either side is missing. When a null/undefined value is observed, it indicates that there is no available data.

last_trade: Optional[SnapshotLastTrade]

Most recent last-sale trade if available. When a null/undefined value is observed, it indicates that there is no available data.

price: str

Most recent last-sale eligible trade price.

size: int

Share quantity of the most recent last-sale eligible trade.

formatint32
minimum0
name: Optional[str]

Security name if available. When a null/undefined value is observed, it indicates that there is no available data.

session: Optional[SnapshotSession]

Session metrics computed from previous close and last trade, if available. When a null/undefined value is observed, it indicates that there is no available data.

change: str

Absolute change from previous close to last trade.

change_percent: str

Percent change from previous close to last trade.

previous_close: str

Previous session close price.

instrument_id: str

Unique instrument identifier.

symbol: str

Display symbol for the security.

cumulative_volume: Optional[int]

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.

formatint64
minimum0
greeks: Optional[SnapshotGreeks]

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.

delta: str

Delta: ∂V/∂S, range [-1, 1].

gamma: str

Gamma: ∂²V/∂S².

iv: str

Implied volatility, annualized (0.20 == 20%).

rho: str

Rho per 1.0 rate point.

theo_price: str

Theoretical option price in USD per share.

theta: str

Theta per trading day.

timestamp: datetime

Timestamp when the Greeks were calculated.

formatdate-time
vega: str

Vega per 1.0 vol point.

last_quote: Optional[SnapshotQuote]

Most recent quote if available. When a null/undefined value is observed, it indicates that there is no available data.

ask: Optional[str]

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[int]

Size at the best ask, in shares. When a null/undefined value is observed, it indicates that there is no available data.

formatint32
minimum0
bid: Optional[str]

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.

bid_size: Optional[int]

Size at the best bid, in shares. When a null/undefined value is observed, it indicates that there is no available data.

formatint32
minimum0
midpoint: Optional[str]

Midpoint of bid and ask. Absent when either side is missing. When a null/undefined value is observed, it indicates that there is no available data.

last_trade: Optional[SnapshotLastTrade]

Most recent last-sale trade if available. When a null/undefined value is observed, it indicates that there is no available data.

price: str

Most recent last-sale eligible trade price.

size: int

Share quantity of the most recent last-sale eligible trade.

formatint32
minimum0
name: Optional[str]

Security name if available. When a null/undefined value is observed, it indicates that there is no available data.

session: Optional[SnapshotSession]

Session metrics computed from previous close and last trade, if available. When a null/undefined value is observed, it indicates that there is no available data.

change: str

Absolute change from previous close to last trade.

change_percent: str

Percent change from previous close to last trade.

previous_close: str

Previous session close price.

class SnapshotGreeks: …

Theoretical price and Greeks for an options snapshot. All values are per share; no contract multiplier is applied.

delta: str

Delta: ∂V/∂S, range [-1, 1].

gamma: str

Gamma: ∂²V/∂S².

iv: str

Implied volatility, annualized (0.20 == 20%).

rho: str

Rho per 1.0 rate point.

theo_price: str

Theoretical option price in USD per share.

theta: str

Theta per trading day.

timestamp: datetime

Timestamp when the Greeks were calculated.

formatdate-time
vega: str

Vega per 1.0 vol point.

class SnapshotLastTrade: …

Last-trade fields for a market data snapshot.

price: str

Most recent last-sale eligible trade price.

size: int

Share quantity of the most recent last-sale eligible trade.

formatint32
minimum0
class SnapshotQuote: …

L1 quote fields for a market data snapshot.

ask: Optional[str]

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[int]

Size at the best ask, in shares. When a null/undefined value is observed, it indicates that there is no available data.

formatint32
minimum0
bid: Optional[str]

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.

bid_size: Optional[int]

Size at the best bid, in shares. When a null/undefined value is observed, it indicates that there is no available data.

formatint32
minimum0
midpoint: Optional[str]

Midpoint of bid and ask. Absent when either side is missing. When a null/undefined value is observed, it indicates that there is no available data.

class SnapshotSession: …

Session-level pricing metrics for a market data snapshot.

change: str

Absolute change from previous close to last trade.

change_percent: str

Percent change from previous close to last trade.

previous_close: str

Previous session close price.

class MarketDataGetSnapshotsResponse: …
instrument_id: str

Unique instrument identifier.

symbol: str

Display symbol for the security.

cumulative_volume: Optional[int]

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.

formatint64
minimum0
greeks: Optional[SnapshotGreeks]

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.

delta: str

Delta: ∂V/∂S, range [-1, 1].

gamma: str

Gamma: ∂²V/∂S².

iv: str

Implied volatility, annualized (0.20 == 20%).

rho: str

Rho per 1.0 rate point.

theo_price: str

Theoretical option price in USD per share.

theta: str

Theta per trading day.

timestamp: datetime

Timestamp when the Greeks were calculated.

formatdate-time
vega: str

Vega per 1.0 vol point.

last_quote: Optional[SnapshotQuote]

Most recent quote if available. When a null/undefined value is observed, it indicates that there is no available data.

ask: Optional[str]

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[int]

Size at the best ask, in shares. When a null/undefined value is observed, it indicates that there is no available data.

formatint32
minimum0
bid: Optional[str]

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.

bid_size: Optional[int]

Size at the best bid, in shares. When a null/undefined value is observed, it indicates that there is no available data.

formatint32
minimum0
midpoint: Optional[str]

Midpoint of bid and ask. Absent when either side is missing. When a null/undefined value is observed, it indicates that there is no available data.

last_trade: Optional[SnapshotLastTrade]

Most recent last-sale trade if available. When a null/undefined value is observed, it indicates that there is no available data.

price: str

Most recent last-sale eligible trade price.

size: int

Share quantity of the most recent last-sale eligible trade.

formatint32
minimum0
name: Optional[str]

Security name if available. When a null/undefined value is observed, it indicates that there is no available data.

session: Optional[SnapshotSession]

Session metrics computed from previous close and last trade, if available. When a null/undefined value is observed, it indicates that there is no available data.

change: str

Absolute change from previous close to last trade.

change_percent: str

Percent change from previous close to last trade.

previous_close: str

Previous session close price.

class MarketDataGetDailySummariesResponse: …
instrument_id: str

Unique instrument identifier. Always populated; echoes the request ID.

formatuuid
high: Optional[str]

Session high. When a null/undefined value is observed, it indicates that there is no available data.

low: Optional[str]

Session low. When a null/undefined value is observed, it indicates that there is no available data.

open: Optional[str]

Opening price for the session. When a null/undefined value is observed, it indicates that there is no available data.

symbol: Optional[str]

Display symbol for the security. None for unresolvable IDs. When a null/undefined value is observed, it indicates that there is no available data.

trade_date: Optional[date]

Session date the OHLV represents, US/Eastern. When a null/undefined value is observed, it indicates that there is no available data.

formatdate
volume: Optional[int]

Session cumulative trading volume. When a null/undefined value is observed, it indicates that there is no available data.

formatint64

Instrument DataNews

Retrieve instrument analytics, market data, news, and related reference data.

Get News
v1.instrument_data.news.get_news(NewsGetNewsParams**kwargs) -> NewsGetNewsResponse
GET/v1/news
ModelsExpand Collapse
class NewsInstrument: …

Instrument associated with a news item.

instrument_id: str

Instrument identifier.

formatuuid
name: Optional[str]

Instrument name/description, if available. When a null/undefined value is observed, it indicates that there is no available data.

symbol: Optional[str]

Trading symbol, if available. When a null/undefined value is observed, it indicates that there is no available data.

class NewsItem: …

A single news item and its associated instruments.

instruments: List[NewsInstrument]

Instruments associated with this news item.

instrument_id: str

Instrument identifier.

formatuuid
name: Optional[str]

Instrument name/description, if available. When a null/undefined value is observed, it indicates that there is no available data.

symbol: Optional[str]

Trading symbol, if available. When a null/undefined value is observed, it indicates that there is no available data.

news_type: NewsType

Classification of the item.

One of the following:
"NEWS"
"PRESS_RELEASE"
published_at: datetime

The published date/time of the article in UTC.

formatdate-time
publisher: str

The publisher or newswire source.

title: str

The headline/title of the article.

url: str

Canonical URL to the full article.

image_url: Optional[str]

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.

site: Optional[str]

The primary domain/site of the publisher. When a null/undefined value is observed, it indicates that there is no available data.

text: Optional[str]

The full or excerpted article body. When a null/undefined value is observed, it indicates that there is no available data.

List[NewsItem]
instruments: List[NewsInstrument]

Instruments associated with this news item.

instrument_id: str

Instrument identifier.

formatuuid
name: Optional[str]

Instrument name/description, if available. When a null/undefined value is observed, it indicates that there is no available data.

symbol: Optional[str]

Trading symbol, if available. When a null/undefined value is observed, it indicates that there is no available data.

news_type: NewsType

Classification of the item.

One of the following:
"NEWS"
"PRESS_RELEASE"
published_at: datetime

The published date/time of the article in UTC.

formatdate-time
publisher: str

The publisher or newswire source.

title: str

The headline/title of the article.

url: str

Canonical URL to the full article.

image_url: Optional[str]

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.

site: Optional[str]

The primary domain/site of the publisher. When a null/undefined value is observed, it indicates that there is no available data.

text: Optional[str]

The full or excerpted article body. When a null/undefined value is observed, it indicates that there is no available data.

Literal["NEWS", "PRESS_RELEASE"]

News item classification.

One of the following:
"NEWS"
"PRESS_RELEASE"
class NewsGetNewsResponse: …
instruments: List[NewsInstrument]

Instruments associated with this news item.

instrument_id: str

Instrument identifier.

formatuuid
name: Optional[str]

Instrument name/description, if available. When a null/undefined value is observed, it indicates that there is no available data.

symbol: Optional[str]

Trading symbol, if available. When a null/undefined value is observed, it indicates that there is no available data.

news_type: NewsType

Classification of the item.

One of the following:
"NEWS"
"PRESS_RELEASE"
published_at: datetime

The published date/time of the article in UTC.

formatdate-time
publisher: str

The publisher or newswire source.

title: str

The headline/title of the article.

url: str

Canonical URL to the full article.

image_url: Optional[str]

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.

site: Optional[str]

The primary domain/site of the publisher. When a null/undefined value is observed, it indicates that there is no available data.

text: Optional[str]

The full or excerpted article body. When a null/undefined value is observed, it indicates that there is no available data.