Instrument Data

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

Get All Instrument Events

client.V1.InstrumentData.GetAllInstrumentEvents(ctx, query) (*V1InstrumentDataGetAllInstrumentEventsResponse, error)

GET/v1/instruments/events

Get Instrument Events

client.V1.InstrumentData.GetInstrumentEvents(ctx, instrumentID, query) (*V1InstrumentDataGetInstrumentEventsResponse, error)

GET/v1/instruments/{instrument_id}/events

Get Instrument Fundamentals

client.V1.InstrumentData.GetInstrumentFundamentals(ctx, instrumentID) (*V1InstrumentDataGetInstrumentFundamentalsResponse, error)

GET/v1/instruments/{instrument_id}/fundamentals

Get Instrument Balance Sheet Statements

client.V1.InstrumentData.GetInstrumentBalanceSheetStatements(ctx, instrumentID, query) (*V1InstrumentDataGetInstrumentBalanceSheetStatementsResponse, error)

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

Get Instrument Income Statements

client.V1.InstrumentData.GetInstrumentIncomeStatements(ctx, instrumentID, query) (*V1InstrumentDataGetInstrumentIncomeStatementsResponse, error)

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

Get Instrument Analyst Consensus

client.V1.InstrumentData.GetInstrumentAnalystConsensus(ctx, instrumentID, query) (*V1InstrumentDataGetInstrumentAnalystConsensusResponse, error)

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

Get Instrument Cash Flow Statements

client.V1.InstrumentData.GetInstrumentCashFlowStatements(ctx, instrumentID, query) (*V1InstrumentDataGetInstrumentCashFlowStatementsResponse, error)

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

ModelsExpand Collapse

type AllEventsEventType string

Event types supported by the all-events endpoint.

One of the following:

const AllEventsEventTypeEarnings AllEventsEventType = "EARNINGS"

const AllEventsEventTypeDividend AllEventsEventType = "DIVIDEND"

const AllEventsEventTypeStockSplit AllEventsEventType = "STOCK_SPLIT"

const AllEventsEventTypeIpo AllEventsEventType = "IPO"

type AnalystDistribution struct{…}

Analyst recommendation distribution

Buy int64

Number of buy recommendations

formatint64

Hold int64

Number of hold recommendations

formatint64

Sell int64

Number of sell recommendations

formatint64

StrongBuy int64

Number of strong buy recommendations

formatint64

StrongSell int64

Number of strong sell recommendations

formatint64

type AnalystRating string

Analyst rating category

One of the following:

const AnalystRatingStrongBuy AnalystRating = "STRONG_BUY"

const AnalystRatingBuy AnalystRating = "BUY"

const AnalystRatingHold AnalystRating = "HOLD"

const AnalystRatingSell AnalystRating = "SELL"

const AnalystRatingStrongSell AnalystRating = "STRONG_SELL"

type FiscalPeriodType string

Fiscal period type for earnings reports

One of the following:

const FiscalPeriodTypeQuarterly FiscalPeriodType = "QUARTERLY"

const FiscalPeriodTypeAnnual FiscalPeriodType = "ANNUAL"

const FiscalPeriodTypeTtm FiscalPeriodType = "TTM"

const FiscalPeriodTypeBiannual FiscalPeriodType = "BIANNUAL"

type InstrumentAllEventsData struct{…}

All-events payload grouped by date.

EventDates []InstrumentEventsByDate

Events grouped by date in descending order.

Date Time

Event date.

formatdate

Events []InstrumentEventEnvelope

Flat event envelopes for this date.

Symbol string

Symbol associated with the event.

Type AllEventsEventType

Event type discriminator.

One of the following:

const AllEventsEventTypeEarnings AllEventsEventType = "EARNINGS"

const AllEventsEventTypeDividend AllEventsEventType = "DIVIDEND"

const AllEventsEventTypeStockSplit AllEventsEventType = "STOCK_SPLIT"

const AllEventsEventTypeIpo AllEventsEventType = "IPO"

DividendEventData InstrumentDividendEventOptional

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

AdjustedDividendAmount string

The adjusted dividend amount accounting for any splits.

ExDate Time

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

formatdate

DeclarationDate TimeOptional

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

formatdate

DividendAmount stringOptional

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

DividendYield stringOptional

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

Frequency stringOptional

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.

PaymentDate TimeOptional

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

RecordDate TimeOptional

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

EarningsEventData InstrumentEarningsOptional

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

Date Time

The date when the earnings report was published

formatdate

EpsActual stringOptional

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

EpsEstimate stringOptional

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

EpsSurprisePercent stringOptional

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

ReportTime ReportTimeOptional

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:

const ReportTimeBmo ReportTime = "BMO"

const ReportTimeAmc ReportTime = "AMC"

RevenueActual stringOptional

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

RevenueEstimate stringOptional

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

RevenueSurprisePercent stringOptional

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

InstrumentID stringOptional

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

formatuuid

IpoEventData InstrumentEventIpoItemOptional

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

Actions stringOptional

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

AnnouncedAt TimeOptional

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

formatdate-time

Company stringOptional

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

Exchange stringOptional

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

MarketCap stringOptional

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

PriceRange stringOptional

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

Shares stringOptional

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

Name stringOptional

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

ReportingCurrency stringOptional

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

StockSplitEventData InstrumentSplitEventOptional

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

Date Time

The date of the stock split

formatdate

Denominator string

The denominator of the split ratio

Numerator string

The numerator of the split ratio

SplitType string

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

type InstrumentAnalystConsensus struct{…}

Aggregated analyst consensus metrics

Date Time

The date the consensus snapshot was generated

formatdate

Distribution AnalystDistributionOptional

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

Buy int64

Number of buy recommendations

formatint64

Hold int64

Number of hold recommendations

formatint64

Sell int64

Number of sell recommendations

formatint64

StrongBuy int64

Number of strong buy recommendations

formatint64

StrongSell int64

Number of strong sell recommendations

formatint64

PriceTarget PriceTargetOptional

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

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 AnalystRatingOptional

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

One of the following:

const AnalystRatingStrongBuy AnalystRating = "STRONG_BUY"

const AnalystRatingBuy AnalystRating = "BUY"

const AnalystRatingHold AnalystRating = "HOLD"

const AnalystRatingSell AnalystRating = "SELL"

const AnalystRatingStrongSell AnalystRating = "STRONG_SELL"

type InstrumentBalanceSheetStatement struct{…}

A quarterly balance sheet statement for an instrument.

AcceptedDate Time

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

formatdate-time

FilingDate Time

The date the financial statement was filed

formatdate

Period string

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

PeriodType FiscalPeriodType

The type of fiscal period

One of the following:

const FiscalPeriodTypeQuarterly FiscalPeriodType = "QUARTERLY"

const FiscalPeriodTypeAnnual FiscalPeriodType = "ANNUAL"

const FiscalPeriodTypeTtm FiscalPeriodType = "TTM"

const FiscalPeriodTypeBiannual FiscalPeriodType = "BIANNUAL"

ReportedCurrency string

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

Year int64

The fiscal year of the statement

formatint32

AccountPayables stringOptional

Account payables

AccountsReceivables stringOptional

Accounts receivables

AccruedExpenses stringOptional

Accrued expenses

AccumulatedOtherComprehensiveIncomeLoss stringOptional

Accumulated other comprehensive income/loss

AdditionalPaidInCapital stringOptional

Additional paid-in capital

CapitalLeaseObligations stringOptional

Capital lease obligations (total)

CapitalLeaseObligationsCurrent stringOptional

Capital lease obligations (current portion)

CashAndCashEquivalents stringOptional

Cash and cash equivalents

CashAndShortTermInvestments stringOptional

Cash and short-term investments combined

CommonStock stringOptional

Common stock

DeferredRevenue stringOptional

Deferred revenue

DeferredRevenueNonCurrent stringOptional

Deferred revenue (non-current)

DeferredTaxLiabilitiesNonCurrent stringOptional

Deferred tax liabilities (non-current)

Goodwill stringOptional

Goodwill

GoodwillAndIntangibleAssets stringOptional

Goodwill and intangible assets combined

IntangibleAssets stringOptional

Intangible assets

Inventory stringOptional

Inventory

LongTermDebt stringOptional

Long-term debt

LongTermInvestments stringOptional

Long-term investments

MinorityInterest stringOptional

Minority interest

NetDebt stringOptional

Net debt (total debt minus cash)

NetReceivables stringOptional

Net receivables

OtherAssets stringOptional

Other assets

OtherCurrentAssets stringOptional

Other current assets

OtherCurrentLiabilities stringOptional

Other current liabilities

OtherLiabilities stringOptional

Other liabilities

OtherNonCurrentAssets stringOptional

Other non-current assets

OtherNonCurrentLiabilities stringOptional

Other non-current liabilities

OtherPayables stringOptional

Other payables

OtherReceivables stringOptional

Other receivables

OtherTotalStockholdersEquity stringOptional

Other total stockholders equity

PreferredStock stringOptional

Preferred stock

Prepaids stringOptional

Prepaids

PropertyPlantAndEquipmentNet stringOptional

Property, plant and equipment net of depreciation

RetainedEarnings stringOptional

Retained earnings

ShortTermDebt stringOptional

Short-term debt

ShortTermInvestments stringOptional

Short-term investments

TaxAssets stringOptional

Tax assets

TaxPayables stringOptional

Tax payables

TotalAssets stringOptional

Total assets

TotalCurrentAssets stringOptional

Total current assets

TotalCurrentLiabilities stringOptional

Total current liabilities

TotalDebt stringOptional

Total debt

TotalEquity stringOptional

Total equity

TotalInvestments stringOptional

Total investments

TotalLiabilities stringOptional

Total liabilities

TotalLiabilitiesAndTotalEquity stringOptional

Total liabilities and total equity

TotalNonCurrentAssets stringOptional

Total non-current assets

TotalNonCurrentLiabilities stringOptional

Total non-current liabilities

TotalPayables stringOptional

Total payables

TotalStockholdersEquity stringOptional

Total stockholders equity

TreasuryStock stringOptional

Treasury stock

type InstrumentBalanceSheetStatementList []InstrumentBalanceSheetStatement

AcceptedDate Time

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

formatdate-time

FilingDate Time

The date the financial statement was filed

formatdate

Period string

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

PeriodType FiscalPeriodType

The type of fiscal period

One of the following:

const FiscalPeriodTypeQuarterly FiscalPeriodType = "QUARTERLY"

const FiscalPeriodTypeAnnual FiscalPeriodType = "ANNUAL"

const FiscalPeriodTypeTtm FiscalPeriodType = "TTM"

const FiscalPeriodTypeBiannual FiscalPeriodType = "BIANNUAL"

ReportedCurrency string

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

Year int64

The fiscal year of the statement

formatint32

AccountPayables stringOptional

Account payables

AccountsReceivables stringOptional

Accounts receivables

AccruedExpenses stringOptional

Accrued expenses

AccumulatedOtherComprehensiveIncomeLoss stringOptional

Accumulated other comprehensive income/loss

AdditionalPaidInCapital stringOptional

Additional paid-in capital

CapitalLeaseObligations stringOptional

Capital lease obligations (total)

CapitalLeaseObligationsCurrent stringOptional

Capital lease obligations (current portion)

CashAndCashEquivalents stringOptional

Cash and cash equivalents

CashAndShortTermInvestments stringOptional

Cash and short-term investments combined

CommonStock stringOptional

Common stock

DeferredRevenue stringOptional

Deferred revenue

DeferredRevenueNonCurrent stringOptional

Deferred revenue (non-current)

DeferredTaxLiabilitiesNonCurrent stringOptional

Deferred tax liabilities (non-current)

Goodwill stringOptional

Goodwill

GoodwillAndIntangibleAssets stringOptional

Goodwill and intangible assets combined

IntangibleAssets stringOptional

Intangible assets

Inventory stringOptional

Inventory

LongTermDebt stringOptional

Long-term debt

LongTermInvestments stringOptional

Long-term investments

MinorityInterest stringOptional

Minority interest

NetDebt stringOptional

Net debt (total debt minus cash)

NetReceivables stringOptional

Net receivables

OtherAssets stringOptional

Other assets

OtherCurrentAssets stringOptional

Other current assets

OtherCurrentLiabilities stringOptional

Other current liabilities

OtherLiabilities stringOptional

Other liabilities

OtherNonCurrentAssets stringOptional

Other non-current assets

OtherNonCurrentLiabilities stringOptional

Other non-current liabilities

OtherPayables stringOptional

Other payables

OtherReceivables stringOptional

Other receivables

OtherTotalStockholdersEquity stringOptional

Other total stockholders equity

PreferredStock stringOptional

Preferred stock

Prepaids stringOptional

Prepaids

PropertyPlantAndEquipmentNet stringOptional

Property, plant and equipment net of depreciation

RetainedEarnings stringOptional

Retained earnings

ShortTermDebt stringOptional

Short-term debt

ShortTermInvestments stringOptional

Short-term investments

TaxAssets stringOptional

Tax assets

TaxPayables stringOptional

Tax payables

TotalAssets stringOptional

Total assets

TotalCurrentAssets stringOptional

Total current assets

TotalCurrentLiabilities stringOptional

Total current liabilities

TotalDebt stringOptional

Total debt

TotalEquity stringOptional

Total equity

TotalInvestments stringOptional

Total investments

TotalLiabilities stringOptional

Total liabilities

TotalLiabilitiesAndTotalEquity stringOptional

Total liabilities and total equity

TotalNonCurrentAssets stringOptional

Total non-current assets

TotalNonCurrentLiabilities stringOptional

Total non-current liabilities

TotalPayables stringOptional

Total payables

TotalStockholdersEquity stringOptional

Total stockholders equity

TreasuryStock stringOptional

Treasury stock

type InstrumentCashFlowStatement struct{…}

A quarterly cash flow statement for an instrument.

AcceptedDate Time

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

formatdate-time

FilingDate Time

The date the financial statement was filed

formatdate

Period string

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

PeriodType FiscalPeriodType

The type of fiscal period

One of the following:

const FiscalPeriodTypeQuarterly FiscalPeriodType = "QUARTERLY"

const FiscalPeriodTypeAnnual FiscalPeriodType = "ANNUAL"

const FiscalPeriodTypeTtm FiscalPeriodType = "TTM"

const FiscalPeriodTypeBiannual FiscalPeriodType = "BIANNUAL"

ReportedCurrency string

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

Year int64

The fiscal year of the statement

formatint32

AccountsPayables stringOptional

Change in accounts payables

AccountsReceivables stringOptional

Change in accounts receivables

AcquisitionsNet stringOptional

Net acquisitions

CapitalExpenditure stringOptional

Capital expenditure

CashAtBeginningOfPeriod stringOptional

Cash and cash equivalents at beginning of period

CashAtEndOfPeriod stringOptional

Cash and cash equivalents at end of period

ChangeInWorkingCapital stringOptional

Change in working capital

CommonDividendsPaid stringOptional

Common dividends paid

CommonStockIssuance stringOptional

Common stock issuance

CommonStockRepurchased stringOptional

Common stock repurchased (buybacks)

DeferredIncomeTax stringOptional

Deferred income tax expense

DepreciationAndAmortization stringOptional

Depreciation and amortization expense

EffectOfForexChangesOnCash stringOptional

Effect of foreign exchange changes on cash

FreeCashFlow stringOptional

Free cash flow (operating cash flow minus capital expenditure)

IncomeTaxesPaid stringOptional

Income taxes paid

InterestPaid stringOptional

Interest paid

Inventory stringOptional

Change in inventory

InvestmentsInPropertyPlantAndEquipment stringOptional

Investments in property, plant, and equipment

LongTermNetDebtIssuance stringOptional

Long-term net debt issuance

NetCashProvidedByFinancingActivities stringOptional

Net cash provided by financing activities

NetCashProvidedByInvestingActivities stringOptional

Net cash provided by investing activities

NetCashProvidedByOperatingActivities stringOptional

Net cash provided by operating activities

NetChangeInCash stringOptional

Net change in cash during the period

NetCommonStockIssuance stringOptional

Net common stock issuance

NetDebtIssuance stringOptional

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

NetDividendsPaid stringOptional

Net dividends paid (common + preferred)

NetIncome stringOptional

Net income for the period

NetPreferredStockIssuance stringOptional

Net preferred stock issuance

NetStockIssuance stringOptional

Net stock issuance (common + preferred)

OperatingCashFlow stringOptional

Operating cash flow (alternative calculation)

OtherFinancingActivities stringOptional

Other financing activities

OtherInvestingActivities stringOptional

Other investing activities

OtherNonCashItems stringOptional

Other non-cash items

OtherWorkingCapital stringOptional

Change in other working capital

PreferredDividendsPaid stringOptional

Preferred dividends paid

PurchasesOfInvestments stringOptional

Purchases of investments

SalesMaturitiesOfInvestments stringOptional

Sales and maturities of investments

ShortTermNetDebtIssuance stringOptional

Short-term net debt issuance

StockBasedCompensation stringOptional

Stock-based compensation expense

type InstrumentCashFlowStatementList []InstrumentCashFlowStatement

AcceptedDate Time

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

formatdate-time

FilingDate Time

The date the financial statement was filed

formatdate

Period string

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

PeriodType FiscalPeriodType

The type of fiscal period

One of the following:

const FiscalPeriodTypeQuarterly FiscalPeriodType = "QUARTERLY"

const FiscalPeriodTypeAnnual FiscalPeriodType = "ANNUAL"

const FiscalPeriodTypeTtm FiscalPeriodType = "TTM"

const FiscalPeriodTypeBiannual FiscalPeriodType = "BIANNUAL"

ReportedCurrency string

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

Year int64

The fiscal year of the statement

formatint32

AccountsPayables stringOptional

Change in accounts payables

AccountsReceivables stringOptional

Change in accounts receivables

AcquisitionsNet stringOptional

Net acquisitions

CapitalExpenditure stringOptional

Capital expenditure

CashAtBeginningOfPeriod stringOptional

Cash and cash equivalents at beginning of period

CashAtEndOfPeriod stringOptional

Cash and cash equivalents at end of period

ChangeInWorkingCapital stringOptional

Change in working capital

CommonDividendsPaid stringOptional

Common dividends paid

CommonStockIssuance stringOptional

Common stock issuance

CommonStockRepurchased stringOptional

Common stock repurchased (buybacks)

DeferredIncomeTax stringOptional

Deferred income tax expense

DepreciationAndAmortization stringOptional

Depreciation and amortization expense

EffectOfForexChangesOnCash stringOptional

Effect of foreign exchange changes on cash

FreeCashFlow stringOptional

Free cash flow (operating cash flow minus capital expenditure)

IncomeTaxesPaid stringOptional

Income taxes paid

InterestPaid stringOptional

Interest paid

Inventory stringOptional

Change in inventory

InvestmentsInPropertyPlantAndEquipment stringOptional

Investments in property, plant, and equipment

LongTermNetDebtIssuance stringOptional

Long-term net debt issuance

NetCashProvidedByFinancingActivities stringOptional

Net cash provided by financing activities

NetCashProvidedByInvestingActivities stringOptional

Net cash provided by investing activities

NetCashProvidedByOperatingActivities stringOptional

Net cash provided by operating activities

NetChangeInCash stringOptional

Net change in cash during the period

NetCommonStockIssuance stringOptional

Net common stock issuance

NetDebtIssuance stringOptional

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

NetDividendsPaid stringOptional

Net dividends paid (common + preferred)

NetIncome stringOptional

Net income for the period

NetPreferredStockIssuance stringOptional

Net preferred stock issuance

NetStockIssuance stringOptional

Net stock issuance (common + preferred)

OperatingCashFlow stringOptional

Operating cash flow (alternative calculation)

OtherFinancingActivities stringOptional

Other financing activities

OtherInvestingActivities stringOptional

Other investing activities

OtherNonCashItems stringOptional

Other non-cash items

OtherWorkingCapital stringOptional

Change in other working capital

PreferredDividendsPaid stringOptional

Preferred dividends paid

PurchasesOfInvestments stringOptional

Purchases of investments

SalesMaturitiesOfInvestments stringOptional

Sales and maturities of investments

ShortTermNetDebtIssuance stringOptional

Short-term net debt issuance

StockBasedCompensation stringOptional

Stock-based compensation expense

type InstrumentDividendEvent struct{…}

Represents a dividend event for an instrument

AdjustedDividendAmount string

The adjusted dividend amount accounting for any splits.

ExDate Time

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

formatdate

DeclarationDate TimeOptional

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

formatdate

DividendAmount stringOptional

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

DividendYield stringOptional

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

Frequency stringOptional

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.

PaymentDate TimeOptional

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

RecordDate TimeOptional

formatdate

type InstrumentEarnings struct{…}

Represents instrument earnings data

Date Time

The date when the earnings report was published

formatdate

EpsActual stringOptional

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

EpsEstimate stringOptional

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

EpsSurprisePercent stringOptional

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

ReportTime ReportTimeOptional

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:

const ReportTimeBmo ReportTime = "BMO"

const ReportTimeAmc ReportTime = "AMC"

RevenueActual stringOptional

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

RevenueEstimate stringOptional

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

RevenueSurprisePercent stringOptional

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

type InstrumentEventEnvelope struct{…}

Unified envelope for the all-events response.

Symbol string

Symbol associated with the event.

Type AllEventsEventType

Event type discriminator.

One of the following:

const AllEventsEventTypeEarnings AllEventsEventType = "EARNINGS"

const AllEventsEventTypeDividend AllEventsEventType = "DIVIDEND"

const AllEventsEventTypeStockSplit AllEventsEventType = "STOCK_SPLIT"

const AllEventsEventTypeIpo AllEventsEventType = "IPO"

DividendEventData InstrumentDividendEventOptional

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

AdjustedDividendAmount string

The adjusted dividend amount accounting for any splits.

ExDate Time

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

formatdate

DeclarationDate TimeOptional

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

formatdate

DividendAmount stringOptional

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

DividendYield stringOptional

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

Frequency stringOptional

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.

PaymentDate TimeOptional

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

RecordDate TimeOptional

formatdate

EarningsEventData InstrumentEarningsOptional

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

Date Time

The date when the earnings report was published

formatdate

EpsActual stringOptional

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

EpsEstimate stringOptional

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

EpsSurprisePercent stringOptional

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

ReportTime ReportTimeOptional

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:

const ReportTimeBmo ReportTime = "BMO"

const ReportTimeAmc ReportTime = "AMC"

RevenueActual stringOptional

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

RevenueEstimate stringOptional

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

RevenueSurprisePercent stringOptional

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

InstrumentID stringOptional

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

formatuuid

IpoEventData InstrumentEventIpoItemOptional

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

Actions stringOptional

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

AnnouncedAt TimeOptional

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

formatdate-time

Company stringOptional

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

Exchange stringOptional

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

MarketCap stringOptional

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

PriceRange stringOptional

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

Shares stringOptional

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

Name stringOptional

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

ReportingCurrency stringOptional

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

StockSplitEventData InstrumentSplitEventOptional

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

Date Time

The date of the stock split

formatdate

Denominator string

The denominator of the split ratio

Numerator string

The numerator of the split ratio

SplitType string

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

type InstrumentEventIpoItem struct{…}

IPO event in the all-events date grouping response.

Actions stringOptional

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

AnnouncedAt TimeOptional

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

formatdate-time

Company stringOptional

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

Exchange stringOptional

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

MarketCap stringOptional

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

PriceRange stringOptional

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

Shares stringOptional

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

type InstrumentEventsByDate struct{…}

Instrument events for a single date.

Date Time

Event date.

formatdate

Events []InstrumentEventEnvelope

Flat event envelopes for this date.

Symbol string

Symbol associated with the event.

Type AllEventsEventType

Event type discriminator.

One of the following:

const AllEventsEventTypeEarnings AllEventsEventType = "EARNINGS"

const AllEventsEventTypeDividend AllEventsEventType = "DIVIDEND"

const AllEventsEventTypeStockSplit AllEventsEventType = "STOCK_SPLIT"

const AllEventsEventTypeIpo AllEventsEventType = "IPO"

DividendEventData InstrumentDividendEventOptional

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

AdjustedDividendAmount string

The adjusted dividend amount accounting for any splits.

ExDate Time

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

formatdate

DeclarationDate TimeOptional

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

formatdate

DividendAmount stringOptional

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

DividendYield stringOptional

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

Frequency stringOptional

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.

PaymentDate TimeOptional

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

RecordDate TimeOptional

formatdate

EarningsEventData InstrumentEarningsOptional

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

Date Time

The date when the earnings report was published

formatdate

EpsActual stringOptional

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

EpsEstimate stringOptional

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

EpsSurprisePercent stringOptional

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

ReportTime ReportTimeOptional

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:

const ReportTimeBmo ReportTime = "BMO"

const ReportTimeAmc ReportTime = "AMC"

RevenueActual stringOptional

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

RevenueEstimate stringOptional

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

RevenueSurprisePercent stringOptional

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

InstrumentID stringOptional

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

formatuuid

IpoEventData InstrumentEventIpoItemOptional

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

Actions stringOptional

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

AnnouncedAt TimeOptional

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

formatdate-time

Company stringOptional

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

Exchange stringOptional

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

MarketCap stringOptional

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

PriceRange stringOptional

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

Shares stringOptional

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

Name stringOptional

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

ReportingCurrency stringOptional

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

StockSplitEventData InstrumentSplitEventOptional

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

Date Time

The date of the stock split

formatdate

Denominator string

The denominator of the split ratio

Numerator string

The numerator of the split ratio

SplitType string

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

type InstrumentEventsData struct{…}

Grouped instrument events by type

Dividends []InstrumentDividendEvent

Dividend distribution events

AdjustedDividendAmount string

The adjusted dividend amount accounting for any splits.

ExDate Time

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

formatdate

DeclarationDate TimeOptional

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

formatdate

DividendAmount stringOptional

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

DividendYield stringOptional

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

Frequency stringOptional

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.

PaymentDate TimeOptional

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

RecordDate TimeOptional

formatdate

Earnings []InstrumentEarnings

Earnings announcement events

Date Time

The date when the earnings report was published

formatdate

EpsActual stringOptional

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

EpsEstimate stringOptional

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

EpsSurprisePercent stringOptional

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

ReportTime ReportTimeOptional

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:

const ReportTimeBmo ReportTime = "BMO"

const ReportTimeAmc ReportTime = "AMC"

RevenueActual stringOptional

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

RevenueEstimate stringOptional

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

RevenueSurprisePercent stringOptional

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

InstrumentID string

Instrument identifier

formatuuid

Ipos []InstrumentIpoEvent

IPO events

Date Time

The date of the IPO

formatdate

Actions stringOptional

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

AnnouncedAt TimeOptional

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

formatdate-time

Company stringOptional

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

Exchange stringOptional

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

MarketCap stringOptional

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

PriceRange stringOptional

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

Shares stringOptional

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

Splits []InstrumentSplitEvent

Stock split events

Date Time

The date of the stock split

formatdate

Denominator string

The denominator of the split ratio

Numerator string

The numerator of the split ratio

SplitType string

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

ReportingCurrency stringOptional

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

type InstrumentFundamentals struct{…}

Supplemental fundamentals and company profile data for an instrument.

AverageVolume int64Optional

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

formatint64

Beta stringOptional

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

Description stringOptional

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

DividendYield stringOptional

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

EarningsPerShare stringOptional

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

FiftyTwoWeekHigh stringOptional

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

FiftyTwoWeekLow stringOptional

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

Industry stringOptional

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

ListDate TimeOptional

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

formatdate

LogoURL stringOptional

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.

MarketCap stringOptional

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

PreviousClose stringOptional

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

PriceToEarnings stringOptional

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.

ReportingCurrency stringOptional

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

Sector stringOptional

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

type InstrumentIncomeStatement struct{…}

A quarterly income statement for an instrument.

AcceptedDate Time

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

formatdate-time

FilingDate Time

The date the financial statement was filed

formatdate

Period string

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

PeriodType FiscalPeriodType

The type of fiscal period

One of the following:

const FiscalPeriodTypeQuarterly FiscalPeriodType = "QUARTERLY"

const FiscalPeriodTypeAnnual FiscalPeriodType = "ANNUAL"

const FiscalPeriodTypeTtm FiscalPeriodType = "TTM"

const FiscalPeriodTypeBiannual FiscalPeriodType = "BIANNUAL"

ReportedCurrency string

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

Year int64

The fiscal year of the statement

formatint32

BottomLineNetIncome stringOptional

Bottom line net income after all adjustments

CostAndExpenses stringOptional

Total costs and expenses

CostOfRevenue stringOptional

Direct costs attributable to producing goods sold

DepreciationAndAmortization stringOptional

Depreciation and amortization expenses

Ebit stringOptional

Earnings before interest and taxes

Ebitda stringOptional

Earnings before interest, taxes, depreciation, and amortization

Eps stringOptional

Basic earnings per share

EpsDiluted stringOptional

Diluted earnings per share

GeneralAndAdministrativeExpenses stringOptional

General administrative overhead expenses

GrossProfit stringOptional

Revenue minus cost of revenue

IncomeBeforeTax stringOptional

Income before income tax expense

IncomeTaxExpense stringOptional

Income tax expense for the period

InterestExpense stringOptional

Interest paid on debt

InterestIncome stringOptional

Interest earned on investments and cash

NetIncome stringOptional

Total net income for the period

NetIncomeDeductions stringOptional

Deductions from net income

NetIncomeFromContinuingOperations stringOptional

Net income from continuing operations

NetIncomeFromDiscontinuedOperations stringOptional

Net income from discontinued operations

NetInterestIncome stringOptional

Net interest income (interest income minus interest expense)

NonOperatingIncomeExcludingInterest stringOptional

Non-operating income excluding interest

OperatingExpenses stringOptional

Total operating expenses

OperatingIncome stringOptional

Income from core business operations

OtherAdjustmentsToNetIncome stringOptional

Other adjustments to net income

OtherExpenses stringOptional

Other miscellaneous expenses

ResearchAndDevelopmentExpenses stringOptional

Expenditure on research and development activities

Revenue stringOptional

Total revenue from sales of goods and services

SellingAndMarketingExpenses stringOptional

Expenditure on marketing and sales activities

SellingGeneralAndAdministrativeExpenses stringOptional

Combined selling, general, and administrative expenses

TotalOtherIncomeExpensesNet stringOptional

Net of other income and expenses

WeightedAverageShsOut stringOptional

Weighted average shares outstanding (basic)

WeightedAverageShsOutDil stringOptional

Weighted average shares outstanding (diluted)

type InstrumentIncomeStatementList []InstrumentIncomeStatement

AcceptedDate Time

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

formatdate-time

FilingDate Time

The date the financial statement was filed

formatdate

Period string

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

PeriodType FiscalPeriodType

The type of fiscal period

One of the following:

const FiscalPeriodTypeQuarterly FiscalPeriodType = "QUARTERLY"

const FiscalPeriodTypeAnnual FiscalPeriodType = "ANNUAL"

const FiscalPeriodTypeTtm FiscalPeriodType = "TTM"

const FiscalPeriodTypeBiannual FiscalPeriodType = "BIANNUAL"

ReportedCurrency string

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

Year int64

The fiscal year of the statement

formatint32

BottomLineNetIncome stringOptional

Bottom line net income after all adjustments

CostAndExpenses stringOptional

Total costs and expenses

CostOfRevenue stringOptional

Direct costs attributable to producing goods sold

DepreciationAndAmortization stringOptional

Depreciation and amortization expenses

Ebit stringOptional

Earnings before interest and taxes

Ebitda stringOptional

Earnings before interest, taxes, depreciation, and amortization

Eps stringOptional

Basic earnings per share

EpsDiluted stringOptional

Diluted earnings per share

GeneralAndAdministrativeExpenses stringOptional

General administrative overhead expenses

GrossProfit stringOptional

Revenue minus cost of revenue

IncomeBeforeTax stringOptional

Income before income tax expense

IncomeTaxExpense stringOptional

Income tax expense for the period

InterestExpense stringOptional

Interest paid on debt

InterestIncome stringOptional

Interest earned on investments and cash

NetIncome stringOptional

Total net income for the period

NetIncomeDeductions stringOptional

Deductions from net income

NetIncomeFromContinuingOperations stringOptional

Net income from continuing operations

NetIncomeFromDiscontinuedOperations stringOptional

Net income from discontinued operations

NetInterestIncome stringOptional

Net interest income (interest income minus interest expense)

NonOperatingIncomeExcludingInterest stringOptional

Non-operating income excluding interest

OperatingExpenses stringOptional

Total operating expenses

OperatingIncome stringOptional

Income from core business operations

OtherAdjustmentsToNetIncome stringOptional

Other adjustments to net income

OtherExpenses stringOptional

Other miscellaneous expenses

ResearchAndDevelopmentExpenses stringOptional

Expenditure on research and development activities

Revenue stringOptional

Total revenue from sales of goods and services

SellingAndMarketingExpenses stringOptional

Expenditure on marketing and sales activities

SellingGeneralAndAdministrativeExpenses stringOptional

Combined selling, general, and administrative expenses

TotalOtherIncomeExpensesNet stringOptional

Net of other income and expenses

WeightedAverageShsOut stringOptional

Weighted average shares outstanding (basic)

WeightedAverageShsOutDil stringOptional

Weighted average shares outstanding (diluted)

type InstrumentIpoEvent struct{…}

Represents an IPO event for an instrument

Date Time

The date of the IPO

formatdate

Actions stringOptional

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

AnnouncedAt TimeOptional

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

formatdate-time

Company stringOptional

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

Exchange stringOptional

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

MarketCap stringOptional

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

PriceRange stringOptional

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

Shares stringOptional

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

type InstrumentSplitEvent struct{…}

Represents a stock split event for an instrument

Date Time

The date of the stock split

formatdate

Denominator string

The denominator of the split ratio

Numerator string

The numerator of the split ratio

SplitType string

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

type PriceTarget struct{…}

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

type ReportTime string

Earnings report timing: before market open or after market close

One of the following:

const ReportTimeBmo ReportTime = "BMO"

const ReportTimeAmc ReportTime = "AMC"

Instrument DataMarket Data

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

Get Snapshots

client.V1.InstrumentData.MarketData.GetSnapshots(ctx, query) (*V1InstrumentDataMarketDataGetSnapshotsResponse, error)

GET/v1/market-data/snapshot

Get Daily Aggregate Summaries

Deprecated

client.V1.InstrumentData.MarketData.GetDailySummaries(ctx, query) (*V1InstrumentDataMarketDataGetDailySummariesResponse, error)

GET/v1/market-data/daily-summary

ModelsExpand Collapse

type DailySummary struct{…}

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.

InstrumentID string

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

formatuuid

High stringOptional

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

Low stringOptional

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

NotApplicable boolOptional

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.

Open stringOptional

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

OpenInterest int64Optional

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

Symbol stringOptional

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

TradeDate TimeOptional

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

formatdate

Volume int64Optional

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

formatint64

type DailySummaryList []DailySummary

InstrumentID string

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

formatuuid

High stringOptional

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

Low stringOptional

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

NotApplicable boolOptional

Open stringOptional

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

OpenInterest int64Optional

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

Symbol stringOptional

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

TradeDate TimeOptional

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

formatdate

Volume int64Optional

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

formatint64

type MarketDataSnapshot struct{…}

Market data snapshot for a single security.

InstrumentID string

Unique instrument identifier.

Session SnapshotSession

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

OhlvApplicable bool

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.

Change stringOptional

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.

ChangePercent stringOptional

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.

CumulativeVolume int64Optional

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

High stringOptional

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

Low stringOptional

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

OhlvDate TimeOptional

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

Open stringOptional

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.

PreviousClose stringOptional

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.

PreviousCloseUnadjusted stringOptional

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.

ShortSaleRestricted bool

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.

Symbol string

Display symbol for the security.

DeprecatedCumulativeVolume int64Optional

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

Greeks SnapshotGreeksOptional

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

Delta string

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

Gamma string

Gamma: ∂²V/∂S².

Iv string

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

Rho string

Rho per 1.0 rate point.

TheoPrice string

Theoretical option price in USD per share.

Theta string

Theta per trading day.

Timestamp Time

Timestamp when the Greeks were calculated.

formatdate-time

Vega string

Vega per 1.0 vol point.

LastQuote SnapshotQuoteOptional

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

Ask stringOptional

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.

AskSize int64Optional

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

formatint32

minimum0

AskTimestamp TimeOptional

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

AskVenue stringOptional

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.

Bid stringOptional

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.

BidSize int64Optional

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

formatint32

minimum0

BidTimestamp TimeOptional

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

BidVenue stringOptional

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.

Midpoint stringOptional

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.

LastTrade SnapshotLastTradeOptional

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.

Price string

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

Size int64

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

formatint32

minimum0

Timestamp TimeOptional

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

Venue stringOptional

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.

Name stringOptional

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

OpenInterest int64Optional

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

type MarketDataSnapshotList []MarketDataSnapshot

InstrumentID string

Unique instrument identifier.

Session SnapshotSession

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

OhlvApplicable bool

Change stringOptional

ChangePercent stringOptional

CumulativeVolume int64Optional

formatint64

minimum0

High stringOptional

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

Low stringOptional

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

OhlvDate TimeOptional

formatdate

Open stringOptional

PreviousClose stringOptional

PreviousCloseUnadjusted stringOptional

ShortSaleRestricted bool

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

Symbol string

Display symbol for the security.

DeprecatedCumulativeVolume int64Optional

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

Greeks SnapshotGreeksOptional

Delta string

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

Gamma string

Gamma: ∂²V/∂S².

Iv string

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

Rho string

Rho per 1.0 rate point.

TheoPrice string

Theoretical option price in USD per share.

Theta string

Theta per trading day.

Timestamp Time

Timestamp when the Greeks were calculated.

formatdate-time

Vega string

Vega per 1.0 vol point.

LastQuote SnapshotQuoteOptional

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

Ask stringOptional

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.

AskSize int64Optional

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

formatint32

minimum0

AskTimestamp TimeOptional

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

AskVenue stringOptional

Bid stringOptional

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.

BidSize int64Optional

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

formatint32

minimum0

BidTimestamp TimeOptional

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

BidVenue stringOptional

Midpoint stringOptional

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.

LastTrade SnapshotLastTradeOptional

Price string

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

Size int64

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

formatint32

minimum0

Timestamp TimeOptional

formatdate-time

Venue stringOptional

Name stringOptional

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

OpenInterest int64Optional

formatint64

minimum0

type SnapshotGreeks struct{…}

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

Delta string

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

Gamma string

Gamma: ∂²V/∂S².

Iv string

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

Rho string

Rho per 1.0 rate point.

TheoPrice string

Theoretical option price in USD per share.

Theta string

Theta per trading day.

Timestamp Time

Timestamp when the Greeks were calculated.

formatdate-time

Vega string

Vega per 1.0 vol point.

type SnapshotLastTrade struct{…}

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

Price string

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

Size int64

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

formatint32

minimum0

Timestamp TimeOptional

formatdate-time

Venue stringOptional

type SnapshotQuote struct{…}

L1 quote fields for a market data snapshot.

Ask stringOptional

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.

AskSize int64Optional

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

formatint32

minimum0

AskTimestamp TimeOptional

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

AskVenue stringOptional

Bid stringOptional

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.

BidSize int64Optional

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

formatint32

minimum0

BidTimestamp TimeOptional

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

BidVenue stringOptional

Midpoint stringOptional

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.

type SnapshotSession struct{…}

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.

OhlvApplicable bool

Change stringOptional

ChangePercent stringOptional

CumulativeVolume int64Optional

formatint64

minimum0

High stringOptional

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

Low stringOptional

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

OhlvDate TimeOptional

formatdate

Open stringOptional

PreviousClose stringOptional

PreviousCloseUnadjusted stringOptional

Instrument DataNews

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

Get News

client.V1.InstrumentData.News.GetNews(ctx, query) (*V1InstrumentDataNewsGetNewsResponse, error)

GET/v1/news

ModelsExpand Collapse

type NewsInstrument struct{…}

Instrument associated with a news item.

InstrumentID string

Instrument identifier.

formatuuid

Name stringOptional

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

Symbol stringOptional

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

type NewsItem struct{…}

A single news item and its associated instruments.

Instruments []NewsInstrument

Instruments associated with this news item.

InstrumentID string

Instrument identifier.

formatuuid

Name stringOptional

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

Symbol stringOptional

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:

const NewsTypeNews NewsType = "NEWS"

const NewsTypePressRelease NewsType = "PRESS_RELEASE"

PublishedAt Time

The published date/time of the article in UTC.

formatdate-time

Publisher string

The publisher or newswire source.

Title string

The headline/title of the article.

URL string

Canonical URL to the full article.

ImageURL stringOptional

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

Site stringOptional

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

Text stringOptional

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

type NewsItemList []NewsItem

Instruments []NewsInstrument

Instruments associated with this news item.

InstrumentID string

Instrument identifier.

formatuuid

Name stringOptional

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

Symbol stringOptional

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:

const NewsTypeNews NewsType = "NEWS"

const NewsTypePressRelease NewsType = "PRESS_RELEASE"

PublishedAt Time

The published date/time of the article in UTC.

formatdate-time

Publisher string

The publisher or newswire source.

Title string

The headline/title of the article.

URL string

Canonical URL to the full article.

ImageURL stringOptional

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

Site stringOptional

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

Text stringOptional

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

type NewsType string

News item classification.

One of the following:

const NewsTypeNews NewsType = "NEWS"

const NewsTypePressRelease NewsType = "PRESS_RELEASE"