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

$ clear-street v1:instrument-data get-all-instrument-events

GET/v1/instruments/events

Get Instrument Events

$ clear-street v1:instrument-data get-instrument-events

GET/v1/instruments/{instrument_id}/events

Get Instrument Fundamentals

$ clear-street v1:instrument-data get-instrument-fundamentals

GET/v1/instruments/{instrument_id}/fundamentals

Get Instrument Balance Sheet Statements

$ clear-street v1:instrument-data get-instrument-balance-sheet-statements

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

Get Instrument Income Statements

$ clear-street v1:instrument-data get-instrument-income-statements

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

Get Instrument Analyst Consensus

$ clear-street v1:instrument-data get-instrument-analyst-consensus

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

Get Instrument Cash Flow Statements

$ clear-street v1:instrument-data get-instrument-cash-flow-statements

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

ModelsExpand Collapse

all_events_event_type: "EARNINGS" or "DIVIDEND" or "STOCK_SPLIT" or "IPO"

Event types supported by the all-events endpoint.

"EARNINGS"

"DIVIDEND"

"STOCK_SPLIT"

"IPO"

analyst_distribution: object { buy, hold, sell, 2 more }

Analyst recommendation distribution

buy: number

Number of buy recommendations

hold: number

Number of hold recommendations

sell: number

Number of sell recommendations

strong_buy: number

Number of strong buy recommendations

strong_sell: number

Number of strong sell recommendations

analyst_rating: "STRONG_BUY" or "BUY" or "HOLD" or 2 more

Analyst rating category

"STRONG_BUY"

"BUY"

"HOLD"

"SELL"

"STRONG_SELL"

fiscal_period_type: "QUARTERLY" or "ANNUAL" or "TTM" or "BIANNUAL"

Fiscal period type for earnings reports

"QUARTERLY"

"ANNUAL"

"TTM"

"BIANNUAL"

instrument_all_events_data: object { event_dates }

All-events payload grouped by date.

event_dates: array of InstrumentEventsByDate { date, events }

Events grouped by date in descending order.

date: string

Event date.

events: array of InstrumentEventEnvelope { symbol, type, dividend_event_data, 6 more }

Flat event envelopes for this date.

symbol: string

Symbol associated with the event.

type: "EARNINGS" or "DIVIDEND" or "STOCK_SPLIT" or "IPO"

Event type discriminator.

"EARNINGS"

"DIVIDEND"

"STOCK_SPLIT"

"IPO"

dividend_event_data: optional object { adjusted_dividend_amount, ex_date, declaration_date, 5 more }

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.

declaration_date: optional string

The declaration date of the dividend

dividend_amount: optional string

The dividend amount per share.

dividend_yield: optional string

The dividend yield as a percentage of the stock price.

frequency: optional string

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

payment_date: optional string

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

record_date: optional string

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.

earnings_event_data: optional object { date, eps_actual, eps_estimate, 4 more }

Earnings payload when type is EARNINGS.

date: string

The date when the earnings report was published

eps_actual: optional string

The actual earnings per share (EPS) for the period

eps_estimate: optional string

The estimated earnings per share (EPS) for the period

eps_surprise_percent: optional string

The percentage difference between actual and estimated EPS

revenue_actual: optional string

The actual total revenue for the period

revenue_estimate: optional string

The estimated total revenue for the period

revenue_surprise_percent: optional string

The percentage difference between actual and estimated revenue

instrument_id: optional string

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

ipo_event_data: optional object { actions, announced_at, company, 4 more }

IPO payload when type is IPO.

actions: optional string

IPO action.

announced_at: optional string

IPO announced timestamp.

company: optional string

IPO company name.

exchange: optional string

IPO exchange.

market_cap: optional string

IPO market cap.

price_range: optional string

IPO price range.

shares: optional string

IPO shares offered.

name: optional string

Instrument name associated with the event, when available.

reporting_currency: optional string

The currency used for reporting financial data.

stock_split_event_data: optional object { date, denominator, numerator, split_type }

Stock split payload when type is STOCK_SPLIT.

date: string

The date of the stock split

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”)

instrument_analyst_consensus: object { date, distribution, price_target, rating }

Aggregated analyst consensus metrics

date: string

The date the consensus snapshot was generated

distribution: optional object { buy, hold, sell, 2 more }

Count of individual analyst recommendations by category

buy: number

Number of buy recommendations

hold: number

Number of hold recommendations

sell: number

Number of sell recommendations

strong_buy: number

Number of strong buy recommendations

strong_sell: number

Number of strong sell recommendations

price_target: optional object { average, currency, high, low }

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: optional "STRONG_BUY" or "BUY" or "HOLD" or 2 more

Consensus analyst rating

"STRONG_BUY"

"BUY"

"HOLD"

"SELL"

"STRONG_SELL"

instrument_balance_sheet_statement: object { 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

filing_date: string

The date the financial statement was filed

period: string

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

period_type: "QUARTERLY" or "ANNUAL" or "TTM" or "BIANNUAL"

The type of fiscal period

"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

account_payables: optional string

Account payables

accounts_receivables: optional string

Accounts receivables

accrued_expenses: optional string

Accrued expenses

accumulated_other_comprehensive_income_loss: optional string

Accumulated other comprehensive income/loss

additional_paid_in_capital: optional string

Additional paid-in capital

capital_lease_obligations: optional string

Capital lease obligations (total)

capital_lease_obligations_current: optional string

Capital lease obligations (current portion)

cash_and_cash_equivalents: optional string

Cash and cash equivalents

cash_and_short_term_investments: optional string

Cash and short-term investments combined

common_stock: optional string

Common stock

deferred_revenue: optional string

Deferred revenue

deferred_revenue_non_current: optional string

Deferred revenue (non-current)

deferred_tax_liabilities_non_current: optional string

Deferred tax liabilities (non-current)

goodwill: optional string

Goodwill

goodwill_and_intangible_assets: optional string

Goodwill and intangible assets combined

intangible_assets: optional string

Intangible assets

inventory: optional string

Inventory

long_term_debt: optional string

Long-term debt

long_term_investments: optional string

Long-term investments

minority_interest: optional string

Minority interest

net_debt: optional string

Net debt (total debt minus cash)

net_receivables: optional string

Net receivables

other_assets: optional string

Other assets

other_current_assets: optional string

Other current assets

other_current_liabilities: optional string

Other current liabilities

other_liabilities: optional string

Other liabilities

other_non_current_assets: optional string

Other non-current assets

other_non_current_liabilities: optional string

Other non-current liabilities

other_payables: optional string

Other payables

other_receivables: optional string

Other receivables

other_total_stockholders_equity: optional string

Other total stockholders equity

preferred_stock: optional string

Preferred stock

prepaids: optional string

Prepaids

property_plant_and_equipment_net: optional string

Property, plant and equipment net of depreciation

retained_earnings: optional string

Retained earnings

short_term_debt: optional string

Short-term debt

short_term_investments: optional string

Short-term investments

tax_assets: optional string

Tax assets

tax_payables: optional string

Tax payables

total_assets: optional string

Total assets

total_current_assets: optional string

Total current assets

total_current_liabilities: optional string

Total current liabilities

total_debt: optional string

Total debt

total_equity: optional string

Total equity

total_investments: optional string

Total investments

total_liabilities: optional string

Total liabilities

total_liabilities_and_total_equity: optional string

Total liabilities and total equity

total_non_current_assets: optional string

Total non-current assets

total_non_current_liabilities: optional string

Total non-current liabilities

total_payables: optional string

Total payables

total_stockholders_equity: optional string

Total stockholders equity

treasury_stock: optional string

Treasury stock

instrument_balance_sheet_statement_list: array of InstrumentBalanceSheetStatement { accepted_date, filing_date, period, 55 more }

accepted_date: string

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

filing_date: string

The date the financial statement was filed

period: string

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

period_type: "QUARTERLY" or "ANNUAL" or "TTM" or "BIANNUAL"

The type of fiscal period

"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

account_payables: optional string

Account payables

accounts_receivables: optional string

Accounts receivables

accrued_expenses: optional string

Accrued expenses

accumulated_other_comprehensive_income_loss: optional string

Accumulated other comprehensive income/loss

additional_paid_in_capital: optional string

Additional paid-in capital

capital_lease_obligations: optional string

Capital lease obligations (total)

capital_lease_obligations_current: optional string

Capital lease obligations (current portion)

cash_and_cash_equivalents: optional string

Cash and cash equivalents

cash_and_short_term_investments: optional string

Cash and short-term investments combined

common_stock: optional string

Common stock

deferred_revenue: optional string

Deferred revenue

deferred_revenue_non_current: optional string

Deferred revenue (non-current)

deferred_tax_liabilities_non_current: optional string

Deferred tax liabilities (non-current)

goodwill: optional string

Goodwill

goodwill_and_intangible_assets: optional string

Goodwill and intangible assets combined

intangible_assets: optional string

Intangible assets

inventory: optional string

Inventory

long_term_debt: optional string

Long-term debt

long_term_investments: optional string

Long-term investments

minority_interest: optional string

Minority interest

net_debt: optional string

Net debt (total debt minus cash)

net_receivables: optional string

Net receivables

other_assets: optional string

Other assets

other_current_assets: optional string

Other current assets

other_current_liabilities: optional string

Other current liabilities

other_liabilities: optional string

Other liabilities

other_non_current_assets: optional string

Other non-current assets

other_non_current_liabilities: optional string

Other non-current liabilities

other_payables: optional string

Other payables

other_receivables: optional string

Other receivables

other_total_stockholders_equity: optional string

Other total stockholders equity

preferred_stock: optional string

Preferred stock

prepaids: optional string

Prepaids

property_plant_and_equipment_net: optional string

Property, plant and equipment net of depreciation

retained_earnings: optional string

Retained earnings

short_term_debt: optional string

Short-term debt

short_term_investments: optional string

Short-term investments

tax_assets: optional string

Tax assets

tax_payables: optional string

Tax payables

total_assets: optional string

Total assets

total_current_assets: optional string

Total current assets

total_current_liabilities: optional string

Total current liabilities

total_debt: optional string

Total debt

total_equity: optional string

Total equity

total_investments: optional string

Total investments

total_liabilities: optional string

Total liabilities

total_liabilities_and_total_equity: optional string

Total liabilities and total equity

total_non_current_assets: optional string

Total non-current assets

total_non_current_liabilities: optional string

Total non-current liabilities

total_payables: optional string

Total payables

total_stockholders_equity: optional string

Total stockholders equity

treasury_stock: optional string

Treasury stock

instrument_cash_flow_statement: object { 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

filing_date: string

The date the financial statement was filed

period: string

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

period_type: "QUARTERLY" or "ANNUAL" or "TTM" or "BIANNUAL"

The type of fiscal period

"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

accounts_payables: optional string

Change in accounts payables

accounts_receivables: optional string

Change in accounts receivables

acquisitions_net: optional string

Net acquisitions

capital_expenditure: optional string

Capital expenditure

cash_at_beginning_of_period: optional string

Cash and cash equivalents at beginning of period

cash_at_end_of_period: optional string

Cash and cash equivalents at end of period

change_in_working_capital: optional string

Change in working capital

common_dividends_paid: optional string

Common dividends paid

common_stock_issuance: optional string

Common stock issuance

common_stock_repurchased: optional string

Common stock repurchased (buybacks)

deferred_income_tax: optional string

Deferred income tax expense

depreciation_and_amortization: optional string

Depreciation and amortization expense

effect_of_forex_changes_on_cash: optional string

Effect of foreign exchange changes on cash

free_cash_flow: optional string

Free cash flow (operating cash flow minus capital expenditure)

income_taxes_paid: optional string

Income taxes paid

interest_paid: optional string

Interest paid

inventory: optional string

Change in inventory

investments_in_property_plant_and_equipment: optional string

Investments in property, plant, and equipment

long_term_net_debt_issuance: optional string

Long-term net debt issuance

net_cash_provided_by_financing_activities: optional string

Net cash provided by financing activities

net_cash_provided_by_investing_activities: optional string

Net cash provided by investing activities

net_cash_provided_by_operating_activities: optional string

Net cash provided by operating activities

net_change_in_cash: optional string

Net change in cash during the period

net_common_stock_issuance: optional string

Net common stock issuance

net_debt_issuance: optional string

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

net_dividends_paid: optional string

Net dividends paid (common + preferred)

net_income: optional string

Net income for the period

net_preferred_stock_issuance: optional string

Net preferred stock issuance

net_stock_issuance: optional string

Net stock issuance (common + preferred)

operating_cash_flow: optional string

Operating cash flow (alternative calculation)

other_financing_activities: optional string

Other financing activities

other_investing_activities: optional string

Other investing activities

other_non_cash_items: optional string

Other non-cash items

other_working_capital: optional string

Change in other working capital

preferred_dividends_paid: optional string

Preferred dividends paid

purchases_of_investments: optional string

Purchases of investments

sales_maturities_of_investments: optional string

Sales and maturities of investments

short_term_net_debt_issuance: optional string

Short-term net debt issuance

stock_based_compensation: optional string

Stock-based compensation expense

instrument_cash_flow_statement_list: array of InstrumentCashFlowStatement { accepted_date, filing_date, period, 42 more }

accepted_date: string

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

filing_date: string

The date the financial statement was filed

period: string

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

period_type: "QUARTERLY" or "ANNUAL" or "TTM" or "BIANNUAL"

The type of fiscal period

"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

accounts_payables: optional string

Change in accounts payables

accounts_receivables: optional string

Change in accounts receivables

acquisitions_net: optional string

Net acquisitions

capital_expenditure: optional string

Capital expenditure

cash_at_beginning_of_period: optional string

Cash and cash equivalents at beginning of period

cash_at_end_of_period: optional string

Cash and cash equivalents at end of period

change_in_working_capital: optional string

Change in working capital

common_dividends_paid: optional string

Common dividends paid

common_stock_issuance: optional string

Common stock issuance

common_stock_repurchased: optional string

Common stock repurchased (buybacks)

deferred_income_tax: optional string

Deferred income tax expense

depreciation_and_amortization: optional string

Depreciation and amortization expense

effect_of_forex_changes_on_cash: optional string

Effect of foreign exchange changes on cash

free_cash_flow: optional string

Free cash flow (operating cash flow minus capital expenditure)

income_taxes_paid: optional string

Income taxes paid

interest_paid: optional string

Interest paid

inventory: optional string

Change in inventory

investments_in_property_plant_and_equipment: optional string

Investments in property, plant, and equipment

long_term_net_debt_issuance: optional string

Long-term net debt issuance

net_cash_provided_by_financing_activities: optional string

Net cash provided by financing activities

net_cash_provided_by_investing_activities: optional string

Net cash provided by investing activities

net_cash_provided_by_operating_activities: optional string

Net cash provided by operating activities

net_change_in_cash: optional string

Net change in cash during the period

net_common_stock_issuance: optional string

Net common stock issuance

net_debt_issuance: optional string

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

net_dividends_paid: optional string

Net dividends paid (common + preferred)

net_income: optional string

Net income for the period

net_preferred_stock_issuance: optional string

Net preferred stock issuance

net_stock_issuance: optional string

Net stock issuance (common + preferred)

operating_cash_flow: optional string

Operating cash flow (alternative calculation)

other_financing_activities: optional string

Other financing activities

other_investing_activities: optional string

Other investing activities

other_non_cash_items: optional string

Other non-cash items

other_working_capital: optional string

Change in other working capital

preferred_dividends_paid: optional string

Preferred dividends paid

purchases_of_investments: optional string

Purchases of investments

sales_maturities_of_investments: optional string

Sales and maturities of investments

short_term_net_debt_issuance: optional string

Short-term net debt issuance

stock_based_compensation: optional string

Stock-based compensation expense

instrument_dividend_event: object { 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.

declaration_date: optional string

The declaration date of the dividend

dividend_amount: optional string

The dividend amount per share.

dividend_yield: optional string

The dividend yield as a percentage of the stock price.

frequency: optional string

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

payment_date: optional string

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

record_date: optional string

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.

instrument_earnings: object { date, eps_actual, eps_estimate, 4 more }

Represents instrument earnings data

date: string

The date when the earnings report was published

eps_actual: optional string

The actual earnings per share (EPS) for the period

eps_estimate: optional string

The estimated earnings per share (EPS) for the period

eps_surprise_percent: optional string

The percentage difference between actual and estimated EPS

revenue_actual: optional string

The actual total revenue for the period

revenue_estimate: optional string

The estimated total revenue for the period

revenue_surprise_percent: optional string

The percentage difference between actual and estimated revenue

instrument_event_envelope: object { symbol, type, dividend_event_data, 6 more }

Unified envelope for the all-events response.

symbol: string

Symbol associated with the event.

type: "EARNINGS" or "DIVIDEND" or "STOCK_SPLIT" or "IPO"

Event type discriminator.

"EARNINGS"

"DIVIDEND"

"STOCK_SPLIT"

"IPO"

dividend_event_data: optional object { adjusted_dividend_amount, ex_date, declaration_date, 5 more }

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.

declaration_date: optional string

The declaration date of the dividend

dividend_amount: optional string

The dividend amount per share.

dividend_yield: optional string

The dividend yield as a percentage of the stock price.

frequency: optional string

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

payment_date: optional string

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

record_date: optional string

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.

earnings_event_data: optional object { date, eps_actual, eps_estimate, 4 more }

Earnings payload when type is EARNINGS.

date: string

The date when the earnings report was published

eps_actual: optional string

The actual earnings per share (EPS) for the period

eps_estimate: optional string

The estimated earnings per share (EPS) for the period

eps_surprise_percent: optional string

The percentage difference between actual and estimated EPS

revenue_actual: optional string

The actual total revenue for the period

revenue_estimate: optional string

The estimated total revenue for the period

revenue_surprise_percent: optional string

The percentage difference between actual and estimated revenue

instrument_id: optional string

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

ipo_event_data: optional object { actions, announced_at, company, 4 more }

IPO payload when type is IPO.

actions: optional string

IPO action.

announced_at: optional string

IPO announced timestamp.

company: optional string

IPO company name.

exchange: optional string

IPO exchange.

market_cap: optional string

IPO market cap.

price_range: optional string

IPO price range.

shares: optional string

IPO shares offered.

name: optional string

Instrument name associated with the event, when available.

reporting_currency: optional string

The currency used for reporting financial data.

stock_split_event_data: optional object { date, denominator, numerator, split_type }

Stock split payload when type is STOCK_SPLIT.

date: string

The date of the stock split

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”)

instrument_event_ipo_item: object { actions, announced_at, company, 4 more }

IPO event in the all-events date grouping response.

actions: optional string

IPO action.

announced_at: optional string

IPO announced timestamp.

company: optional string

IPO company name.

exchange: optional string

IPO exchange.

market_cap: optional string

IPO market cap.

price_range: optional string

IPO price range.

shares: optional string

IPO shares offered.

instrument_events_by_date: object { date, events }

Instrument events for a single date.

date: string

Event date.

events: array of InstrumentEventEnvelope { symbol, type, dividend_event_data, 6 more }

Flat event envelopes for this date.

symbol: string

Symbol associated with the event.

type: "EARNINGS" or "DIVIDEND" or "STOCK_SPLIT" or "IPO"

Event type discriminator.

"EARNINGS"

"DIVIDEND"

"STOCK_SPLIT"

"IPO"

dividend_event_data: optional object { adjusted_dividend_amount, ex_date, declaration_date, 5 more }

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.

declaration_date: optional string

The declaration date of the dividend

dividend_amount: optional string

The dividend amount per share.

dividend_yield: optional string

The dividend yield as a percentage of the stock price.

frequency: optional string

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

payment_date: optional string

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

record_date: optional string

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.

earnings_event_data: optional object { date, eps_actual, eps_estimate, 4 more }

Earnings payload when type is EARNINGS.

date: string

The date when the earnings report was published

eps_actual: optional string

The actual earnings per share (EPS) for the period

eps_estimate: optional string

The estimated earnings per share (EPS) for the period

eps_surprise_percent: optional string

The percentage difference between actual and estimated EPS

revenue_actual: optional string

The actual total revenue for the period

revenue_estimate: optional string

The estimated total revenue for the period

revenue_surprise_percent: optional string

The percentage difference between actual and estimated revenue

instrument_id: optional string

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

ipo_event_data: optional object { actions, announced_at, company, 4 more }

IPO payload when type is IPO.

actions: optional string

IPO action.

announced_at: optional string

IPO announced timestamp.

company: optional string

IPO company name.

exchange: optional string

IPO exchange.

market_cap: optional string

IPO market cap.

price_range: optional string

IPO price range.

shares: optional string

IPO shares offered.

name: optional string

Instrument name associated with the event, when available.

reporting_currency: optional string

The currency used for reporting financial data.

stock_split_event_data: optional object { date, denominator, numerator, split_type }

Stock split payload when type is STOCK_SPLIT.

date: string

The date of the stock split

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”)

instrument_events_data: object { dividends, earnings, instrument_id, 2 more }

Grouped instrument events by type

dividends: array of InstrumentDividendEvent { adjusted_dividend_amount, ex_date, declaration_date, 5 more }

Dividend distribution events

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.

declaration_date: optional string

The declaration date of the dividend

dividend_amount: optional string

The dividend amount per share.

dividend_yield: optional string

The dividend yield as a percentage of the stock price.

frequency: optional string

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

payment_date: optional string

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

record_date: optional string

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.

earnings: array of InstrumentEarnings { date, eps_actual, eps_estimate, 4 more }

Earnings announcement events

date: string

The date when the earnings report was published

eps_actual: optional string

The actual earnings per share (EPS) for the period

eps_estimate: optional string

The estimated earnings per share (EPS) for the period

eps_surprise_percent: optional string

The percentage difference between actual and estimated EPS

revenue_actual: optional string

The actual total revenue for the period

revenue_estimate: optional string

The estimated total revenue for the period

revenue_surprise_percent: optional string

The percentage difference between actual and estimated revenue

instrument_id: string

OEMS instrument UUID from the request

splits: array of InstrumentSplitEvent { date, denominator, numerator, split_type }

Stock split events

date: string

The date of the stock split

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

The currency used for reporting financial data

instrument_fundamentals: object { average_volume, beta, description, 12 more }

Supplemental fundamentals and company profile data for an instrument.

average_volume: optional number

The average daily trading volume over the past 30 days

beta: optional string

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

description: optional string

A detailed description of the instrument or company

dividend_yield: optional string

The trailing twelve months (TTM) dividend yield

earnings_per_share: optional string

The trailing twelve months (TTM) earnings per share

fifty_two_week_high: optional string

The highest price over the last 52 weeks

fifty_two_week_low: optional string

The lowest price over the last 52 weeks

industry: optional string

The specific industry of the instrument’s issuer

list_date: optional string

The date the instrument was first listed

logo_url: optional string

URL to a representative logo image for the instrument or issuer

market_cap: optional string

The total market capitalization

previous_close: optional string

The closing price from the previous trading day

price_to_earnings: optional string

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

reporting_currency: optional string

The currency used for reporting financial data

sector: optional string

The business sector of the instrument’s issuer

instrument_income_statement: object { 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

filing_date: string

The date the financial statement was filed

period: string

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

period_type: "QUARTERLY" or "ANNUAL" or "TTM" or "BIANNUAL"

The type of fiscal period

"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

bottom_line_net_income: optional string

Bottom line net income after all adjustments

cost_and_expenses: optional string

Total costs and expenses

cost_of_revenue: optional string

Direct costs attributable to producing goods sold

depreciation_and_amortization: optional string

Depreciation and amortization expenses

ebit: optional string

Earnings before interest and taxes

ebitda: optional string

Earnings before interest, taxes, depreciation, and amortization

eps: optional string

Basic earnings per share

eps_diluted: optional string

Diluted earnings per share

general_and_administrative_expenses: optional string

General administrative overhead expenses

gross_profit: optional string

Revenue minus cost of revenue

income_before_tax: optional string

Income before income tax expense

income_tax_expense: optional string

Income tax expense for the period

interest_expense: optional string

Interest paid on debt

interest_income: optional string

Interest earned on investments and cash

net_income: optional string

Total net income for the period

net_income_deductions: optional string

Deductions from net income

net_income_from_continuing_operations: optional string

Net income from continuing operations

net_income_from_discontinued_operations: optional string

Net income from discontinued operations

net_interest_income: optional string

Net interest income (interest income minus interest expense)

non_operating_income_excluding_interest: optional string

Non-operating income excluding interest

operating_expenses: optional string

Total operating expenses

operating_income: optional string

Income from core business operations

other_adjustments_to_net_income: optional string

Other adjustments to net income

other_expenses: optional string

Other miscellaneous expenses

research_and_development_expenses: optional string

Expenditure on research and development activities

revenue: optional string

Total revenue from sales of goods and services

selling_and_marketing_expenses: optional string

Expenditure on marketing and sales activities

selling_general_and_administrative_expenses: optional string

Combined selling, general, and administrative expenses

total_other_income_expenses_net: optional string

Net of other income and expenses

weighted_average_shs_out: optional string

Weighted average shares outstanding (basic)

weighted_average_shs_out_dil: optional string

Weighted average shares outstanding (diluted)

instrument_income_statement_list: array of InstrumentIncomeStatement { accepted_date, filing_date, period, 34 more }

accepted_date: string

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

filing_date: string

The date the financial statement was filed

period: string

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

period_type: "QUARTERLY" or "ANNUAL" or "TTM" or "BIANNUAL"

The type of fiscal period

"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

bottom_line_net_income: optional string

Bottom line net income after all adjustments

cost_and_expenses: optional string

Total costs and expenses

cost_of_revenue: optional string

Direct costs attributable to producing goods sold

depreciation_and_amortization: optional string

Depreciation and amortization expenses

ebit: optional string

Earnings before interest and taxes

ebitda: optional string

Earnings before interest, taxes, depreciation, and amortization

eps: optional string

Basic earnings per share

eps_diluted: optional string

Diluted earnings per share

general_and_administrative_expenses: optional string

General administrative overhead expenses

gross_profit: optional string

Revenue minus cost of revenue

income_before_tax: optional string

Income before income tax expense

income_tax_expense: optional string

Income tax expense for the period

interest_expense: optional string

Interest paid on debt

interest_income: optional string

Interest earned on investments and cash

net_income: optional string

Total net income for the period

net_income_deductions: optional string

Deductions from net income

net_income_from_continuing_operations: optional string

Net income from continuing operations

net_income_from_discontinued_operations: optional string

Net income from discontinued operations

net_interest_income: optional string

Net interest income (interest income minus interest expense)

non_operating_income_excluding_interest: optional string

Non-operating income excluding interest

operating_expenses: optional string

Total operating expenses

operating_income: optional string

Income from core business operations

other_adjustments_to_net_income: optional string

Other adjustments to net income

other_expenses: optional string

Other miscellaneous expenses

research_and_development_expenses: optional string

Expenditure on research and development activities

revenue: optional string

Total revenue from sales of goods and services

selling_and_marketing_expenses: optional string

Expenditure on marketing and sales activities

selling_general_and_administrative_expenses: optional string

Combined selling, general, and administrative expenses

total_other_income_expenses_net: optional string

Net of other income and expenses

weighted_average_shs_out: optional string

Weighted average shares outstanding (basic)

weighted_average_shs_out_dil: optional string

Weighted average shares outstanding (diluted)

instrument_split_event: object { date, denominator, numerator, split_type }

Represents a stock split event for an instrument

date: string

The date of the stock split

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”)

price_target: object { 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

Instrument DataMarket Data

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

Get Snapshots

$ clear-street v1:instrument-data:market-data get-snapshots

GET/v1/market-data/snapshot

Get Daily Aggregate Summaries

$ clear-street v1:instrument-data:market-data get-daily-summaries

GET/v1/market-data/daily-summary

ModelsExpand Collapse

daily_summary: object { instrument_id, high, low, 4 more }

Daily aggregate (OHLV) summary for a single instrument.

Returned by GET /market-data/daily-summary. Every field except instrument_id is Option:

• Unresolvable instrument_id → all other 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.

high: optional string

Session high.

low: optional string

Session low.

open: optional string

Opening price for the session.

symbol: optional string

Display symbol for the security. None for unresolvable IDs.

trade_date: optional string

Session date the OHLV represents, US/Eastern.

volume: optional number

Session cumulative trading volume.

daily_summary_list: array of DailySummary { instrument_id, high, low, 4 more }

instrument_id: string

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

high: optional string

Session high.

low: optional string

Session low.

open: optional string

Opening price for the session.

symbol: optional string

Display symbol for the security. None for unresolvable IDs.

trade_date: optional string

Session date the OHLV represents, US/Eastern.

volume: optional number

Session cumulative trading volume.

market_data_snapshot: object { 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: optional number

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

last_quote: optional object { ask, bid, midpoint, 2 more }

Most recent quote if available.

ask: string

Current best ask.

bid: string

Current best bid.

midpoint: string

Midpoint of bid and ask.

ask_size: optional number

Size at the best ask, in shares.

bid_size: optional number

Size at the best bid, in shares.

last_trade: optional object { price }

Most recent last-sale trade if available.

price: string

Most recent last-sale eligible trade price.

name: optional string

Security name if available.

session: optional object { change, change_percent, previous_close }

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.

market_data_snapshot_list: array of MarketDataSnapshot { instrument_id, symbol, cumulative_volume, 4 more }

instrument_id: string

OEMS instrument identifier.

symbol: string

Display symbol for the security.

cumulative_volume: optional number

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

last_quote: optional object { ask, bid, midpoint, 2 more }

Most recent quote if available.

ask: string

Current best ask.

bid: string

Current best bid.

midpoint: string

Midpoint of bid and ask.

ask_size: optional number

Size at the best ask, in shares.

bid_size: optional number

Size at the best bid, in shares.

last_trade: optional object { price }

Most recent last-sale trade if available.

price: string

Most recent last-sale eligible trade price.

name: optional string

Security name if available.

session: optional object { change, change_percent, previous_close }

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.

snapshot_last_trade: object { price }

Last-trade fields for a market data snapshot.

price: string

Most recent last-sale eligible trade price.

snapshot_quote: object { 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: optional number

Size at the best ask, in shares.

bid_size: optional number

Size at the best bid, in shares.

snapshot_session: object { 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.

Instrument DataNews

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

Get News

$ clear-street v1:instrument-data:news get-news

GET/v1/news

ModelsExpand Collapse

news_instrument: object { instrument_id, name, symbol }

Instrument associated with a news item.

instrument_id: string

OEMS instrument UUID.

name: optional string

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

symbol: optional string

Trading symbol, if available from instrument cache enrichment.

news_item: object { instruments, news_type, published_at, 6 more }

A single news item and its associated instruments.

instruments: array of NewsInstrument { instrument_id, name, symbol }

Instruments associated with this news item.

instrument_id: string

OEMS instrument UUID.

name: optional string

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

symbol: optional string

Trading symbol, if available from instrument cache enrichment.

news_type: "NEWS" or "PRESS_RELEASE"

Classification of the item.

"NEWS"

"PRESS_RELEASE"

published_at: string

The published date/time of the article in UTC.

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

URL of an associated image if provided by the source.

site: optional string

The primary domain/site of the publisher.

text: optional string

The full or excerpted article body.

news_item_list: array of NewsItem { instruments, news_type, published_at, 6 more }

instruments: array of NewsInstrument { instrument_id, name, symbol }

Instruments associated with this news item.

instrument_id: string

OEMS instrument UUID.

name: optional string

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

symbol: optional string

Trading symbol, if available from instrument cache enrichment.

news_type: "NEWS" or "PRESS_RELEASE"

Classification of the item.

"NEWS"

"PRESS_RELEASE"

published_at: string

The published date/time of the article in UTC.

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

URL of an associated image if provided by the source.

site: optional string

The primary domain/site of the publisher.

text: optional string

The full or excerpted article body.

news_type: "NEWS" or "PRESS_RELEASE"

News item classification.

"NEWS"

"PRESS_RELEASE"