Instrument Data

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

Get All Instrument Events

InstrumentDataGetAllInstrumentEventsResponse v1().instrumentData().getAllInstrumentEvents(, )

GET/v1/instruments/events

Get Instrument Events

InstrumentDataGetInstrumentEventsResponse v1().instrumentData().getInstrumentEvents(, )

GET/v1/instruments/{instrument_id}/events

Get Instrument Fundamentals

InstrumentDataGetInstrumentFundamentalsResponse v1().instrumentData().getInstrumentFundamentals(, )

GET/v1/instruments/{instrument_id}/fundamentals

Get Instrument Balance Sheet Statements

InstrumentDataGetInstrumentBalanceSheetStatementsResponse v1().instrumentData().getInstrumentBalanceSheetStatements(, )

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

Get Instrument Income Statements

InstrumentDataGetInstrumentIncomeStatementsResponse v1().instrumentData().getInstrumentIncomeStatements(, )

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

Get Instrument Analyst Consensus

InstrumentDataGetInstrumentAnalystConsensusResponse v1().instrumentData().getInstrumentAnalystConsensus(, )

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

Get Instrument Cash Flow Statements

InstrumentDataGetInstrumentCashFlowStatementsResponse v1().instrumentData().getInstrumentCashFlowStatements(, )

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

ModelsExpand Collapse

enum AllEventsEventType:

Event types supported by the all-events endpoint.

EARNINGS("EARNINGS")

DIVIDEND("DIVIDEND")

STOCK_SPLIT("STOCK_SPLIT")

IPO("IPO")

class AnalystDistribution:

Analyst recommendation distribution

long buy

Number of buy recommendations

formatint64

long hold

Number of hold recommendations

formatint64

long sell

Number of sell recommendations

formatint64

long strongBuy

Number of strong buy recommendations

formatint64

long strongSell

Number of strong sell recommendations

formatint64

enum AnalystRating:

Analyst rating category

STRONG_BUY("STRONG_BUY")

BUY("BUY")

HOLD("HOLD")

SELL("SELL")

STRONG_SELL("STRONG_SELL")

enum FiscalPeriodType:

Fiscal period type for earnings reports

QUARTERLY("QUARTERLY")

ANNUAL("ANNUAL")

TTM("TTM")

BIANNUAL("BIANNUAL")

class InstrumentAllEventsData:

All-events payload grouped by date.

List<InstrumentEventsByDate> eventDates

Events grouped by date in descending order.

LocalDate date

Event date.

formatdate

List<InstrumentEventEnvelope> events

Flat event envelopes for this date.

String symbol

Symbol associated with the event.

AllEventsEventType type

Event type discriminator.

One of the following:

EARNINGS("EARNINGS")

DIVIDEND("DIVIDEND")

STOCK_SPLIT("STOCK_SPLIT")

IPO("IPO")

Optional<InstrumentDividendEvent> dividendEventData

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

String adjustedDividendAmount

The adjusted dividend amount accounting for any splits.

LocalDate exDate

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

formatdate

Optional<LocalDate> declarationDate

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

formatdate

Optional<String> dividendAmount

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

Optional<String> dividendYield

The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> frequency

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.

Optional<LocalDate> paymentDate

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

formatdate

Optional<LocalDate> recordDate

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

formatdate

Optional<InstrumentEarnings> earningsEventData

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

LocalDate date

The date when the earnings report was published

formatdate

Optional<String> epsActual

The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> epsEstimate

The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> epsSurprisePercent

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

Optional<ReportTime> reportTime

Report timing: before market open or after market close When a null/undefined value is observed, it indicates that there is no available data.

One of the following:

BMO("BMO")

AMC("AMC")

Optional<String> revenueActual

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

Optional<String> revenueEstimate

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

Optional<String> revenueSurprisePercent

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

Optional<String> instrumentId

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

formatuuid

Optional<InstrumentEventIpoItem> ipoEventData

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

Optional<String> actions

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

Optional<LocalDateTime> announcedAt

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

formatdate-time

Optional<String> company

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

Optional<String> exchange

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

Optional<String> marketCap

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

Optional<String> priceRange

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

Optional<String> shares

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

Optional<String> name

Instrument name associated with the event, when available. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> reportingCurrency

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

Optional<InstrumentSplitEvent> stockSplitEventData

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

LocalDate date

The date of the stock split

formatdate

String denominator

The denominator of the split ratio

String numerator

The numerator of the split ratio

String splitType

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

class InstrumentAnalystConsensus:

Aggregated analyst consensus metrics

LocalDate date

The date the consensus snapshot was generated

formatdate

Optional<AnalystDistribution> distribution

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

long buy

Number of buy recommendations

formatint64

long hold

Number of hold recommendations

formatint64

long sell

Number of sell recommendations

formatint64

long strongBuy

Number of strong buy recommendations

formatint64

long strongSell

Number of strong sell recommendations

formatint64

Optional<PriceTarget> priceTarget

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

String average

Average analyst price target

String currency

ISO 4217 currency code of the price targets

String high

Highest analyst price target

String low

Lowest analyst price target

Optional<AnalystRating> rating

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

One of the following:

STRONG_BUY("STRONG_BUY")

BUY("BUY")

HOLD("HOLD")

SELL("SELL")

STRONG_SELL("STRONG_SELL")

class InstrumentBalanceSheetStatement:

A quarterly balance sheet statement for an instrument.

LocalDateTime acceptedDate

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

formatdate-time

LocalDate filingDate

The date the financial statement was filed

formatdate

String period

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

FiscalPeriodType periodType

The type of fiscal period

One of the following:

QUARTERLY("QUARTERLY")

ANNUAL("ANNUAL")

TTM("TTM")

BIANNUAL("BIANNUAL")

String reportedCurrency

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

long year

The fiscal year of the statement

formatint32

Optional<String> accountPayables

Account payables

Optional<String> accountsReceivables

Accounts receivables

Optional<String> accruedExpenses

Accrued expenses

Optional<String> accumulatedOtherComprehensiveIncomeLoss

Accumulated other comprehensive income/loss

Optional<String> additionalPaidInCapital

Additional paid-in capital

Optional<String> capitalLeaseObligations

Capital lease obligations (total)

Optional<String> capitalLeaseObligationsCurrent

Capital lease obligations (current portion)

Optional<String> cashAndCashEquivalents

Cash and cash equivalents

Optional<String> cashAndShortTermInvestments

Cash and short-term investments combined

Optional<String> commonStock

Common stock

Optional<String> deferredRevenue

Deferred revenue

Optional<String> deferredRevenueNonCurrent

Deferred revenue (non-current)

Optional<String> deferredTaxLiabilitiesNonCurrent

Deferred tax liabilities (non-current)

Optional<String> goodwill

Goodwill

Optional<String> goodwillAndIntangibleAssets

Goodwill and intangible assets combined

Optional<String> intangibleAssets

Intangible assets

Optional<String> inventory

Inventory

Optional<String> longTermDebt

Long-term debt

Optional<String> longTermInvestments

Long-term investments

Optional<String> minorityInterest

Minority interest

Optional<String> netDebt

Net debt (total debt minus cash)

Optional<String> netReceivables

Net receivables

Optional<String> otherAssets

Other assets

Optional<String> otherCurrentAssets

Other current assets

Optional<String> otherCurrentLiabilities

Other current liabilities

Optional<String> otherLiabilities

Other liabilities

Optional<String> otherNonCurrentAssets

Other non-current assets

Optional<String> otherNonCurrentLiabilities

Other non-current liabilities

Optional<String> otherPayables

Other payables

Optional<String> otherReceivables

Other receivables

Optional<String> otherTotalStockholdersEquity

Other total stockholders equity

Optional<String> preferredStock

Preferred stock

Optional<String> prepaids

Prepaids

Optional<String> propertyPlantAndEquipmentNet

Property, plant and equipment net of depreciation

Optional<String> retainedEarnings

Retained earnings

Optional<String> shortTermDebt

Short-term debt

Optional<String> shortTermInvestments

Short-term investments

Optional<String> taxAssets

Tax assets

Optional<String> taxPayables

Tax payables

Optional<String> totalAssets

Total assets

Optional<String> totalCurrentAssets

Total current assets

Optional<String> totalCurrentLiabilities

Total current liabilities

Optional<String> totalDebt

Total debt

Optional<String> totalEquity

Total equity

Optional<String> totalInvestments

Total investments

Optional<String> totalLiabilities

Total liabilities

Optional<String> totalLiabilitiesAndTotalEquity

Total liabilities and total equity

Optional<String> totalNonCurrentAssets

Total non-current assets

Optional<String> totalNonCurrentLiabilities

Total non-current liabilities

Optional<String> totalPayables

Total payables

Optional<String> totalStockholdersEquity

Total stockholders equity

Optional<String> treasuryStock

Treasury stock

class InstrumentCashFlowStatement:

A quarterly cash flow statement for an instrument.

LocalDateTime acceptedDate

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

formatdate-time

LocalDate filingDate

The date the financial statement was filed

formatdate

String period

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

FiscalPeriodType periodType

The type of fiscal period

One of the following:

QUARTERLY("QUARTERLY")

ANNUAL("ANNUAL")

TTM("TTM")

BIANNUAL("BIANNUAL")

String reportedCurrency

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

long year

The fiscal year of the statement

formatint32

Optional<String> accountsPayables

Change in accounts payables

Optional<String> accountsReceivables

Change in accounts receivables

Optional<String> acquisitionsNet

Net acquisitions

Optional<String> capitalExpenditure

Capital expenditure

Optional<String> cashAtBeginningOfPeriod

Cash and cash equivalents at beginning of period

Optional<String> cashAtEndOfPeriod

Cash and cash equivalents at end of period

Optional<String> changeInWorkingCapital

Change in working capital

Optional<String> commonDividendsPaid

Common dividends paid

Optional<String> commonStockIssuance

Common stock issuance

Optional<String> commonStockRepurchased

Common stock repurchased (buybacks)

Optional<String> deferredIncomeTax

Deferred income tax expense

Optional<String> depreciationAndAmortization

Depreciation and amortization expense

Optional<String> effectOfForexChangesOnCash

Effect of foreign exchange changes on cash

Optional<String> freeCashFlow

Free cash flow (operating cash flow minus capital expenditure)

Optional<String> incomeTaxesPaid

Income taxes paid

Optional<String> interestPaid

Interest paid

Optional<String> inventory

Change in inventory

Optional<String> investmentsInPropertyPlantAndEquipment

Investments in property, plant, and equipment

Optional<String> longTermNetDebtIssuance

Long-term net debt issuance

Optional<String> netCashProvidedByFinancingActivities

Net cash provided by financing activities

Optional<String> netCashProvidedByInvestingActivities

Net cash provided by investing activities

Optional<String> netCashProvidedByOperatingActivities

Net cash provided by operating activities

Optional<String> netChangeInCash

Net change in cash during the period

Optional<String> netCommonStockIssuance

Net common stock issuance

Optional<String> netDebtIssuance

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

Optional<String> netDividendsPaid

Net dividends paid (common + preferred)

Optional<String> netIncome

Net income for the period

Optional<String> netPreferredStockIssuance

Net preferred stock issuance

Optional<String> netStockIssuance

Net stock issuance (common + preferred)

Optional<String> operatingCashFlow

Operating cash flow (alternative calculation)

Optional<String> otherFinancingActivities

Other financing activities

Optional<String> otherInvestingActivities

Other investing activities

Optional<String> otherNonCashItems

Other non-cash items

Optional<String> otherWorkingCapital

Change in other working capital

Optional<String> preferredDividendsPaid

Preferred dividends paid

Optional<String> purchasesOfInvestments

Purchases of investments

Optional<String> salesMaturitiesOfInvestments

Sales and maturities of investments

Optional<String> shortTermNetDebtIssuance

Short-term net debt issuance

Optional<String> stockBasedCompensation

Stock-based compensation expense

class InstrumentDividendEvent:

Represents a dividend event for an instrument

String adjustedDividendAmount

The adjusted dividend amount accounting for any splits.

LocalDate exDate

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

formatdate

Optional<LocalDate> declarationDate

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

formatdate

Optional<String> dividendAmount

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

Optional<String> dividendYield

The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> frequency

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.

Optional<LocalDate> paymentDate

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

formatdate

Optional<LocalDate> recordDate

formatdate

class InstrumentEarnings:

Represents instrument earnings data

LocalDate date

The date when the earnings report was published

formatdate

Optional<String> epsActual

The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> epsEstimate

The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> epsSurprisePercent

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

Optional<ReportTime> reportTime

Report timing: before market open or after market close When a null/undefined value is observed, it indicates that there is no available data.

One of the following:

BMO("BMO")

AMC("AMC")

Optional<String> revenueActual

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

Optional<String> revenueEstimate

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

Optional<String> revenueSurprisePercent

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

class InstrumentEventEnvelope:

Unified envelope for the all-events response.

String symbol

Symbol associated with the event.

AllEventsEventType type

Event type discriminator.

One of the following:

EARNINGS("EARNINGS")

DIVIDEND("DIVIDEND")

STOCK_SPLIT("STOCK_SPLIT")

IPO("IPO")

Optional<InstrumentDividendEvent> dividendEventData

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

String adjustedDividendAmount

The adjusted dividend amount accounting for any splits.

LocalDate exDate

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

formatdate

Optional<LocalDate> declarationDate

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

formatdate

Optional<String> dividendAmount

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

Optional<String> dividendYield

The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> frequency

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.

Optional<LocalDate> paymentDate

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

formatdate

Optional<LocalDate> recordDate

formatdate

Optional<InstrumentEarnings> earningsEventData

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

LocalDate date

The date when the earnings report was published

formatdate

Optional<String> epsActual

The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> epsEstimate

The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> epsSurprisePercent

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

Optional<ReportTime> reportTime

Report timing: before market open or after market close When a null/undefined value is observed, it indicates that there is no available data.

One of the following:

BMO("BMO")

AMC("AMC")

Optional<String> revenueActual

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

Optional<String> revenueEstimate

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

Optional<String> revenueSurprisePercent

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

Optional<String> instrumentId

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

formatuuid

Optional<InstrumentEventIpoItem> ipoEventData

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

Optional<String> actions

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

Optional<LocalDateTime> announcedAt

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

formatdate-time

Optional<String> company

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

Optional<String> exchange

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

Optional<String> marketCap

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

Optional<String> priceRange

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

Optional<String> shares

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

Optional<String> name

Instrument name associated with the event, when available. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> reportingCurrency

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

Optional<InstrumentSplitEvent> stockSplitEventData

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

LocalDate date

The date of the stock split

formatdate

String denominator

The denominator of the split ratio

String numerator

The numerator of the split ratio

String splitType

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

class InstrumentEventIpoItem:

IPO event in the all-events date grouping response.

Optional<String> actions

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

Optional<LocalDateTime> announcedAt

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

formatdate-time

Optional<String> company

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

Optional<String> exchange

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

Optional<String> marketCap

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

Optional<String> priceRange

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

Optional<String> shares

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

class InstrumentEventsByDate:

Instrument events for a single date.

LocalDate date

Event date.

formatdate

List<InstrumentEventEnvelope> events

Flat event envelopes for this date.

String symbol

Symbol associated with the event.

AllEventsEventType type

Event type discriminator.

One of the following:

EARNINGS("EARNINGS")

DIVIDEND("DIVIDEND")

STOCK_SPLIT("STOCK_SPLIT")

IPO("IPO")

Optional<InstrumentDividendEvent> dividendEventData

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

String adjustedDividendAmount

The adjusted dividend amount accounting for any splits.

LocalDate exDate

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

formatdate

Optional<LocalDate> declarationDate

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

formatdate

Optional<String> dividendAmount

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

Optional<String> dividendYield

The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> frequency

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.

Optional<LocalDate> paymentDate

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

formatdate

Optional<LocalDate> recordDate

formatdate

Optional<InstrumentEarnings> earningsEventData

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

LocalDate date

The date when the earnings report was published

formatdate

Optional<String> epsActual

The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> epsEstimate

The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> epsSurprisePercent

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

Optional<ReportTime> reportTime

Report timing: before market open or after market close When a null/undefined value is observed, it indicates that there is no available data.

One of the following:

BMO("BMO")

AMC("AMC")

Optional<String> revenueActual

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

Optional<String> revenueEstimate

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

Optional<String> revenueSurprisePercent

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

Optional<String> instrumentId

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

formatuuid

Optional<InstrumentEventIpoItem> ipoEventData

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

Optional<String> actions

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

Optional<LocalDateTime> announcedAt

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

formatdate-time

Optional<String> company

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

Optional<String> exchange

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

Optional<String> marketCap

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

Optional<String> priceRange

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

Optional<String> shares

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

Optional<String> name

Instrument name associated with the event, when available. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> reportingCurrency

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

Optional<InstrumentSplitEvent> stockSplitEventData

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

LocalDate date

The date of the stock split

formatdate

String denominator

The denominator of the split ratio

String numerator

The numerator of the split ratio

String splitType

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

class InstrumentEventsData:

Grouped instrument events by type

List<InstrumentDividendEvent> dividends

Dividend distribution events

String adjustedDividendAmount

The adjusted dividend amount accounting for any splits.

LocalDate exDate

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

formatdate

Optional<LocalDate> declarationDate

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

formatdate

Optional<String> dividendAmount

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

Optional<String> dividendYield

The dividend yield as a percentage of the stock price. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> frequency

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”). When a null/undefined value is observed, it indicates that there is no available data.

Optional<LocalDate> paymentDate

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

formatdate

Optional<LocalDate> recordDate

formatdate

List<InstrumentEarnings> earnings

Earnings announcement events

LocalDate date

The date when the earnings report was published

formatdate

Optional<String> epsActual

The actual earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> epsEstimate

The estimated earnings per share (EPS) for the period When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> epsSurprisePercent

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

Optional<ReportTime> reportTime

Report timing: before market open or after market close When a null/undefined value is observed, it indicates that there is no available data.

One of the following:

BMO("BMO")

AMC("AMC")

Optional<String> revenueActual

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

Optional<String> revenueEstimate

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

Optional<String> revenueSurprisePercent

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

String instrumentId

Instrument identifier

formatuuid

List<InstrumentIpoEvent> ipos

IPO events

LocalDate date

The date of the IPO

formatdate

Optional<String> actions

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

Optional<LocalDateTime> announcedAt

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

formatdate-time

Optional<String> company

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

Optional<String> exchange

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

Optional<String> marketCap

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

Optional<String> priceRange

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

Optional<String> shares

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

List<InstrumentSplitEvent> splits

Stock split events

LocalDate date

The date of the stock split

formatdate

String denominator

The denominator of the split ratio

String numerator

The numerator of the split ratio

String splitType

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

Optional<String> reportingCurrency

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

class InstrumentFundamentals:

Supplemental fundamentals and company profile data for an instrument.

Optional<Long> averageVolume

The average daily trading volume over the past 30 days When a null/undefined value is observed, it indicates that there is no available data.

formatint64

Optional<String> beta

The beta value, measuring the instrument’s volatility relative to the overall market When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> description

A detailed description of the instrument or company When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> dividendYield

The trailing twelve months (TTM) dividend yield When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> earningsPerShare

The trailing twelve months (TTM) earnings per share When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> fiftyTwoWeekHigh

The highest price over the last 52 weeks When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> fiftyTwoWeekLow

The lowest price over the last 52 weeks When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> industry

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

Optional<LocalDate> listDate

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

formatdate

Optional<String> logoUrl

URL to a representative logo image for the instrument or issuer When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> marketCap

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

Optional<String> previousClose

The closing price from the previous trading day When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> priceToEarnings

The price-to-earnings (P/E) ratio for the trailing twelve months (TTM) When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> reportingCurrency

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

Optional<String> sector

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

class InstrumentIncomeStatement:

A quarterly income statement for an instrument.

LocalDateTime acceptedDate

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

formatdate-time

LocalDate filingDate

The date the financial statement was filed

formatdate

String period

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

FiscalPeriodType periodType

The type of fiscal period

One of the following:

QUARTERLY("QUARTERLY")

ANNUAL("ANNUAL")

TTM("TTM")

BIANNUAL("BIANNUAL")

String reportedCurrency

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

long year

The fiscal year of the statement

formatint32

Optional<String> bottomLineNetIncome

Bottom line net income after all adjustments

Optional<String> costAndExpenses

Total costs and expenses

Optional<String> costOfRevenue

Direct costs attributable to producing goods sold

Optional<String> depreciationAndAmortization

Depreciation and amortization expenses

Optional<String> ebit

Earnings before interest and taxes

Optional<String> ebitda

Earnings before interest, taxes, depreciation, and amortization

Optional<String> eps

Basic earnings per share

Optional<String> epsDiluted

Diluted earnings per share

Optional<String> generalAndAdministrativeExpenses

General administrative overhead expenses

Optional<String> grossProfit

Revenue minus cost of revenue

Optional<String> incomeBeforeTax

Income before income tax expense

Optional<String> incomeTaxExpense

Income tax expense for the period

Optional<String> interestExpense

Interest paid on debt

Optional<String> interestIncome

Interest earned on investments and cash

Optional<String> netIncome

Total net income for the period

Optional<String> netIncomeDeductions

Deductions from net income

Optional<String> netIncomeFromContinuingOperations

Net income from continuing operations

Optional<String> netIncomeFromDiscontinuedOperations

Net income from discontinued operations

Optional<String> netInterestIncome

Net interest income (interest income minus interest expense)

Optional<String> nonOperatingIncomeExcludingInterest

Non-operating income excluding interest

Optional<String> operatingExpenses

Total operating expenses

Optional<String> operatingIncome

Income from core business operations

Optional<String> otherAdjustmentsToNetIncome

Other adjustments to net income

Optional<String> otherExpenses

Other miscellaneous expenses

Optional<String> researchAndDevelopmentExpenses

Expenditure on research and development activities

Optional<String> revenue

Total revenue from sales of goods and services

Optional<String> sellingAndMarketingExpenses

Expenditure on marketing and sales activities

Optional<String> sellingGeneralAndAdministrativeExpenses

Combined selling, general, and administrative expenses

Optional<String> totalOtherIncomeExpensesNet

Net of other income and expenses

Optional<String> weightedAverageShsOut

Weighted average shares outstanding (basic)

Optional<String> weightedAverageShsOutDil

Weighted average shares outstanding (diluted)

class InstrumentIpoEvent:

Represents an IPO event for an instrument

LocalDate date

The date of the IPO

formatdate

Optional<String> actions

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

Optional<LocalDateTime> announcedAt

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

formatdate-time

Optional<String> company

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

Optional<String> exchange

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

Optional<String> marketCap

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

Optional<String> priceRange

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

Optional<String> shares

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

class InstrumentSplitEvent:

Represents a stock split event for an instrument

LocalDate date

The date of the stock split

formatdate

String denominator

The denominator of the split ratio

String numerator

The numerator of the split ratio

String splitType

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

class PriceTarget:

Analyst price target statistics

String average

Average analyst price target

String currency

ISO 4217 currency code of the price targets

String high

Highest analyst price target

String low

Lowest analyst price target

enum ReportTime:

Earnings report timing: before market open or after market close

BMO("BMO")

AMC("AMC")

Instrument DataMarket Data

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

Get Snapshots

MarketDataGetSnapshotsResponse v1().instrumentData().marketData().getSnapshots(, )

GET/v1/market-data/snapshot

Get Daily Aggregate Summaries

Deprecated

MarketDataGetDailySummariesResponse v1().instrumentData().marketData().getDailySummaries(, )

GET/v1/market-data/daily-summary

ModelsExpand Collapse

class DailySummary:

Daily aggregate (OHLV) summary for a single instrument.

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

Unresolvable instrument_id → all other fields None (including symbol).
Resolvable instrument_id with no realtime cache entry → symbol populated, OHLV/trade_date/open_interest None.
trade_date reflects the session the OHLV represents (today during trading hours, the last trading date during weekends/holidays).
open_interest is populated for options only; None for equities and indices.
not_applicable is a non-optional bool, always serialized: true for instrument types with no daily summary by definition (e.g. an index, whose OHLV/trade_date are None), false otherwise.

String instrumentId

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

formatuuid

Optional<String> high

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

Optional<String> low

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

Optional<Boolean> notApplicable

true when the instrument type has no daily summary by definition (e.g. an index). Distinguishes an intentional N/A from OHLV that is merely not loaded yet. false for instruments that can have a summary.

Optional<String> open

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

Optional<Long> openInterest

Open interest (outstanding contracts). Populated for options only; None for equities and indices. When a null/undefined value is observed, it indicates that there is no available data.

formatint64

Optional<String> symbol

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

Optional<LocalDate> tradeDate

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

formatdate

Optional<Long> volume

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

formatint64

class MarketDataSnapshot:

Market data snapshot for a single security.

String instrumentId

Unique instrument identifier.

SnapshotSession session

Session-level pricing and OHLV metrics. Always present; each inner field is independently nullable.

boolean ohlvApplicable

false only for instrument types with no OHLV by definition (e.g. an index instrument, whose price is a computed level rather than a traded security) — open/high/low/ohlv_date/cumulative_volume are then always absent. true otherwise, even when those fields simply haven’t loaded yet. Always serialized.

Optional<String> change

Absolute change from previous close to the most recent last-sale-eligible trade. Absent when either side of the computation is unavailable. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> changePercent

Percent change from previous close to the most recent last-sale-eligible trade. Absent under the same conditions as change. When a null/undefined value is observed, it indicates that there is no available data.

Optional<Long> cumulativeVolume

Cumulative traded volume for the current session, in shares for equities or contracts for options. Always reflects the current session, even when ohlv_date trails it. Absent when ohlv_applicable is false, or when no trade is available. When a null/undefined value is observed, it indicates that there is no available data.

formatint64

minimum0

Optional<String> high

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

Optional<String> low

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

Optional<LocalDate> ohlvDate

Session date the open/high/low values represent, US/Eastern. May trail the current session until the upstream feed rolls. When a null/undefined value is observed, it indicates that there is no available data.

formatdate

Optional<String> open

Session opening price, from the day’s OHLC bar. Absent when ohlv_applicable is false, or when the bar has not loaded yet. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> previousClose

Previous session close price. Corporate-action-adjusted (stock dividends, cash dividends, and forward/reverse splits) when an adjustment exists for the close date; the raw close otherwise. An adjustment can carry the price beyond 2 decimal places. Absent when no previous close is on record (e.g. an instrument’s first session). When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> previousCloseUnadjusted

Unadjusted (raw) previous session close. Present only when a corporate-action adjustment exists for the previous close date; when no adjustment exists, previous_close is the raw close and this field is omitted. When a null/undefined value is observed, it indicates that there is no available data.

Optional<Boolean> shortSaleRestricted

Whether the SEC Rule 201 short-sale price test is currently restricting short sales in this security, from the trading-status feed.

true restricts non-exempt short sales at or below the national best bid. null means we have no answer, either because no trading status has been seen for this security yet or because Rule 201 does not cover this security type. A null is not a statement that short selling is unrestricted, and must not be treated as clear to short.

This is the current market condition, not a statement about whether Clear Street will reject your order. It is also distinct from is_short_prohibited on the instrument endpoints, which is a standing property of the security rather than a live circuit breaker. When a null/undefined value is observed, it indicates that there is no available data.

String symbol

Display symbol for the security.

DeprecatedOptional<Long> cumulativeVolume

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

Deprecated: use session.cumulative_volume, the same value from the same source. When a null/undefined value is observed, it indicates that there is no available data.

formatint64

minimum0

Optional<SnapshotGreeks> greeks

Theoretical price and Greeks for option instruments. None for equities, and for options whose Greeks have not yet been observed When a null/undefined value is observed, it indicates that there is no available data.

String delta

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

String gamma

Gamma: ∂²V/∂S².

String iv

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

String rho

Rho per 1.0 rate point.

String theoPrice

Theoretical option price in USD per share.

String theta

Theta per trading day.

LocalDateTime timestamp

Timestamp when the Greeks were calculated.

formatdate-time

String vega

Vega per 1.0 vol point.

Optional<SnapshotQuote> lastQuote

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

Optional<String> ask

Current best ask. Absent when no ask is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.

Optional<Long> askSize

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

formatint32

minimum0

Optional<LocalDateTime> askTimestamp

Exchange timestamp of the best ask. Absent when the ask side carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time

Optional<String> askVenue

ISO 10383 Market Identifier Code (MIC) of the venue currently holding the national best offer (NBBO). Absent when the ask side carries no venue. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> bid

Current best bid. Absent when no bid is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.

Optional<Long> bidSize

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

formatint32

minimum0

Optional<LocalDateTime> bidTimestamp

Exchange timestamp of the best bid. Absent when the bid side carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time

Optional<String> bidVenue

ISO 10383 Market Identifier Code (MIC) of the venue currently holding the national best bid (NBBO). Absent when the bid side carries no venue. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> midpoint

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

Optional<SnapshotLastTrade> lastTrade

Most recent last-sale-eligible trade if available. Omitted when the most recent known print is ineligible (e.g. an odd lot or an out-of-sequence report) rather than showing that print’s price. When a null/undefined value is observed, it indicates that there is no available data.

String price

Most recent last-sale eligible trade price. For index instruments, the current index level.

long size

Share quantity of the most recent last-sale eligible trade. Always 0 for index instruments, whose level is computed rather than traded.

formatint32

minimum0

Optional<LocalDateTime> timestamp

Exchange timestamp of the most recent last-sale eligible trade. For index instruments, the time the index level was computed. Absent when the trade carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time

Optional<String> venue

ISO 10383 Market Identifier Code (MIC) of the venue where the most recent last-sale eligible trade took place. Absent when the trade carries no venue; index levels are computed rather than traded and have no venue. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> name

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

Optional<Long> openInterest

Open interest (outstanding contracts) as of the most recent OPRA Refresh. Populated for options only; absent for equities and indices. When a null/undefined value is observed, it indicates that there is no available data.

formatint64

minimum0

class SnapshotGreeks:

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

String delta

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

String gamma

Gamma: ∂²V/∂S².

String iv

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

String rho

Rho per 1.0 rate point.

String theoPrice

Theoretical option price in USD per share.

String theta

Theta per trading day.

LocalDateTime timestamp

Timestamp when the Greeks were calculated.

formatdate-time

String vega

Vega per 1.0 vol point.

class SnapshotLastTrade:

Last-trade fields for a market data snapshot.

For index instruments this carries the current index level — a computed value, not a trade: price is the level and size is always 0 (no contract changes hands).

String price

Most recent last-sale eligible trade price. For index instruments, the current index level.

long size

Share quantity of the most recent last-sale eligible trade. Always 0 for index instruments, whose level is computed rather than traded.

formatint32

minimum0

Optional<LocalDateTime> timestamp

formatdate-time

Optional<String> venue

class SnapshotQuote:

L1 quote fields for a market data snapshot.

Optional<String> ask

Current best ask. Absent when no ask is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.

Optional<Long> askSize

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

formatint32

minimum0

Optional<LocalDateTime> askTimestamp

Exchange timestamp of the best ask. Absent when the ask side carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time

Optional<String> askVenue

Optional<String> bid

Current best bid. Absent when no bid is available (one-sided quote). When a null/undefined value is observed, it indicates that there is no available data.

Optional<Long> bidSize

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

formatint32

minimum0

Optional<LocalDateTime> bidTimestamp

Exchange timestamp of the best bid. Absent when the bid side carries no timestamp. When a null/undefined value is observed, it indicates that there is no available data.

formatdate-time

Optional<String> bidVenue

Optional<String> midpoint

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

class SnapshotSession:

Session-level pricing and OHLV metrics for a market data snapshot. Always present on the snapshot row; every field here is independently nullable except ohlv_applicable.

boolean ohlvApplicable

Optional<String> change

Optional<String> changePercent

Optional<Long> cumulativeVolume

formatint64

minimum0

Optional<String> high

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

Optional<String> low

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

Optional<LocalDate> ohlvDate

formatdate

Optional<String> open

Optional<String> previousClose

Optional<String> previousCloseUnadjusted

Instrument DataNews

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

Get News

NewsGetNewsResponse v1().instrumentData().news().getNews(, )

GET/v1/news

ModelsExpand Collapse

class NewsInstrument:

Instrument associated with a news item.

String instrumentId

Instrument identifier.

formatuuid

Optional<String> name

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

Optional<String> symbol

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

class NewsItem:

A single news item and its associated instruments.

List<NewsInstrument> instruments

Instruments associated with this news item.

String instrumentId

Instrument identifier.

formatuuid

Optional<String> name

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

Optional<String> symbol

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

NewsType newsType

Classification of the item.

One of the following:

NEWS("NEWS")

PRESS_RELEASE("PRESS_RELEASE")

LocalDateTime publishedAt

The published date/time of the article in UTC.

formatdate-time

String publisher

The publisher or newswire source.

String title

The headline/title of the article.

String url

Canonical URL to the full article.

Optional<String> imageUrl

URL of an associated image if provided by the source. When a null/undefined value is observed, it indicates that there is no available data.

Optional<String> site

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

Optional<String> text

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

enum NewsType:

News item classification.

NEWS("NEWS")

PRESS_RELEASE("PRESS_RELEASE")