API Reference

V1

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Instrument Data

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

Get All Instrument Events

client.v1.instrumentData.getAllInstrumentEvents(InstrumentDataGetAllInstrumentEventsParams { event_types, from_date, instrument_ids, to_date } query?, RequestOptionsoptions?): InstrumentDataGetAllInstrumentEventsResponse { data }

GET/v1/instruments/events

Get Instrument Events

client.v1.instrumentData.getInstrumentEvents(InstrumentIDOrSymbolinstrumentID, InstrumentDataGetInstrumentEventsParams { from_date, to_date } query?, RequestOptionsoptions?): InstrumentDataGetInstrumentEventsResponse { data }

GET/v1/instruments/{instrument_id}/events

Get Instrument Fundamentals

client.v1.instrumentData.getInstrumentFundamentals(InstrumentIDOrSymbolinstrumentID, RequestOptionsoptions?): InstrumentDataGetInstrumentFundamentalsResponse { data }

GET/v1/instruments/{instrument_id}/fundamentals

Get Instrument Balance Sheet Statements

client.v1.instrumentData.getInstrumentBalanceSheetStatements(InstrumentIDOrSymbolinstrumentID, InstrumentDataGetInstrumentBalanceSheetStatementsParams { from_date, page_size, page_token, to_date } query?, RequestOptionsoptions?): InstrumentDataGetInstrumentBalanceSheetStatementsResponse { data }

GET/v1/instruments/{instrument_id}/balance-sheets

Get Instrument Income Statements

client.v1.instrumentData.getInstrumentIncomeStatements(InstrumentIDOrSymbolinstrumentID, InstrumentDataGetInstrumentIncomeStatementsParams { from_date, page_size, page_token, to_date } query?, RequestOptionsoptions?): InstrumentDataGetInstrumentIncomeStatementsResponse { data }

GET/v1/instruments/{instrument_id}/income-statements

Get Instrument Analyst Consensus

client.v1.instrumentData.getInstrumentAnalystConsensus(InstrumentIDOrSymbolinstrumentID, InstrumentDataGetInstrumentAnalystConsensusParams { from, to } query?, RequestOptionsoptions?): InstrumentDataGetInstrumentAnalystConsensusResponse { data }

GET/v1/instruments/{instrument_id}/analyst-reporting

Get Instrument Cash Flow Statements

client.v1.instrumentData.getInstrumentCashFlowStatements(InstrumentIDOrSymbolinstrumentID, InstrumentDataGetInstrumentCashFlowStatementsParams { from_date, page_size, page_token, to_date } query?, RequestOptionsoptions?): InstrumentDataGetInstrumentCashFlowStatementsResponse { data }

GET/v1/instruments/{instrument_id}/cash-flow-statements

ModelsExpand Collapse

AllEventsEventType = "EARNINGS" | "DIVIDEND" | "STOCK_SPLIT" | "IPO"

Event types supported by the all-events endpoint.

One of the following:

"EARNINGS"

"DIVIDEND"

"STOCK_SPLIT"

"IPO"

AnalystDistribution { buy, hold, sell, 2 more }

Analyst recommendation distribution

buy: number

Number of buy recommendations

formatint64

hold: number

Number of hold recommendations

formatint64

sell: number

Number of sell recommendations

formatint64

strong_buy: number

Number of strong buy recommendations

formatint64

strong_sell: number

Number of strong sell recommendations

formatint64

AnalystRating = "STRONG_BUY" | "BUY" | "HOLD" | 2 more

Analyst rating category

One of the following:

"STRONG_BUY"

"BUY"

"HOLD"

"SELL"

"STRONG_SELL"

FiscalPeriodType = "QUARTERLY" | "ANNUAL" | "TTM" | "BIANNUAL"

Fiscal period type for earnings reports

One of the following:

"QUARTERLY"

"ANNUAL"

"TTM"

"BIANNUAL"

InstrumentAllEventsData { event_dates }

All-events payload grouped by date.

event_dates: Array<InstrumentEventsByDate { date, events } >

Events grouped by date in descending order.

date: string

Event date.

formatdate

events: Array<InstrumentEventEnvelope { symbol, type, dividend_event_data, 6 more } >

Flat event envelopes for this date.

symbol: string

Symbol associated with the event.

type: AllEventsEventType

Event type discriminator.

One of the following:

"EARNINGS"

"DIVIDEND"

"STOCK_SPLIT"

"IPO"

dividend_event_data?: InstrumentDividendEvent { adjusted_dividend_amount, ex_date, declaration_date, 5 more } | null

Dividend payload when type is DIVIDEND.

adjusted_dividend_amount: string

The adjusted dividend amount accounting for any splits.

ex_date: string

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

formatdate

declaration_date?: string | null

The declaration date of the dividend

formatdate

dividend_amount?: string | null

The dividend amount per share.

dividend_yield?: string | null

The dividend yield as a percentage of the stock price.

frequency?: string | null

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”).

payment_date?: string | null

The payment date is the date on which a declared stock dividend is scheduled to be paid.

formatdate

record_date?: string | null

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.

formatdate

earnings_event_data?: InstrumentEarnings { date, eps_actual, eps_estimate, 4 more } | null

Earnings payload when type is EARNINGS.

date: string

The date when the earnings report was published

formatdate

eps_actual?: string | null

The actual earnings per share (EPS) for the period

eps_estimate?: string | null

The estimated earnings per share (EPS) for the period

eps_surprise_percent?: string | null

The percentage difference between actual and estimated EPS

revenue_actual?: string | null

The actual total revenue for the period

revenue_estimate?: string | null

The estimated total revenue for the period

revenue_surprise_percent?: string | null

The percentage difference between actual and estimated revenue

instrument_id?: string | null

OEMS instrument identifier, when the instrument is found in the instrument cache.

formatuuid

ipo_event_data?: InstrumentEventIpoItem { actions, announced_at, company, 4 more } | null

IPO payload when type is IPO.

actions?: string | null

IPO action.

announced_at?: string | null

IPO announced timestamp.

formatdate-time

company?: string | null

IPO company name.

exchange?: string | null

IPO exchange.

market_cap?: string | null

IPO market cap.

price_range?: string | null

IPO price range.

shares?: string | null

IPO shares offered.

name?: string | null

Instrument name associated with the event, when available.

reporting_currency?: string | null

The currency used for reporting financial data.

stock_split_event_data?: InstrumentSplitEvent { date, denominator, numerator, split_type } | null

Stock split payload when type is STOCK_SPLIT.

date: string

The date of the stock split

formatdate

denominator: string

The denominator of the split ratio

numerator: string

The numerator of the split ratio

split_type: string

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

InstrumentAnalystConsensus { date, distribution, price_target, rating }

Aggregated analyst consensus metrics

date: string

The date the consensus snapshot was generated

formatdate

distribution?: AnalystDistribution { buy, hold, sell, 2 more } | null

Count of individual analyst recommendations by category

buy: number

Number of buy recommendations

formatint64

hold: number

Number of hold recommendations

formatint64

sell: number

Number of sell recommendations

formatint64

strong_buy: number

Number of strong buy recommendations

formatint64

strong_sell: number

Number of strong sell recommendations

formatint64

price_target?: PriceTarget { average, currency, high, low } | null

Aggregated analyst price target statistics

average: string

Average analyst price target

currency: string

ISO 4217 currency code of the price targets

high: string

Highest analyst price target

low: string

Lowest analyst price target

rating?: AnalystRating | null

Consensus analyst rating

One of the following:

"STRONG_BUY"

"BUY"

"HOLD"

"SELL"

"STRONG_SELL"

InstrumentBalanceSheetStatement { accepted_date, filing_date, period, 55 more }

A quarterly balance sheet statement for an instrument.

accepted_date: string

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

formatdate-time

filing_date: string

The date the financial statement was filed

formatdate

period: string

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: string

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

year: number

The fiscal year of the statement

formatint32

account_payables?: string | null

Account payables

accounts_receivables?: string | null

Accounts receivables

accrued_expenses?: string | null

Accrued expenses

accumulated_other_comprehensive_income_loss?: string | null

Accumulated other comprehensive income/loss

additional_paid_in_capital?: string | null

Additional paid-in capital

capital_lease_obligations?: string | null

Capital lease obligations (total)

capital_lease_obligations_current?: string | null

Capital lease obligations (current portion)

cash_and_cash_equivalents?: string | null

Cash and cash equivalents

cash_and_short_term_investments?: string | null

Cash and short-term investments combined

common_stock?: string | null

Common stock

deferred_revenue?: string | null

Deferred revenue

deferred_revenue_non_current?: string | null

Deferred revenue (non-current)

deferred_tax_liabilities_non_current?: string | null

Deferred tax liabilities (non-current)

goodwill?: string | null

Goodwill

goodwill_and_intangible_assets?: string | null

Goodwill and intangible assets combined

intangible_assets?: string | null

Intangible assets

inventory?: string | null

Inventory

long_term_debt?: string | null

Long-term debt

long_term_investments?: string | null

Long-term investments

minority_interest?: string | null

Minority interest

net_debt?: string | null

Net debt (total debt minus cash)

net_receivables?: string | null

Net receivables

other_assets?: string | null

Other assets

other_current_assets?: string | null

Other current assets

other_current_liabilities?: string | null

Other current liabilities

other_liabilities?: string | null

Other liabilities

other_non_current_assets?: string | null

Other non-current assets

other_non_current_liabilities?: string | null

Other non-current liabilities

other_payables?: string | null

Other payables

other_receivables?: string | null

Other receivables

other_total_stockholders_equity?: string | null

Other total stockholders equity

preferred_stock?: string | null

Preferred stock

prepaids?: string | null

Prepaids

property_plant_and_equipment_net?: string | null

Property, plant and equipment net of depreciation

retained_earnings?: string | null

Retained earnings

short_term_debt?: string | null

Short-term debt

short_term_investments?: string | null

Short-term investments

tax_assets?: string | null

Tax assets

tax_payables?: string | null

Tax payables

total_assets?: string | null

Total assets

total_current_assets?: string | null

Total current assets

total_current_liabilities?: string | null

Total current liabilities

total_debt?: string | null

Total debt

total_equity?: string | null

Total equity

total_investments?: string | null

Total investments

total_liabilities?: string | null

Total liabilities

total_liabilities_and_total_equity?: string | null

Total liabilities and total equity

total_non_current_assets?: string | null

Total non-current assets

total_non_current_liabilities?: string | null

Total non-current liabilities

total_payables?: string | null

Total payables

total_stockholders_equity?: string | null

Total stockholders equity

treasury_stock?: string | null

Treasury stock

InstrumentBalanceSheetStatementList = Array<InstrumentBalanceSheetStatement { accepted_date, filing_date, period, 55 more } >

accepted_date: string

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

formatdate-time

filing_date: string

The date the financial statement was filed

formatdate

period: string

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: string

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

year: number

The fiscal year of the statement

formatint32

account_payables?: string | null

Account payables

accounts_receivables?: string | null

Accounts receivables

accrued_expenses?: string | null

Accrued expenses

accumulated_other_comprehensive_income_loss?: string | null

Accumulated other comprehensive income/loss

additional_paid_in_capital?: string | null

Additional paid-in capital

capital_lease_obligations?: string | null

Capital lease obligations (total)

capital_lease_obligations_current?: string | null

Capital lease obligations (current portion)

cash_and_cash_equivalents?: string | null

Cash and cash equivalents

cash_and_short_term_investments?: string | null

Cash and short-term investments combined

common_stock?: string | null

Common stock

deferred_revenue?: string | null

Deferred revenue

deferred_revenue_non_current?: string | null

Deferred revenue (non-current)

deferred_tax_liabilities_non_current?: string | null

Deferred tax liabilities (non-current)

goodwill?: string | null

Goodwill

goodwill_and_intangible_assets?: string | null

Goodwill and intangible assets combined

intangible_assets?: string | null

Intangible assets

inventory?: string | null

Inventory

long_term_debt?: string | null

Long-term debt

long_term_investments?: string | null

Long-term investments

minority_interest?: string | null

Minority interest

net_debt?: string | null

Net debt (total debt minus cash)

net_receivables?: string | null

Net receivables

other_assets?: string | null

Other assets

other_current_assets?: string | null

Other current assets

other_current_liabilities?: string | null

Other current liabilities

other_liabilities?: string | null

Other liabilities

other_non_current_assets?: string | null

Other non-current assets

other_non_current_liabilities?: string | null

Other non-current liabilities

other_payables?: string | null

Other payables

other_receivables?: string | null

Other receivables

other_total_stockholders_equity?: string | null

Other total stockholders equity

preferred_stock?: string | null

Preferred stock

prepaids?: string | null

Prepaids

property_plant_and_equipment_net?: string | null

Property, plant and equipment net of depreciation

retained_earnings?: string | null

Retained earnings

short_term_debt?: string | null

Short-term debt

short_term_investments?: string | null

Short-term investments

tax_assets?: string | null

Tax assets

tax_payables?: string | null

Tax payables

total_assets?: string | null

Total assets

total_current_assets?: string | null

Total current assets

total_current_liabilities?: string | null

Total current liabilities

total_debt?: string | null

Total debt

total_equity?: string | null

Total equity

total_investments?: string | null

Total investments

total_liabilities?: string | null

Total liabilities

total_liabilities_and_total_equity?: string | null

Total liabilities and total equity

total_non_current_assets?: string | null

Total non-current assets

total_non_current_liabilities?: string | null

Total non-current liabilities

total_payables?: string | null

Total payables

total_stockholders_equity?: string | null

Total stockholders equity

treasury_stock?: string | null

Treasury stock

InstrumentCashFlowStatement { accepted_date, filing_date, period, 42 more }

A quarterly cash flow statement for an instrument.

accepted_date: string

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

formatdate-time

filing_date: string

The date the financial statement was filed

formatdate

period: string

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: string

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

year: number

The fiscal year of the statement

formatint32

accounts_payables?: string | null

Change in accounts payables

accounts_receivables?: string | null

Change in accounts receivables

acquisitions_net?: string | null

Net acquisitions

capital_expenditure?: string | null

Capital expenditure

cash_at_beginning_of_period?: string | null

Cash and cash equivalents at beginning of period

cash_at_end_of_period?: string | null

Cash and cash equivalents at end of period

change_in_working_capital?: string | null

Change in working capital

common_dividends_paid?: string | null

Common dividends paid

common_stock_issuance?: string | null

Common stock issuance

common_stock_repurchased?: string | null

Common stock repurchased (buybacks)

deferred_income_tax?: string | null

Deferred income tax expense

depreciation_and_amortization?: string | null

Depreciation and amortization expense

effect_of_forex_changes_on_cash?: string | null

Effect of foreign exchange changes on cash

free_cash_flow?: string | null

Free cash flow (operating cash flow minus capital expenditure)

income_taxes_paid?: string | null

Income taxes paid

interest_paid?: string | null

Interest paid

inventory?: string | null

Change in inventory

investments_in_property_plant_and_equipment?: string | null

Investments in property, plant, and equipment

long_term_net_debt_issuance?: string | null

Long-term net debt issuance

net_cash_provided_by_financing_activities?: string | null

Net cash provided by financing activities

net_cash_provided_by_investing_activities?: string | null

Net cash provided by investing activities

net_cash_provided_by_operating_activities?: string | null

Net cash provided by operating activities

net_change_in_cash?: string | null

Net change in cash during the period

net_common_stock_issuance?: string | null

Net common stock issuance

net_debt_issuance?: string | null

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

net_dividends_paid?: string | null

Net dividends paid (common + preferred)

net_income?: string | null

Net income for the period

net_preferred_stock_issuance?: string | null

Net preferred stock issuance

net_stock_issuance?: string | null

Net stock issuance (common + preferred)

operating_cash_flow?: string | null

Operating cash flow (alternative calculation)

other_financing_activities?: string | null

Other financing activities

other_investing_activities?: string | null

Other investing activities

other_non_cash_items?: string | null

Other non-cash items

other_working_capital?: string | null

Change in other working capital

preferred_dividends_paid?: string | null

Preferred dividends paid

purchases_of_investments?: string | null

Purchases of investments

sales_maturities_of_investments?: string | null

Sales and maturities of investments

short_term_net_debt_issuance?: string | null

Short-term net debt issuance

stock_based_compensation?: string | null

Stock-based compensation expense

InstrumentCashFlowStatementList = Array<InstrumentCashFlowStatement { accepted_date, filing_date, period, 42 more } >

accepted_date: string

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

formatdate-time

filing_date: string

The date the financial statement was filed

formatdate

period: string

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: string

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

year: number

The fiscal year of the statement

formatint32

accounts_payables?: string | null

Change in accounts payables

accounts_receivables?: string | null

Change in accounts receivables

acquisitions_net?: string | null

Net acquisitions

capital_expenditure?: string | null

Capital expenditure

cash_at_beginning_of_period?: string | null

Cash and cash equivalents at beginning of period

cash_at_end_of_period?: string | null

Cash and cash equivalents at end of period

change_in_working_capital?: string | null

Change in working capital

common_dividends_paid?: string | null

Common dividends paid

common_stock_issuance?: string | null

Common stock issuance

common_stock_repurchased?: string | null

Common stock repurchased (buybacks)

deferred_income_tax?: string | null

Deferred income tax expense

depreciation_and_amortization?: string | null

Depreciation and amortization expense

effect_of_forex_changes_on_cash?: string | null

Effect of foreign exchange changes on cash

free_cash_flow?: string | null

Free cash flow (operating cash flow minus capital expenditure)

income_taxes_paid?: string | null

Income taxes paid

interest_paid?: string | null

Interest paid

inventory?: string | null

Change in inventory

investments_in_property_plant_and_equipment?: string | null

Investments in property, plant, and equipment

long_term_net_debt_issuance?: string | null

Long-term net debt issuance

net_cash_provided_by_financing_activities?: string | null

Net cash provided by financing activities

net_cash_provided_by_investing_activities?: string | null

Net cash provided by investing activities

net_cash_provided_by_operating_activities?: string | null

Net cash provided by operating activities

net_change_in_cash?: string | null

Net change in cash during the period

net_common_stock_issuance?: string | null

Net common stock issuance

net_debt_issuance?: string | null

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

net_dividends_paid?: string | null

Net dividends paid (common + preferred)

net_income?: string | null

Net income for the period

net_preferred_stock_issuance?: string | null

Net preferred stock issuance

net_stock_issuance?: string | null

Net stock issuance (common + preferred)

operating_cash_flow?: string | null

Operating cash flow (alternative calculation)

other_financing_activities?: string | null

Other financing activities

other_investing_activities?: string | null

Other investing activities

other_non_cash_items?: string | null

Other non-cash items

other_working_capital?: string | null

Change in other working capital

preferred_dividends_paid?: string | null

Preferred dividends paid

purchases_of_investments?: string | null

Purchases of investments

sales_maturities_of_investments?: string | null

Sales and maturities of investments

short_term_net_debt_issuance?: string | null

Short-term net debt issuance

stock_based_compensation?: string | null

Stock-based compensation expense

InstrumentDividendEvent { adjusted_dividend_amount, ex_date, declaration_date, 5 more }

Represents a dividend event for an instrument

adjusted_dividend_amount: string

The adjusted dividend amount accounting for any splits.

ex_date: string

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

formatdate

declaration_date?: string | null

The declaration date of the dividend

formatdate

dividend_amount?: string | null

The dividend amount per share.

dividend_yield?: string | null

The dividend yield as a percentage of the stock price.

frequency?: string | null

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”).

payment_date?: string | null

The payment date is the date on which a declared stock dividend is scheduled to be paid.

formatdate

record_date?: string | null

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.

formatdate

InstrumentEarnings { date, eps_actual, eps_estimate, 4 more }

Represents instrument earnings data

date: string

The date when the earnings report was published

formatdate

eps_actual?: string | null

The actual earnings per share (EPS) for the period

eps_estimate?: string | null

The estimated earnings per share (EPS) for the period

eps_surprise_percent?: string | null

The percentage difference between actual and estimated EPS

revenue_actual?: string | null

The actual total revenue for the period

revenue_estimate?: string | null

The estimated total revenue for the period

revenue_surprise_percent?: string | null

The percentage difference between actual and estimated revenue

InstrumentEventEnvelope { symbol, type, dividend_event_data, 6 more }

Unified envelope for the all-events response.

symbol: string

Symbol associated with the event.

type: AllEventsEventType

Event type discriminator.

One of the following:

"EARNINGS"

"DIVIDEND"

"STOCK_SPLIT"

"IPO"

dividend_event_data?: InstrumentDividendEvent { adjusted_dividend_amount, ex_date, declaration_date, 5 more } | null

Dividend payload when type is DIVIDEND.

adjusted_dividend_amount: string

The adjusted dividend amount accounting for any splits.

ex_date: string

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

formatdate

declaration_date?: string | null

The declaration date of the dividend

formatdate

dividend_amount?: string | null

The dividend amount per share.

dividend_yield?: string | null

The dividend yield as a percentage of the stock price.

frequency?: string | null

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”).

payment_date?: string | null

The payment date is the date on which a declared stock dividend is scheduled to be paid.

formatdate

record_date?: string | null

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.

formatdate

earnings_event_data?: InstrumentEarnings { date, eps_actual, eps_estimate, 4 more } | null

Earnings payload when type is EARNINGS.

date: string

The date when the earnings report was published

formatdate

eps_actual?: string | null

The actual earnings per share (EPS) for the period

eps_estimate?: string | null

The estimated earnings per share (EPS) for the period

eps_surprise_percent?: string | null

The percentage difference between actual and estimated EPS

revenue_actual?: string | null

The actual total revenue for the period

revenue_estimate?: string | null

The estimated total revenue for the period

revenue_surprise_percent?: string | null

The percentage difference between actual and estimated revenue

instrument_id?: string | null

OEMS instrument identifier, when the instrument is found in the instrument cache.

formatuuid

ipo_event_data?: InstrumentEventIpoItem { actions, announced_at, company, 4 more } | null

IPO payload when type is IPO.

actions?: string | null

IPO action.

announced_at?: string | null

IPO announced timestamp.

formatdate-time

company?: string | null

IPO company name.

exchange?: string | null

IPO exchange.

market_cap?: string | null

IPO market cap.

price_range?: string | null

IPO price range.

shares?: string | null

IPO shares offered.

name?: string | null

Instrument name associated with the event, when available.

reporting_currency?: string | null

The currency used for reporting financial data.

stock_split_event_data?: InstrumentSplitEvent { date, denominator, numerator, split_type } | null

Stock split payload when type is STOCK_SPLIT.

date: string

The date of the stock split

formatdate

denominator: string

The denominator of the split ratio

numerator: string

The numerator of the split ratio

split_type: string

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

InstrumentEventIpoItem { actions, announced_at, company, 4 more }

IPO event in the all-events date grouping response.

actions?: string | null

IPO action.

announced_at?: string | null

IPO announced timestamp.

formatdate-time

company?: string | null

IPO company name.

exchange?: string | null

IPO exchange.

market_cap?: string | null

IPO market cap.

price_range?: string | null

IPO price range.

shares?: string | null

IPO shares offered.

InstrumentEventsByDate { date, events }

Instrument events for a single date.

date: string

Event date.

formatdate

events: Array<InstrumentEventEnvelope { symbol, type, dividend_event_data, 6 more } >

Flat event envelopes for this date.

symbol: string

Symbol associated with the event.

type: AllEventsEventType

Event type discriminator.

One of the following:

"EARNINGS"

"DIVIDEND"

"STOCK_SPLIT"

"IPO"

dividend_event_data?: InstrumentDividendEvent { adjusted_dividend_amount, ex_date, declaration_date, 5 more } | null

Dividend payload when type is DIVIDEND.

adjusted_dividend_amount: string

The adjusted dividend amount accounting for any splits.

ex_date: string

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

formatdate

declaration_date?: string | null

The declaration date of the dividend

formatdate

dividend_amount?: string | null

The dividend amount per share.

dividend_yield?: string | null

The dividend yield as a percentage of the stock price.

frequency?: string | null

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”).

payment_date?: string | null

The payment date is the date on which a declared stock dividend is scheduled to be paid.

formatdate

record_date?: string | null

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.

formatdate

earnings_event_data?: InstrumentEarnings { date, eps_actual, eps_estimate, 4 more } | null

Earnings payload when type is EARNINGS.

date: string

The date when the earnings report was published

formatdate

eps_actual?: string | null

The actual earnings per share (EPS) for the period

eps_estimate?: string | null

The estimated earnings per share (EPS) for the period

eps_surprise_percent?: string | null

The percentage difference between actual and estimated EPS

revenue_actual?: string | null

The actual total revenue for the period

revenue_estimate?: string | null

The estimated total revenue for the period

revenue_surprise_percent?: string | null

The percentage difference between actual and estimated revenue

instrument_id?: string | null

OEMS instrument identifier, when the instrument is found in the instrument cache.

formatuuid

ipo_event_data?: InstrumentEventIpoItem { actions, announced_at, company, 4 more } | null

IPO payload when type is IPO.

actions?: string | null

IPO action.

announced_at?: string | null

IPO announced timestamp.

formatdate-time

company?: string | null

IPO company name.

exchange?: string | null

IPO exchange.

market_cap?: string | null

IPO market cap.

price_range?: string | null

IPO price range.

shares?: string | null

IPO shares offered.

name?: string | null

Instrument name associated with the event, when available.

reporting_currency?: string | null

The currency used for reporting financial data.

stock_split_event_data?: InstrumentSplitEvent { date, denominator, numerator, split_type } | null

Stock split payload when type is STOCK_SPLIT.

date: string

The date of the stock split

formatdate

denominator: string

The denominator of the split ratio

numerator: string

The numerator of the split ratio

split_type: string

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

InstrumentEventsData { dividends, earnings, instrument_id, 2 more }

Grouped instrument events by type

dividends: Array<InstrumentDividendEvent { adjusted_dividend_amount, ex_date, declaration_date, 5 more } >

Dividend distribution events

adjusted_dividend_amount: string

The adjusted dividend amount accounting for any splits.

ex_date: string

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

formatdate

declaration_date?: string | null

The declaration date of the dividend

formatdate

dividend_amount?: string | null

The dividend amount per share.

dividend_yield?: string | null

The dividend yield as a percentage of the stock price.

frequency?: string | null

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”).

payment_date?: string | null

The payment date is the date on which a declared stock dividend is scheduled to be paid.

formatdate

record_date?: string | null

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.

formatdate

earnings: Array<InstrumentEarnings { date, eps_actual, eps_estimate, 4 more } >

Earnings announcement events

date: string

The date when the earnings report was published

formatdate

eps_actual?: string | null

The actual earnings per share (EPS) for the period

eps_estimate?: string | null

The estimated earnings per share (EPS) for the period

eps_surprise_percent?: string | null

The percentage difference between actual and estimated EPS

revenue_actual?: string | null

The actual total revenue for the period

revenue_estimate?: string | null

The estimated total revenue for the period

revenue_surprise_percent?: string | null

The percentage difference between actual and estimated revenue

instrument_id: string

OEMS instrument UUID from the request

formatuuid

splits: Array<InstrumentSplitEvent { date, denominator, numerator, split_type } >

Stock split events

date: string

The date of the stock split

formatdate

denominator: string

The denominator of the split ratio

numerator: string

The numerator of the split ratio

split_type: string

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

reporting_currency?: string | null

The currency used for reporting financial data

InstrumentFundamentals { average_volume, beta, description, 12 more }

Supplemental fundamentals and company profile data for an instrument.

average_volume?: number | null

The average daily trading volume over the past 30 days

formatint64

beta?: string | null

The beta value, measuring the instrument’s volatility relative to the overall market

description?: string | null

A detailed description of the instrument or company

dividend_yield?: string | null

The trailing twelve months (TTM) dividend yield

earnings_per_share?: string | null

The trailing twelve months (TTM) earnings per share

fifty_two_week_high?: string | null

The highest price over the last 52 weeks

fifty_two_week_low?: string | null

The lowest price over the last 52 weeks

industry?: string | null

The specific industry of the instrument’s issuer

list_date?: string | null

The date the instrument was first listed

formatdate

logo_url?: string | null

URL to a representative logo image for the instrument or issuer

market_cap?: string | null

The total market capitalization

previous_close?: string | null

The closing price from the previous trading day

price_to_earnings?: string | null

The price-to-earnings (P/E) ratio for the trailing twelve months (TTM)

reporting_currency?: string | null

The currency used for reporting financial data

sector?: string | null

The business sector of the instrument’s issuer

InstrumentIncomeStatement { accepted_date, filing_date, period, 34 more }

A quarterly income statement for an instrument.

accepted_date: string

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

formatdate-time

filing_date: string

The date the financial statement was filed

formatdate

period: string

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: string

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

year: number

The fiscal year of the statement

formatint32

bottom_line_net_income?: string | null

Bottom line net income after all adjustments

cost_and_expenses?: string | null

Total costs and expenses

cost_of_revenue?: string | null

Direct costs attributable to producing goods sold

depreciation_and_amortization?: string | null

Depreciation and amortization expenses

ebit?: string | null

Earnings before interest and taxes

ebitda?: string | null

Earnings before interest, taxes, depreciation, and amortization

eps?: string | null

Basic earnings per share

eps_diluted?: string | null

Diluted earnings per share

general_and_administrative_expenses?: string | null

General administrative overhead expenses

gross_profit?: string | null

Revenue minus cost of revenue

income_before_tax?: string | null

Income before income tax expense

income_tax_expense?: string | null

Income tax expense for the period

interest_expense?: string | null

Interest paid on debt

interest_income?: string | null

Interest earned on investments and cash

net_income?: string | null

Total net income for the period

net_income_deductions?: string | null

Deductions from net income

net_income_from_continuing_operations?: string | null

Net income from continuing operations

net_income_from_discontinued_operations?: string | null

Net income from discontinued operations

net_interest_income?: string | null

Net interest income (interest income minus interest expense)

non_operating_income_excluding_interest?: string | null

Non-operating income excluding interest

operating_expenses?: string | null

Total operating expenses

operating_income?: string | null

Income from core business operations

other_adjustments_to_net_income?: string | null

Other adjustments to net income

other_expenses?: string | null

Other miscellaneous expenses

research_and_development_expenses?: string | null

Expenditure on research and development activities

revenue?: string | null

Total revenue from sales of goods and services

selling_and_marketing_expenses?: string | null

Expenditure on marketing and sales activities

selling_general_and_administrative_expenses?: string | null

Combined selling, general, and administrative expenses

total_other_income_expenses_net?: string | null

Net of other income and expenses

weighted_average_shs_out?: string | null

Weighted average shares outstanding (basic)

weighted_average_shs_out_dil?: string | null

Weighted average shares outstanding (diluted)

InstrumentIncomeStatementList = Array<InstrumentIncomeStatement { accepted_date, filing_date, period, 34 more } >

accepted_date: string

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

formatdate-time

filing_date: string

The date the financial statement was filed

formatdate

period: string

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: string

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

year: number

The fiscal year of the statement

formatint32

bottom_line_net_income?: string | null

Bottom line net income after all adjustments

cost_and_expenses?: string | null

Total costs and expenses

cost_of_revenue?: string | null

Direct costs attributable to producing goods sold

depreciation_and_amortization?: string | null

Depreciation and amortization expenses

ebit?: string | null

Earnings before interest and taxes

ebitda?: string | null

Earnings before interest, taxes, depreciation, and amortization

eps?: string | null

Basic earnings per share

eps_diluted?: string | null

Diluted earnings per share

general_and_administrative_expenses?: string | null

General administrative overhead expenses

gross_profit?: string | null

Revenue minus cost of revenue

income_before_tax?: string | null

Income before income tax expense

income_tax_expense?: string | null

Income tax expense for the period

interest_expense?: string | null

Interest paid on debt

interest_income?: string | null

Interest earned on investments and cash

net_income?: string | null

Total net income for the period

net_income_deductions?: string | null

Deductions from net income

net_income_from_continuing_operations?: string | null

Net income from continuing operations

net_income_from_discontinued_operations?: string | null

Net income from discontinued operations

net_interest_income?: string | null

Net interest income (interest income minus interest expense)

non_operating_income_excluding_interest?: string | null

Non-operating income excluding interest

operating_expenses?: string | null

Total operating expenses

operating_income?: string | null

Income from core business operations

other_adjustments_to_net_income?: string | null

Other adjustments to net income

other_expenses?: string | null

Other miscellaneous expenses

research_and_development_expenses?: string | null

Expenditure on research and development activities

revenue?: string | null

Total revenue from sales of goods and services

selling_and_marketing_expenses?: string | null

Expenditure on marketing and sales activities

selling_general_and_administrative_expenses?: string | null

Combined selling, general, and administrative expenses

total_other_income_expenses_net?: string | null

Net of other income and expenses

weighted_average_shs_out?: string | null

Weighted average shares outstanding (basic)

weighted_average_shs_out_dil?: string | null

Weighted average shares outstanding (diluted)

InstrumentSplitEvent { date, denominator, numerator, split_type }

Represents a stock split event for an instrument

date: string

The date of the stock split

formatdate

denominator: string

The denominator of the split ratio

numerator: string

The numerator of the split ratio

split_type: string

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

PriceTarget { average, currency, high, low }

Analyst price target statistics

average: string

Average analyst price target

currency: string

ISO 4217 currency code of the price targets

high: string

Highest analyst price target

low: string

Lowest analyst price target

InstrumentDataGetAllInstrumentEventsResponse extends BaseResponse { metadata, error } { data }

data: InstrumentAllEventsData { event_dates }

All-events payload grouped by date.

event_dates: Array<InstrumentEventsByDate { date, events } >

Events grouped by date in descending order.

date: string

Event date.

formatdate

events: Array<InstrumentEventEnvelope { symbol, type, dividend_event_data, 6 more } >

Flat event envelopes for this date.

symbol: string

Symbol associated with the event.

type: AllEventsEventType

Event type discriminator.

One of the following:

"EARNINGS"

"DIVIDEND"

"STOCK_SPLIT"

"IPO"

dividend_event_data?: InstrumentDividendEvent { adjusted_dividend_amount, ex_date, declaration_date, 5 more } | null

Dividend payload when type is DIVIDEND.

adjusted_dividend_amount: string

The adjusted dividend amount accounting for any splits.

ex_date: string

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

formatdate

declaration_date?: string | null

The declaration date of the dividend

formatdate

dividend_amount?: string | null

The dividend amount per share.

dividend_yield?: string | null

The dividend yield as a percentage of the stock price.

frequency?: string | null

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”).

payment_date?: string | null

The payment date is the date on which a declared stock dividend is scheduled to be paid.

formatdate

record_date?: string | null

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.

formatdate

earnings_event_data?: InstrumentEarnings { date, eps_actual, eps_estimate, 4 more } | null

Earnings payload when type is EARNINGS.

date: string

The date when the earnings report was published

formatdate

eps_actual?: string | null

The actual earnings per share (EPS) for the period

eps_estimate?: string | null

The estimated earnings per share (EPS) for the period

eps_surprise_percent?: string | null

The percentage difference between actual and estimated EPS

revenue_actual?: string | null

The actual total revenue for the period

revenue_estimate?: string | null

The estimated total revenue for the period

revenue_surprise_percent?: string | null

The percentage difference between actual and estimated revenue

instrument_id?: string | null

OEMS instrument identifier, when the instrument is found in the instrument cache.

formatuuid

ipo_event_data?: InstrumentEventIpoItem { actions, announced_at, company, 4 more } | null

IPO payload when type is IPO.

actions?: string | null

IPO action.

announced_at?: string | null

IPO announced timestamp.

formatdate-time

company?: string | null

IPO company name.

exchange?: string | null

IPO exchange.

market_cap?: string | null

IPO market cap.

price_range?: string | null

IPO price range.

shares?: string | null

IPO shares offered.

name?: string | null

Instrument name associated with the event, when available.

reporting_currency?: string | null

The currency used for reporting financial data.

stock_split_event_data?: InstrumentSplitEvent { date, denominator, numerator, split_type } | null

Stock split payload when type is STOCK_SPLIT.

date: string

The date of the stock split

formatdate

denominator: string

The denominator of the split ratio

numerator: string

The numerator of the split ratio

split_type: string

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

InstrumentDataGetInstrumentEventsResponse extends BaseResponse { metadata, error } { data }

data: InstrumentEventsData { dividends, earnings, instrument_id, 2 more }

Grouped instrument events by type

dividends: Array<InstrumentDividendEvent { adjusted_dividend_amount, ex_date, declaration_date, 5 more } >

Dividend distribution events

adjusted_dividend_amount: string

The adjusted dividend amount accounting for any splits.

ex_date: string

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

formatdate

declaration_date?: string | null

The declaration date of the dividend

formatdate

dividend_amount?: string | null

The dividend amount per share.

dividend_yield?: string | null

The dividend yield as a percentage of the stock price.

frequency?: string | null

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”).

payment_date?: string | null

The payment date is the date on which a declared stock dividend is scheduled to be paid.

formatdate

record_date?: string | null

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.

formatdate

earnings: Array<InstrumentEarnings { date, eps_actual, eps_estimate, 4 more } >

Earnings announcement events

date: string

The date when the earnings report was published

formatdate

eps_actual?: string | null

The actual earnings per share (EPS) for the period

eps_estimate?: string | null

The estimated earnings per share (EPS) for the period

eps_surprise_percent?: string | null

The percentage difference between actual and estimated EPS

revenue_actual?: string | null

The actual total revenue for the period

revenue_estimate?: string | null

The estimated total revenue for the period

revenue_surprise_percent?: string | null

The percentage difference between actual and estimated revenue

instrument_id: string

OEMS instrument UUID from the request

formatuuid

splits: Array<InstrumentSplitEvent { date, denominator, numerator, split_type } >

Stock split events

date: string

The date of the stock split

formatdate

denominator: string

The denominator of the split ratio

numerator: string

The numerator of the split ratio

split_type: string

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

reporting_currency?: string | null

The currency used for reporting financial data

InstrumentDataGetInstrumentFundamentalsResponse extends BaseResponse { metadata, error } { data }

data: InstrumentFundamentals { average_volume, beta, description, 12 more }

Supplemental fundamentals and company profile data for an instrument.

average_volume?: number | null

The average daily trading volume over the past 30 days

formatint64

beta?: string | null

The beta value, measuring the instrument’s volatility relative to the overall market

description?: string | null

A detailed description of the instrument or company

dividend_yield?: string | null

The trailing twelve months (TTM) dividend yield

earnings_per_share?: string | null

The trailing twelve months (TTM) earnings per share

fifty_two_week_high?: string | null

The highest price over the last 52 weeks

fifty_two_week_low?: string | null

The lowest price over the last 52 weeks

industry?: string | null

The specific industry of the instrument’s issuer

list_date?: string | null

The date the instrument was first listed

formatdate

logo_url?: string | null

URL to a representative logo image for the instrument or issuer

market_cap?: string | null

The total market capitalization

previous_close?: string | null

The closing price from the previous trading day

price_to_earnings?: string | null

The price-to-earnings (P/E) ratio for the trailing twelve months (TTM)

reporting_currency?: string | null

The currency used for reporting financial data

sector?: string | null

The business sector of the instrument’s issuer

InstrumentDataGetInstrumentBalanceSheetStatementsResponse extends BaseResponse { metadata, error } { data }

data: InstrumentBalanceSheetStatementList { accepted_date, filing_date, period, 55 more }

accepted_date: string

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

formatdate-time

filing_date: string

The date the financial statement was filed

formatdate

period: string

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: string

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

year: number

The fiscal year of the statement

formatint32

account_payables?: string | null

Account payables

accounts_receivables?: string | null

Accounts receivables

accrued_expenses?: string | null

Accrued expenses

accumulated_other_comprehensive_income_loss?: string | null

Accumulated other comprehensive income/loss

additional_paid_in_capital?: string | null

Additional paid-in capital

capital_lease_obligations?: string | null

Capital lease obligations (total)

capital_lease_obligations_current?: string | null

Capital lease obligations (current portion)

cash_and_cash_equivalents?: string | null

Cash and cash equivalents

cash_and_short_term_investments?: string | null

Cash and short-term investments combined

common_stock?: string | null

Common stock

deferred_revenue?: string | null

Deferred revenue

deferred_revenue_non_current?: string | null

Deferred revenue (non-current)

deferred_tax_liabilities_non_current?: string | null

Deferred tax liabilities (non-current)

goodwill?: string | null

Goodwill

goodwill_and_intangible_assets?: string | null

Goodwill and intangible assets combined

intangible_assets?: string | null

Intangible assets

inventory?: string | null

Inventory

long_term_debt?: string | null

Long-term debt

long_term_investments?: string | null

Long-term investments

minority_interest?: string | null

Minority interest

net_debt?: string | null

Net debt (total debt minus cash)

net_receivables?: string | null

Net receivables

other_assets?: string | null

Other assets

other_current_assets?: string | null

Other current assets

other_current_liabilities?: string | null

Other current liabilities

other_liabilities?: string | null

Other liabilities

other_non_current_assets?: string | null

Other non-current assets

other_non_current_liabilities?: string | null

Other non-current liabilities

other_payables?: string | null

Other payables

other_receivables?: string | null

Other receivables

other_total_stockholders_equity?: string | null

Other total stockholders equity

preferred_stock?: string | null

Preferred stock

prepaids?: string | null

Prepaids

property_plant_and_equipment_net?: string | null

Property, plant and equipment net of depreciation

retained_earnings?: string | null

Retained earnings

short_term_debt?: string | null

Short-term debt

short_term_investments?: string | null

Short-term investments

tax_assets?: string | null

Tax assets

tax_payables?: string | null

Tax payables

total_assets?: string | null

Total assets

total_current_assets?: string | null

Total current assets

total_current_liabilities?: string | null

Total current liabilities

total_debt?: string | null

Total debt

total_equity?: string | null

Total equity

total_investments?: string | null

Total investments

total_liabilities?: string | null

Total liabilities

total_liabilities_and_total_equity?: string | null

Total liabilities and total equity

total_non_current_assets?: string | null

Total non-current assets

total_non_current_liabilities?: string | null

Total non-current liabilities

total_payables?: string | null

Total payables

total_stockholders_equity?: string | null

Total stockholders equity

treasury_stock?: string | null

Treasury stock

InstrumentDataGetInstrumentIncomeStatementsResponse extends BaseResponse { metadata, error } { data }

data: InstrumentIncomeStatementList { accepted_date, filing_date, period, 34 more }

accepted_date: string

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

formatdate-time

filing_date: string

The date the financial statement was filed

formatdate

period: string

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: string

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

year: number

The fiscal year of the statement

formatint32

bottom_line_net_income?: string | null

Bottom line net income after all adjustments

cost_and_expenses?: string | null

Total costs and expenses

cost_of_revenue?: string | null

Direct costs attributable to producing goods sold

depreciation_and_amortization?: string | null

Depreciation and amortization expenses

ebit?: string | null

Earnings before interest and taxes

ebitda?: string | null

Earnings before interest, taxes, depreciation, and amortization

eps?: string | null

Basic earnings per share

eps_diluted?: string | null

Diluted earnings per share

general_and_administrative_expenses?: string | null

General administrative overhead expenses

gross_profit?: string | null

Revenue minus cost of revenue

income_before_tax?: string | null

Income before income tax expense

income_tax_expense?: string | null

Income tax expense for the period

interest_expense?: string | null

Interest paid on debt

interest_income?: string | null

Interest earned on investments and cash

net_income?: string | null

Total net income for the period

net_income_deductions?: string | null

Deductions from net income

net_income_from_continuing_operations?: string | null

Net income from continuing operations

net_income_from_discontinued_operations?: string | null

Net income from discontinued operations

net_interest_income?: string | null

Net interest income (interest income minus interest expense)

non_operating_income_excluding_interest?: string | null

Non-operating income excluding interest

operating_expenses?: string | null

Total operating expenses

operating_income?: string | null

Income from core business operations

other_adjustments_to_net_income?: string | null

Other adjustments to net income

other_expenses?: string | null

Other miscellaneous expenses

research_and_development_expenses?: string | null

Expenditure on research and development activities

revenue?: string | null

Total revenue from sales of goods and services

selling_and_marketing_expenses?: string | null

Expenditure on marketing and sales activities

selling_general_and_administrative_expenses?: string | null

Combined selling, general, and administrative expenses

total_other_income_expenses_net?: string | null

Net of other income and expenses

weighted_average_shs_out?: string | null

Weighted average shares outstanding (basic)

weighted_average_shs_out_dil?: string | null

Weighted average shares outstanding (diluted)

InstrumentDataGetInstrumentAnalystConsensusResponse extends BaseResponse { metadata, error } { data }

data: InstrumentAnalystConsensus { date, distribution, price_target, rating }

Aggregated analyst consensus metrics

date: string

The date the consensus snapshot was generated

formatdate

distribution?: AnalystDistribution { buy, hold, sell, 2 more } | null

Count of individual analyst recommendations by category

buy: number

Number of buy recommendations

formatint64

hold: number

Number of hold recommendations

formatint64

sell: number

Number of sell recommendations

formatint64

strong_buy: number

Number of strong buy recommendations

formatint64

strong_sell: number

Number of strong sell recommendations

formatint64

price_target?: PriceTarget { average, currency, high, low } | null

Aggregated analyst price target statistics

average: string

Average analyst price target

currency: string

ISO 4217 currency code of the price targets

high: string

Highest analyst price target

low: string

Lowest analyst price target

rating?: AnalystRating | null

Consensus analyst rating

One of the following:

"STRONG_BUY"

"BUY"

"HOLD"

"SELL"

"STRONG_SELL"

InstrumentDataGetInstrumentCashFlowStatementsResponse extends BaseResponse { metadata, error } { data }

data: InstrumentCashFlowStatementList { accepted_date, filing_date, period, 42 more }

accepted_date: string

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

formatdate-time

filing_date: string

The date the financial statement was filed

formatdate

period: string

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: string

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

year: number

The fiscal year of the statement

formatint32

accounts_payables?: string | null

Change in accounts payables

accounts_receivables?: string | null

Change in accounts receivables

acquisitions_net?: string | null

Net acquisitions

capital_expenditure?: string | null

Capital expenditure

cash_at_beginning_of_period?: string | null

Cash and cash equivalents at beginning of period

cash_at_end_of_period?: string | null

Cash and cash equivalents at end of period

change_in_working_capital?: string | null

Change in working capital

common_dividends_paid?: string | null

Common dividends paid

common_stock_issuance?: string | null

Common stock issuance

common_stock_repurchased?: string | null

Common stock repurchased (buybacks)

deferred_income_tax?: string | null

Deferred income tax expense

depreciation_and_amortization?: string | null

Depreciation and amortization expense

effect_of_forex_changes_on_cash?: string | null

Effect of foreign exchange changes on cash

free_cash_flow?: string | null

Free cash flow (operating cash flow minus capital expenditure)

income_taxes_paid?: string | null

Income taxes paid

interest_paid?: string | null

Interest paid

inventory?: string | null

Change in inventory

investments_in_property_plant_and_equipment?: string | null

Investments in property, plant, and equipment

long_term_net_debt_issuance?: string | null

Long-term net debt issuance

net_cash_provided_by_financing_activities?: string | null

Net cash provided by financing activities

net_cash_provided_by_investing_activities?: string | null

Net cash provided by investing activities

net_cash_provided_by_operating_activities?: string | null

Net cash provided by operating activities

net_change_in_cash?: string | null

Net change in cash during the period

net_common_stock_issuance?: string | null

Net common stock issuance

net_debt_issuance?: string | null

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

net_dividends_paid?: string | null

Net dividends paid (common + preferred)

net_income?: string | null

Net income for the period

net_preferred_stock_issuance?: string | null

Net preferred stock issuance

net_stock_issuance?: string | null

Net stock issuance (common + preferred)

operating_cash_flow?: string | null

Operating cash flow (alternative calculation)

other_financing_activities?: string | null

Other financing activities

other_investing_activities?: string | null

Other investing activities

other_non_cash_items?: string | null

Other non-cash items

other_working_capital?: string | null

Change in other working capital

preferred_dividends_paid?: string | null

Preferred dividends paid

purchases_of_investments?: string | null

Purchases of investments

sales_maturities_of_investments?: string | null

Sales and maturities of investments

short_term_net_debt_issuance?: string | null

Short-term net debt issuance

stock_based_compensation?: string | null

Stock-based compensation expense

Instrument DataMarket Data

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

Get Snapshots

client.v1.instrumentData.marketData.getSnapshots(MarketDataGetSnapshotsParams { instrument_ids } query?, RequestOptionsoptions?): MarketDataGetSnapshotsResponse { data }

GET/v1/market-data/snapshot

Get Daily Aggregate Summaries

client.v1.instrumentData.marketData.getDailySummaries(MarketDataGetDailySummariesParams { instrument_ids } query, RequestOptionsoptions?): MarketDataGetDailySummariesResponse { data }

GET/v1/market-data/daily-summary

ModelsExpand Collapse

DailySummary { 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 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: string

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

formatuuid

high?: string | null

Session high.

low?: string | null

Session low.

open?: string | null

Opening price for the session.

symbol?: string | null

Display symbol for the security. None for unresolvable IDs.

trade_date?: string | null

Session date the OHLV represents, US/Eastern.

formatdate

volume?: number | null

Session cumulative trading volume.

formatint64

DailySummaryList = Array<DailySummary { instrument_id, high, low, 4 more } >

instrument_id: string

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

formatuuid

high?: string | null

Session high.

low?: string | null

Session low.

open?: string | null

Opening price for the session.

symbol?: string | null

Display symbol for the security. None for unresolvable IDs.

trade_date?: string | null

Session date the OHLV represents, US/Eastern.

formatdate

volume?: number | null

Session cumulative trading volume.

formatint64

MarketDataSnapshot { instrument_id, symbol, cumulative_volume, 4 more }

Market data snapshot for a single security.

instrument_id: string

OEMS instrument identifier.

symbol: string

Display symbol for the security.

cumulative_volume?: number | null

Cumulative traded volume reported on the most recent trade, in shares for equities or contracts for options. Absent when no trade is available.

formatint64

minimum0

last_quote?: SnapshotQuote { ask, bid, midpoint, 2 more } | null

Most recent quote if available.

ask: string

Current best ask.

bid: string

Current best bid.

midpoint: string

Midpoint of bid and ask.

ask_size?: number | null

Size at the best ask, in shares.

formatint32

minimum0

bid_size?: number | null

Size at the best bid, in shares.

formatint32

minimum0

last_trade?: SnapshotLastTrade { price } | null

Most recent last-sale trade if available.

price: string

Most recent last-sale eligible trade price.

name?: string | null

Security name if available.

session?: SnapshotSession { change, change_percent, previous_close } | null

Session metrics computed from previous close and last trade, if available.

change: string

Absolute change from previous close to last trade.

change_percent: string

Percent change from previous close to last trade.

previous_close: string

Previous session close price.

MarketDataSnapshotList = Array<MarketDataSnapshot { instrument_id, symbol, cumulative_volume, 4 more } >

instrument_id: string

OEMS instrument identifier.

symbol: string

Display symbol for the security.

cumulative_volume?: number | null

Cumulative traded volume reported on the most recent trade, in shares for equities or contracts for options. Absent when no trade is available.

formatint64

minimum0

last_quote?: SnapshotQuote { ask, bid, midpoint, 2 more } | null

Most recent quote if available.

ask: string

Current best ask.

bid: string

Current best bid.

midpoint: string

Midpoint of bid and ask.

ask_size?: number | null

Size at the best ask, in shares.

formatint32

minimum0

bid_size?: number | null

Size at the best bid, in shares.

formatint32

minimum0

last_trade?: SnapshotLastTrade { price } | null

Most recent last-sale trade if available.

price: string

Most recent last-sale eligible trade price.

name?: string | null

Security name if available.

session?: SnapshotSession { change, change_percent, previous_close } | null

Session metrics computed from previous close and last trade, if available.

change: string

Absolute change from previous close to last trade.

change_percent: string

Percent change from previous close to last trade.

previous_close: string

Previous session close price.

SnapshotLastTrade { price }

Last-trade fields for a market data snapshot.

price: string

Most recent last-sale eligible trade price.

SnapshotQuote { ask, bid, midpoint, 2 more }

L1 quote fields for a market data snapshot.

ask: string

Current best ask.

bid: string

Current best bid.

midpoint: string

Midpoint of bid and ask.

ask_size?: number | null

Size at the best ask, in shares.

formatint32

minimum0

bid_size?: number | null

Size at the best bid, in shares.

formatint32

minimum0

SnapshotSession { change, change_percent, previous_close }

Session-level pricing metrics for a market data snapshot.

change: string

Absolute change from previous close to last trade.

change_percent: string

Percent change from previous close to last trade.

previous_close: string

Previous session close price.

MarketDataGetSnapshotsResponse extends BaseResponse { metadata, error } { data }

data: MarketDataSnapshotList { instrument_id, symbol, cumulative_volume, 4 more }

instrument_id: string

OEMS instrument identifier.

symbol: string

Display symbol for the security.

cumulative_volume?: number | null

Cumulative traded volume reported on the most recent trade, in shares for equities or contracts for options. Absent when no trade is available.

formatint64

minimum0

last_quote?: SnapshotQuote { ask, bid, midpoint, 2 more } | null

Most recent quote if available.

ask: string

Current best ask.

bid: string

Current best bid.

midpoint: string

Midpoint of bid and ask.

ask_size?: number | null

Size at the best ask, in shares.

formatint32

minimum0

bid_size?: number | null

Size at the best bid, in shares.

formatint32

minimum0

last_trade?: SnapshotLastTrade { price } | null

Most recent last-sale trade if available.

price: string

Most recent last-sale eligible trade price.

name?: string | null

Security name if available.

session?: SnapshotSession { change, change_percent, previous_close } | null

Session metrics computed from previous close and last trade, if available.

change: string

Absolute change from previous close to last trade.

change_percent: string

Percent change from previous close to last trade.

previous_close: string

Previous session close price.

MarketDataGetDailySummariesResponse extends BaseResponse { metadata, error } { data }

data: DailySummaryList { instrument_id, high, low, 4 more }

instrument_id: string

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

formatuuid

high?: string | null

Session high.

low?: string | null

Session low.

open?: string | null

Opening price for the session.

symbol?: string | null

Display symbol for the security. None for unresolvable IDs.

trade_date?: string | null

Session date the OHLV represents, US/Eastern.

formatdate

volume?: number | null

Session cumulative trading volume.

formatint64

Instrument DataNews

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

Get News

client.v1.instrumentData.news.getNews(NewsGetNewsParams { exclude_publishers, from, include_publishers, 7 more } query?, RequestOptionsoptions?): NewsGetNewsResponse { data }

GET/v1/news

ModelsExpand Collapse

NewsInstrument { instrument_id, name, symbol }

Instrument associated with a news item.

instrument_id: string

OEMS instrument UUID.

formatuuid

name?: string | null

Instrument name/description, if available from instrument cache enrichment.

symbol?: string | null

Trading symbol, if available from instrument cache enrichment.

NewsItem { instruments, news_type, published_at, 6 more }

A single news item and its associated instruments.

instruments: Array<NewsInstrument { instrument_id, name, symbol } >

Instruments associated with this news item.

instrument_id: string

OEMS instrument UUID.

formatuuid

name?: string | null

Instrument name/description, if available from instrument cache enrichment.

symbol?: string | null

Trading symbol, if available from instrument cache enrichment.

news_type: NewsType

Classification of the item.

One of the following:

"NEWS"

"PRESS_RELEASE"

published_at: string

The published date/time of the article in UTC.

formatdate-time

publisher: string

The publisher or newswire source.

title: string

The headline/title of the article.

url: string

Canonical URL to the full article.

image_url?: string | null

URL of an associated image if provided by the source.

site?: string | null

The primary domain/site of the publisher.

text?: string | null

The full or excerpted article body.

NewsItemList = Array<NewsItem { instruments, news_type, published_at, 6 more } >

instruments: Array<NewsInstrument { instrument_id, name, symbol } >

Instruments associated with this news item.

instrument_id: string

OEMS instrument UUID.

formatuuid

name?: string | null

Instrument name/description, if available from instrument cache enrichment.

symbol?: string | null

Trading symbol, if available from instrument cache enrichment.

news_type: NewsType

Classification of the item.

One of the following:

"NEWS"

"PRESS_RELEASE"

published_at: string

The published date/time of the article in UTC.

formatdate-time

publisher: string

The publisher or newswire source.

title: string

The headline/title of the article.

url: string

Canonical URL to the full article.

image_url?: string | null

URL of an associated image if provided by the source.

site?: string | null

The primary domain/site of the publisher.

text?: string | null

The full or excerpted article body.

NewsType = "NEWS" | "PRESS_RELEASE"

News item classification.

One of the following:

"NEWS"

"PRESS_RELEASE"

NewsGetNewsResponse extends BaseResponse { metadata, error } { data }

data: NewsItemList { instruments, news_type, published_at, 6 more }

instruments: Array<NewsInstrument { instrument_id, name, symbol } >

Instruments associated with this news item.

instrument_id: string

OEMS instrument UUID.

formatuuid

name?: string | null

Instrument name/description, if available from instrument cache enrichment.

symbol?: string | null

Trading symbol, if available from instrument cache enrichment.

news_type: NewsType

Classification of the item.

One of the following:

"NEWS"

"PRESS_RELEASE"

published_at: string

The published date/time of the article in UTC.

formatdate-time

publisher: string

The publisher or newswire source.

title: string

The headline/title of the article.

url: string

Canonical URL to the full article.

image_url?: string | null

URL of an associated image if provided by the source.

site?: string | null

The primary domain/site of the publisher.

text?: string | null

The full or excerpted article body.