# Instrument Data ## Get All Instrument Events `client.v1.instrumentData.getAllInstrumentEvents(InstrumentDataGetAllInstrumentEventsParamsquery?, RequestOptionsoptions?): InstrumentDataGetAllInstrumentEventsResponse` **get** `/v1/instruments/events` List instrument events across all securities. Retrieves all instrument events grouped by date. ### Parameters - `query: InstrumentDataGetAllInstrumentEventsParams` - `event_types?: Array` Filter by event type(s). Comma-delimited list. Example: `event_types=EARNINGS,IPO`. - `"EARNINGS"` - `"DIVIDEND"` - `"STOCK_SPLIT"` - `"IPO"` - `from_date?: string` The start date for the query range, inclusive (YYYY-MM-DD). - `instrument_ids?: Array` Filter by OEMS instrument ID(s). Comma-delimited list of UUIDs. Example: `instrument_ids=550e8400-e29b-41d4-a716-446655440000`. - `to_date?: string` The end date for the query range, inclusive (YYYY-MM-DD). ### Returns - `InstrumentDataGetAllInstrumentEventsResponse extends BaseResponse` - `data: InstrumentAllEventsData` All-events payload grouped by date. - `event_dates: Array` Events grouped by date in descending order. - `date: string` Event date. - `events: Array` Flat event envelopes for this date. - `symbol: string` Symbol associated with the event. - `type: AllEventsEventType` Event type discriminator. - `"EARNINGS"` - `"DIVIDEND"` - `"STOCK_SPLIT"` - `"IPO"` - `dividend_event_data?: InstrumentDividendEvent | null` Dividend payload when type is DIVIDEND. - `adjusted_dividend_amount: string` The adjusted dividend amount accounting for any splits. - `ex_date: string` The day the stock starts trading without the right to receive that dividend. - `declaration_date?: string | null` The declaration date of the dividend - `dividend_amount?: string | null` The dividend amount per share. - `dividend_yield?: string | null` The dividend yield as a percentage of the stock price. - `frequency?: string | null` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `payment_date?: string | null` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `record_date?: string | null` The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. - `earnings_event_data?: InstrumentEarnings | null` Earnings payload when type is EARNINGS. - `date: string` The date when the earnings report was published - `eps_actual?: string | null` The actual earnings per share (EPS) for the period - `eps_estimate?: string | null` The estimated earnings per share (EPS) for the period - `eps_surprise_percent?: string | null` The percentage difference between actual and estimated EPS - `revenue_actual?: string | null` The actual total revenue for the period - `revenue_estimate?: string | null` The estimated total revenue for the period - `revenue_surprise_percent?: string | null` The percentage difference between actual and estimated revenue - `instrument_id?: string | null` OEMS instrument identifier, when the instrument is found in the instrument cache. - `ipo_event_data?: InstrumentEventIpoItem | null` IPO payload when type is IPO. - `actions?: string | null` IPO action. - `announced_at?: string | null` IPO announced timestamp. - `company?: string | null` IPO company name. - `exchange?: string | null` IPO exchange. - `market_cap?: string | null` IPO market cap. - `price_range?: string | null` IPO price range. - `shares?: string | null` IPO shares offered. - `name?: string | null` Instrument name associated with the event, when available. - `reporting_currency?: string | null` The currency used for reporting financial data. - `stock_split_event_data?: InstrumentSplitEvent | null` Stock split payload when type is STOCK_SPLIT. - `date: string` The date of the stock split - `denominator: string` The denominator of the split ratio - `numerator: string` The numerator of the split ratio - `split_type: string` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") ### Example ```typescript import ClearStreet from '@clear-street-internal/sdk'; const client = new ClearStreet({ apiKey: 'My API Key', }); const response = await client.v1.instrumentData.getAllInstrumentEvents(); console.log(response); ``` #### Response ```json { "data": { "event_dates": [ { "date": "2026-04-23", "events": [ { "dividend_event_data": { "adjusted_dividend_amount": "0.5236", "declaration_date": "2026-04-22", "dividend_amount": "0.5236", "dividend_yield": "43.82881469863321", "ex_date": "2026-04-23", "frequency": "Weekly", "payment_date": "2026-04-24", "record_date": "2026-04-23" }, "instrument_id": "2281b543-7136-4008-aa0a-a402bf9d9f90", "name": "YieldMax ABNB Option Income Strategy ETF", "reporting_currency": "USD", "symbol": "ABNY", "type": "DIVIDEND" }, { "dividend_event_data": { "adjusted_dividend_amount": "0.1432", "declaration_date": "2026-04-22", "dividend_amount": "0.1432", "dividend_yield": "181.7918287937743", "ex_date": "2026-04-23", "frequency": "Weekly", "payment_date": "2026-04-24", "record_date": "2026-04-23" }, "instrument_id": "4b33fa52-8ab6-43f5-a8df-042e0c63d20e", "name": "YieldMax AI Option Income Strategy ETF", "reporting_currency": "USD", "symbol": "AIYY", "type": "DIVIDEND" } ] } ] }, "metadata": { "request_id": "5efbf08a-9067-4491-9f29-cf0b233507ef" } } ``` ## Get Instrument Events `client.v1.instrumentData.getInstrumentEvents(InstrumentIDOrSymbolinstrumentID, InstrumentDataGetInstrumentEventsParamsquery?, RequestOptionsoptions?): InstrumentDataGetInstrumentEventsResponse` **get** `/v1/instruments/{instrument_id}/events` Retrieves corporate events (dividends, splits, etc.) for an instrument, grouped by event type. Date range defaults: - `from_date`: today - 365 days - `to_date`: today + 60 days ### Parameters - `instrument_id: InstrumentIDOrSymbol` OEMS instrument UUID - `query: InstrumentDataGetInstrumentEventsParams` - `from_date?: string` The start date for the query range, inclusive (YYYY-MM-DD). - `to_date?: string` The end date for the query range, inclusive (YYYY-MM-DD). ### Returns - `InstrumentDataGetInstrumentEventsResponse extends BaseResponse` - `data: InstrumentEventsData` Grouped instrument events by type - `dividends: Array` Dividend distribution events - `adjusted_dividend_amount: string` The adjusted dividend amount accounting for any splits. - `ex_date: string` The day the stock starts trading without the right to receive that dividend. - `declaration_date?: string | null` The declaration date of the dividend - `dividend_amount?: string | null` The dividend amount per share. - `dividend_yield?: string | null` The dividend yield as a percentage of the stock price. - `frequency?: string | null` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `payment_date?: string | null` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `record_date?: string | null` The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. - `earnings: Array` Earnings announcement events - `date: string` The date when the earnings report was published - `eps_actual?: string | null` The actual earnings per share (EPS) for the period - `eps_estimate?: string | null` The estimated earnings per share (EPS) for the period - `eps_surprise_percent?: string | null` The percentage difference between actual and estimated EPS - `revenue_actual?: string | null` The actual total revenue for the period - `revenue_estimate?: string | null` The estimated total revenue for the period - `revenue_surprise_percent?: string | null` The percentage difference between actual and estimated revenue - `instrument_id: string` OEMS instrument UUID from the request - `splits: Array` Stock split events - `date: string` The date of the stock split - `denominator: string` The denominator of the split ratio - `numerator: string` The numerator of the split ratio - `split_type: string` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") - `reporting_currency?: string | null` The currency used for reporting financial data ### Example ```typescript import ClearStreet from '@clear-street-internal/sdk'; const client = new ClearStreet({ apiKey: 'My API Key', }); const response = await client.v1.instrumentData.getInstrumentEvents( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', ); console.log(response); ``` #### Response ```json { "data": { "dividends": [ { "adjusted_dividend_amount": "0.25", "declaration_date": "2024-10-31", "dividend_amount": "0.25", "dividend_yield": "0.44", "ex_date": "2024-11-08", "frequency": "Quarterly", "payment_date": "2024-11-14", "record_date": "2024-11-11" } ], "earnings": [ { "date": "2024-10-31", "eps_actual": "1.64", "eps_estimate": "1.60", "eps_surprise_percent": "2.5", "revenue_actual": "94930000000", "revenue_estimate": "94500000000", "revenue_surprise_percent": "0.45" } ], "instrument_id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8", "reporting_currency": "USD", "splits": [ { "date": "2020-08-31", "denominator": "1", "numerator": "4", "split_type": "stock-split" } ] }, "error": null, "metadata": { "request_id": "0f1a2b3c-4d5e-6789-8a7b-6c5d4e3f2a1b" } } ``` ## Get Instrument Fundamentals `client.v1.instrumentData.getInstrumentFundamentals(InstrumentIDOrSymbolinstrumentID, RequestOptionsoptions?): InstrumentDataGetInstrumentFundamentalsResponse` **get** `/v1/instruments/{instrument_id}/fundamentals` Retrieves supplemental fundamentals and company profile data for an instrument. ### Parameters - `instrument_id: InstrumentIDOrSymbol` OEMS instrument UUID ### Returns - `InstrumentDataGetInstrumentFundamentalsResponse extends BaseResponse` - `data: InstrumentFundamentals` Supplemental fundamentals and company profile data for an instrument. - `average_volume?: number | null` The average daily trading volume over the past 30 days - `beta?: string | null` The beta value, measuring the instrument's volatility relative to the overall market - `description?: string | null` A detailed description of the instrument or company - `dividend_yield?: string | null` The trailing twelve months (TTM) dividend yield - `earnings_per_share?: string | null` The trailing twelve months (TTM) earnings per share - `fifty_two_week_high?: string | null` The highest price over the last 52 weeks - `fifty_two_week_low?: string | null` The lowest price over the last 52 weeks - `industry?: string | null` The specific industry of the instrument's issuer - `list_date?: string | null` The date the instrument was first listed - `logo_url?: string | null` URL to a representative logo image for the instrument or issuer - `market_cap?: string | null` The total market capitalization - `previous_close?: string | null` The closing price from the previous trading day - `price_to_earnings?: string | null` The price-to-earnings (P/E) ratio for the trailing twelve months (TTM) - `reporting_currency?: string | null` The currency used for reporting financial data - `sector?: string | null` The business sector of the instrument's issuer ### Example ```typescript import ClearStreet from '@clear-street-internal/sdk'; const client = new ClearStreet({ apiKey: 'My API Key', }); const response = await client.v1.instrumentData.getInstrumentFundamentals( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', ); console.log(response); ``` #### Response ```json { "data": { "average_volume": 76000000, "beta": "1.20", "description": "Apple Inc. designs, manufactures, and markets smartphones, personal computers, tablets, wearables, and accessories worldwide.", "dividend_yield": "0.005", "earnings_per_share": "5.61", "fifty_two_week_high": "230.00", "fifty_two_week_low": "165.00", "industry": "Consumer Electronics", "list_date": "1980-12-12", "logo_url": "https://example.com/logos/aapl.png", "market_cap": "2800000000000", "previous_close": "210.87", "price_to_earnings": "30.5", "reporting_currency": "USD", "sector": "Technology" }, "error": null, "metadata": { "request_id": "5b6c7d8e-9f0a-1b2c-3d4e-5f6a7b8c9d0e" } } ``` ## Get Instrument Balance Sheet Statements `client.v1.instrumentData.getInstrumentBalanceSheetStatements(InstrumentIDOrSymbolinstrumentID, InstrumentDataGetInstrumentBalanceSheetStatementsParamsquery?, RequestOptionsoptions?): InstrumentDataGetInstrumentBalanceSheetStatementsResponse` **get** `/v1/instruments/{instrument_id}/balance-sheets` Get balance sheet statements for an instrument. Retrieves quarterly balance sheet statements for a specific instrument, sorted by fiscal period (most recent first). Date range defaults: - `from_date`: None (no lower bound) - `to_date`: None (no upper bound) ### Parameters - `instrument_id: InstrumentIDOrSymbol` OEMS instrument UUID - `query: InstrumentDataGetInstrumentBalanceSheetStatementsParams` - `from_date?: string` The start date for the query range, inclusive (YYYY-MM-DD). - `page_size?: number` The number of items to return per page. Only used when page_token is not provided. - `page_token?: string` Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored. - `to_date?: string` The end date for the query range, inclusive (YYYY-MM-DD). ### Returns - `InstrumentDataGetInstrumentBalanceSheetStatementsResponse extends BaseResponse` - `data: InstrumentBalanceSheetStatementList` - `accepted_date: string` The date and time when the filing was accepted by the SEC - `filing_date: string` The date the financial statement was filed - `period: string` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: string` The currency in which the statement is reported (ISO 4217) - `year: number` The fiscal year of the statement - `account_payables?: string | null` Account payables - `accounts_receivables?: string | null` Accounts receivables - `accrued_expenses?: string | null` Accrued expenses - `accumulated_other_comprehensive_income_loss?: string | null` Accumulated other comprehensive income/loss - `additional_paid_in_capital?: string | null` Additional paid-in capital - `capital_lease_obligations?: string | null` Capital lease obligations (total) - `capital_lease_obligations_current?: string | null` Capital lease obligations (current portion) - `cash_and_cash_equivalents?: string | null` Cash and cash equivalents - `cash_and_short_term_investments?: string | null` Cash and short-term investments combined - `common_stock?: string | null` Common stock - `deferred_revenue?: string | null` Deferred revenue - `deferred_revenue_non_current?: string | null` Deferred revenue (non-current) - `deferred_tax_liabilities_non_current?: string | null` Deferred tax liabilities (non-current) - `goodwill?: string | null` Goodwill - `goodwill_and_intangible_assets?: string | null` Goodwill and intangible assets combined - `intangible_assets?: string | null` Intangible assets - `inventory?: string | null` Inventory - `long_term_debt?: string | null` Long-term debt - `long_term_investments?: string | null` Long-term investments - `minority_interest?: string | null` Minority interest - `net_debt?: string | null` Net debt (total debt minus cash) - `net_receivables?: string | null` Net receivables - `other_assets?: string | null` Other assets - `other_current_assets?: string | null` Other current assets - `other_current_liabilities?: string | null` Other current liabilities - `other_liabilities?: string | null` Other liabilities - `other_non_current_assets?: string | null` Other non-current assets - `other_non_current_liabilities?: string | null` Other non-current liabilities - `other_payables?: string | null` Other payables - `other_receivables?: string | null` Other receivables - `other_total_stockholders_equity?: string | null` Other total stockholders equity - `preferred_stock?: string | null` Preferred stock - `prepaids?: string | null` Prepaids - `property_plant_and_equipment_net?: string | null` Property, plant and equipment net of depreciation - `retained_earnings?: string | null` Retained earnings - `short_term_debt?: string | null` Short-term debt - `short_term_investments?: string | null` Short-term investments - `tax_assets?: string | null` Tax assets - `tax_payables?: string | null` Tax payables - `total_assets?: string | null` Total assets - `total_current_assets?: string | null` Total current assets - `total_current_liabilities?: string | null` Total current liabilities - `total_debt?: string | null` Total debt - `total_equity?: string | null` Total equity - `total_investments?: string | null` Total investments - `total_liabilities?: string | null` Total liabilities - `total_liabilities_and_total_equity?: string | null` Total liabilities and total equity - `total_non_current_assets?: string | null` Total non-current assets - `total_non_current_liabilities?: string | null` Total non-current liabilities - `total_payables?: string | null` Total payables - `total_stockholders_equity?: string | null` Total stockholders equity - `treasury_stock?: string | null` Treasury stock ### Example ```typescript import ClearStreet from '@clear-street-internal/sdk'; const client = new ClearStreet({ apiKey: 'My API Key', }); const response = await client.v1.instrumentData.getInstrumentBalanceSheetStatements( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', ); console.log(response); ``` #### Response ```json { "data": [ { "accepted_date": "2025-05-02T14:30:00Z", "cash_and_cash_equivalents": "29943000000", "filing_date": "2025-05-01", "net_debt": "76323000000", "period": "Q1", "period_type": "QUARTERLY", "reported_currency": "USD", "total_assets": "352583000000", "total_debt": "106266000000", "total_liabilities": "308258000000", "total_stockholders_equity": "56727000000", "year": 2025 } ], "error": null, "metadata": { "next_page_token": "AAAAAAAAAGQAAAAAAAAAZQ==", "page_number": 1, "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "total_items": 20, "total_pages": 2 } } ``` ## Get Instrument Income Statements `client.v1.instrumentData.getInstrumentIncomeStatements(InstrumentIDOrSymbolinstrumentID, InstrumentDataGetInstrumentIncomeStatementsParamsquery?, RequestOptionsoptions?): InstrumentDataGetInstrumentIncomeStatementsResponse` **get** `/v1/instruments/{instrument_id}/income-statements` Retrieves quarterly income statements for a specific instrument, sorted by fiscal period (most recent first). Date range defaults: - `from_date`: None (no lower bound) - `to_date`: None (no upper bound) ### Parameters - `instrument_id: InstrumentIDOrSymbol` OEMS instrument UUID - `query: InstrumentDataGetInstrumentIncomeStatementsParams` - `from_date?: string` The start date for the query range, inclusive (YYYY-MM-DD). - `page_size?: number` The number of items to return per page. Only used when page_token is not provided. - `page_token?: string` Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored. - `to_date?: string` The end date for the query range, inclusive (YYYY-MM-DD). ### Returns - `InstrumentDataGetInstrumentIncomeStatementsResponse extends BaseResponse` - `data: InstrumentIncomeStatementList` - `accepted_date: string` The date and time when the filing was accepted by the SEC - `filing_date: string` The date the financial statement was filed - `period: string` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: string` The currency in which the statement is reported (ISO 4217) - `year: number` The fiscal year of the statement - `bottom_line_net_income?: string | null` Bottom line net income after all adjustments - `cost_and_expenses?: string | null` Total costs and expenses - `cost_of_revenue?: string | null` Direct costs attributable to producing goods sold - `depreciation_and_amortization?: string | null` Depreciation and amortization expenses - `ebit?: string | null` Earnings before interest and taxes - `ebitda?: string | null` Earnings before interest, taxes, depreciation, and amortization - `eps?: string | null` Basic earnings per share - `eps_diluted?: string | null` Diluted earnings per share - `general_and_administrative_expenses?: string | null` General administrative overhead expenses - `gross_profit?: string | null` Revenue minus cost of revenue - `income_before_tax?: string | null` Income before income tax expense - `income_tax_expense?: string | null` Income tax expense for the period - `interest_expense?: string | null` Interest paid on debt - `interest_income?: string | null` Interest earned on investments and cash - `net_income?: string | null` Total net income for the period - `net_income_deductions?: string | null` Deductions from net income - `net_income_from_continuing_operations?: string | null` Net income from continuing operations - `net_income_from_discontinued_operations?: string | null` Net income from discontinued operations - `net_interest_income?: string | null` Net interest income (interest income minus interest expense) - `non_operating_income_excluding_interest?: string | null` Non-operating income excluding interest - `operating_expenses?: string | null` Total operating expenses - `operating_income?: string | null` Income from core business operations - `other_adjustments_to_net_income?: string | null` Other adjustments to net income - `other_expenses?: string | null` Other miscellaneous expenses - `research_and_development_expenses?: string | null` Expenditure on research and development activities - `revenue?: string | null` Total revenue from sales of goods and services - `selling_and_marketing_expenses?: string | null` Expenditure on marketing and sales activities - `selling_general_and_administrative_expenses?: string | null` Combined selling, general, and administrative expenses - `total_other_income_expenses_net?: string | null` Net of other income and expenses - `weighted_average_shs_out?: string | null` Weighted average shares outstanding (basic) - `weighted_average_shs_out_dil?: string | null` Weighted average shares outstanding (diluted) ### Example ```typescript import ClearStreet from '@clear-street-internal/sdk'; const client = new ClearStreet({ apiKey: 'My API Key', }); const response = await client.v1.instrumentData.getInstrumentIncomeStatements( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', ); console.log(response); ``` #### Response ```json { "data": [ { "accepted_date": "2025-05-02T14:30:00Z", "cost_of_revenue": "52080000000", "eps": "1.40", "eps_diluted": "1.38", "filing_date": "2025-05-01", "gross_profit": "42850000000", "net_income": "22200000000", "operating_income": "26550000000", "period": "Q1", "period_type": "QUARTERLY", "reported_currency": "USD", "revenue": "94930000000", "year": 2025 } ], "error": null, "metadata": { "next_page_token": "AAAAAAAAAGQAAAAAAAAAZQ==", "page_number": 1, "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "total_items": 20, "total_pages": 2 } } ``` ## Get Instrument Analyst Consensus `client.v1.instrumentData.getInstrumentAnalystConsensus(InstrumentIDOrSymbolinstrumentID, InstrumentDataGetInstrumentAnalystConsensusParamsquery?, RequestOptionsoptions?): InstrumentDataGetInstrumentAnalystConsensusResponse` **get** `/v1/instruments/{instrument_id}/analyst-reporting` Retrieves analyst ratings and price targets for an instrument. ### Parameters - `instrument_id: InstrumentIDOrSymbol` OEMS instrument UUID - `query: InstrumentDataGetInstrumentAnalystConsensusParams` - `from?: string` The start date for the query range, inclusive (YYYY-MM-DD) - `to?: string` The end date for the query range, inclusive (YYYY-MM-DD) ### Returns - `InstrumentDataGetInstrumentAnalystConsensusResponse extends BaseResponse` - `data: InstrumentAnalystConsensus` Aggregated analyst consensus metrics - `date: string` The date the consensus snapshot was generated - `distribution?: AnalystDistribution | null` Count of individual analyst recommendations by category - `buy: number` Number of buy recommendations - `hold: number` Number of hold recommendations - `sell: number` Number of sell recommendations - `strong_buy: number` Number of strong buy recommendations - `strong_sell: number` Number of strong sell recommendations - `price_target?: PriceTarget | null` Aggregated analyst price target statistics - `average: string` Average analyst price target - `currency: string` ISO 4217 currency code of the price targets - `high: string` Highest analyst price target - `low: string` Lowest analyst price target - `rating?: AnalystRating | null` Consensus analyst rating - `"STRONG_BUY"` - `"BUY"` - `"HOLD"` - `"SELL"` - `"STRONG_SELL"` ### Example ```typescript import ClearStreet from '@clear-street-internal/sdk'; const client = new ClearStreet({ apiKey: 'My API Key', }); const response = await client.v1.instrumentData.getInstrumentAnalystConsensus( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', ); console.log(response); ``` #### Response ```json { "data": { "date": "2025-10-01", "distribution": { "buy": 20, "hold": 3, "sell": 1, "strong_buy": 18, "strong_sell": 0 }, "price_target": { "average": "240.00", "currency": "USD", "high": "275.00", "low": "190.00" }, "rating": "BUY" }, "error": null, "metadata": { "request_id": "9e0f1a2b-3c4d-5e6f-7890-1a2b3c4d5e6f" } } ``` ## Get Instrument Cash Flow Statements `client.v1.instrumentData.getInstrumentCashFlowStatements(InstrumentIDOrSymbolinstrumentID, InstrumentDataGetInstrumentCashFlowStatementsParamsquery?, RequestOptionsoptions?): InstrumentDataGetInstrumentCashFlowStatementsResponse` **get** `/v1/instruments/{instrument_id}/cash-flow-statements` Get cash flow statements for an instrument. Retrieves historical cash flow statements for the specified instrument. Cash flow statements show cash inflows and outflows from operating, investing, and financing activities. ### Parameters - `instrument_id: InstrumentIDOrSymbol` OEMS instrument UUID - `query: InstrumentDataGetInstrumentCashFlowStatementsParams` - `from_date?: string` The start date for the query range, inclusive (YYYY-MM-DD). - `page_size?: number` The number of items to return per page. Only used when page_token is not provided. - `page_token?: string` Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored. - `to_date?: string` The end date for the query range, inclusive (YYYY-MM-DD). ### Returns - `InstrumentDataGetInstrumentCashFlowStatementsResponse extends BaseResponse` - `data: InstrumentCashFlowStatementList` - `accepted_date: string` The date and time when the filing was accepted by the SEC - `filing_date: string` The date the financial statement was filed - `period: string` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: string` The currency in which the statement is reported (ISO 4217) - `year: number` The fiscal year of the statement - `accounts_payables?: string | null` Change in accounts payables - `accounts_receivables?: string | null` Change in accounts receivables - `acquisitions_net?: string | null` Net acquisitions - `capital_expenditure?: string | null` Capital expenditure - `cash_at_beginning_of_period?: string | null` Cash and cash equivalents at beginning of period - `cash_at_end_of_period?: string | null` Cash and cash equivalents at end of period - `change_in_working_capital?: string | null` Change in working capital - `common_dividends_paid?: string | null` Common dividends paid - `common_stock_issuance?: string | null` Common stock issuance - `common_stock_repurchased?: string | null` Common stock repurchased (buybacks) - `deferred_income_tax?: string | null` Deferred income tax expense - `depreciation_and_amortization?: string | null` Depreciation and amortization expense - `effect_of_forex_changes_on_cash?: string | null` Effect of foreign exchange changes on cash - `free_cash_flow?: string | null` Free cash flow (operating cash flow minus capital expenditure) - `income_taxes_paid?: string | null` Income taxes paid - `interest_paid?: string | null` Interest paid - `inventory?: string | null` Change in inventory - `investments_in_property_plant_and_equipment?: string | null` Investments in property, plant, and equipment - `long_term_net_debt_issuance?: string | null` Long-term net debt issuance - `net_cash_provided_by_financing_activities?: string | null` Net cash provided by financing activities - `net_cash_provided_by_investing_activities?: string | null` Net cash provided by investing activities - `net_cash_provided_by_operating_activities?: string | null` Net cash provided by operating activities - `net_change_in_cash?: string | null` Net change in cash during the period - `net_common_stock_issuance?: string | null` Net common stock issuance - `net_debt_issuance?: string | null` Net debt issuance (long-term + short-term) - `net_dividends_paid?: string | null` Net dividends paid (common + preferred) - `net_income?: string | null` Net income for the period - `net_preferred_stock_issuance?: string | null` Net preferred stock issuance - `net_stock_issuance?: string | null` Net stock issuance (common + preferred) - `operating_cash_flow?: string | null` Operating cash flow (alternative calculation) - `other_financing_activities?: string | null` Other financing activities - `other_investing_activities?: string | null` Other investing activities - `other_non_cash_items?: string | null` Other non-cash items - `other_working_capital?: string | null` Change in other working capital - `preferred_dividends_paid?: string | null` Preferred dividends paid - `purchases_of_investments?: string | null` Purchases of investments - `sales_maturities_of_investments?: string | null` Sales and maturities of investments - `short_term_net_debt_issuance?: string | null` Short-term net debt issuance - `stock_based_compensation?: string | null` Stock-based compensation expense ### Example ```typescript import ClearStreet from '@clear-street-internal/sdk'; const client = new ClearStreet({ apiKey: 'My API Key', }); const response = await client.v1.instrumentData.getInstrumentCashFlowStatements( '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e', ); console.log(response); ``` #### Response ```json { "data": [ { "accepted_date": "2025-05-02T14:30:00Z", "capital_expenditure": "-2600000000", "cash_at_beginning_of_period": "33743000000", "cash_at_end_of_period": "29943000000", "change_in_working_capital": "-3200000000", "common_stock_repurchased": "-23000000000", "depreciation_and_amortization": "2900000000", "filing_date": "2025-05-01", "free_cash_flow": "25800000000", "investments_in_property_plant_and_equipment": "-2600000000", "net_cash_provided_by_financing_activities": "-28300000000", "net_cash_provided_by_investing_activities": "-3900000000", "net_cash_provided_by_operating_activities": "28400000000", "net_change_in_cash": "-3800000000", "net_debt_issuance": "-1500000000", "net_dividends_paid": "-3800000000", "net_income": "22200000000", "operating_cash_flow": "28400000000", "period": "Q1", "period_type": "QUARTERLY", "purchases_of_investments": "-9500000000", "reported_currency": "USD", "sales_maturities_of_investments": "8200000000", "stock_based_compensation": "2500000000", "year": 2025 } ], "error": null, "metadata": { "next_page_token": "AAAAAAAAAGQAAAAAAAAAZQ==", "page_number": 1, "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "total_items": 20, "total_pages": 2 } } ``` ## Domain Types ### All Events Event Type - `AllEventsEventType = "EARNINGS" | "DIVIDEND" | "STOCK_SPLIT" | "IPO"` Event types supported by the all-events endpoint. - `"EARNINGS"` - `"DIVIDEND"` - `"STOCK_SPLIT"` - `"IPO"` ### Analyst Distribution - `AnalystDistribution` Analyst recommendation distribution - `buy: number` Number of buy recommendations - `hold: number` Number of hold recommendations - `sell: number` Number of sell recommendations - `strong_buy: number` Number of strong buy recommendations - `strong_sell: number` Number of strong sell recommendations ### Analyst Rating - `AnalystRating = "STRONG_BUY" | "BUY" | "HOLD" | 2 more` Analyst rating category - `"STRONG_BUY"` - `"BUY"` - `"HOLD"` - `"SELL"` - `"STRONG_SELL"` ### Fiscal Period Type - `FiscalPeriodType = "QUARTERLY" | "ANNUAL" | "TTM" | "BIANNUAL"` Fiscal period type for earnings reports - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` ### Instrument All Events Data - `InstrumentAllEventsData` All-events payload grouped by date. - `event_dates: Array` Events grouped by date in descending order. - `date: string` Event date. - `events: Array` Flat event envelopes for this date. - `symbol: string` Symbol associated with the event. - `type: AllEventsEventType` Event type discriminator. - `"EARNINGS"` - `"DIVIDEND"` - `"STOCK_SPLIT"` - `"IPO"` - `dividend_event_data?: InstrumentDividendEvent | null` Dividend payload when type is DIVIDEND. - `adjusted_dividend_amount: string` The adjusted dividend amount accounting for any splits. - `ex_date: string` The day the stock starts trading without the right to receive that dividend. - `declaration_date?: string | null` The declaration date of the dividend - `dividend_amount?: string | null` The dividend amount per share. - `dividend_yield?: string | null` The dividend yield as a percentage of the stock price. - `frequency?: string | null` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `payment_date?: string | null` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `record_date?: string | null` The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. - `earnings_event_data?: InstrumentEarnings | null` Earnings payload when type is EARNINGS. - `date: string` The date when the earnings report was published - `eps_actual?: string | null` The actual earnings per share (EPS) for the period - `eps_estimate?: string | null` The estimated earnings per share (EPS) for the period - `eps_surprise_percent?: string | null` The percentage difference between actual and estimated EPS - `revenue_actual?: string | null` The actual total revenue for the period - `revenue_estimate?: string | null` The estimated total revenue for the period - `revenue_surprise_percent?: string | null` The percentage difference between actual and estimated revenue - `instrument_id?: string | null` OEMS instrument identifier, when the instrument is found in the instrument cache. - `ipo_event_data?: InstrumentEventIpoItem | null` IPO payload when type is IPO. - `actions?: string | null` IPO action. - `announced_at?: string | null` IPO announced timestamp. - `company?: string | null` IPO company name. - `exchange?: string | null` IPO exchange. - `market_cap?: string | null` IPO market cap. - `price_range?: string | null` IPO price range. - `shares?: string | null` IPO shares offered. - `name?: string | null` Instrument name associated with the event, when available. - `reporting_currency?: string | null` The currency used for reporting financial data. - `stock_split_event_data?: InstrumentSplitEvent | null` Stock split payload when type is STOCK_SPLIT. - `date: string` The date of the stock split - `denominator: string` The denominator of the split ratio - `numerator: string` The numerator of the split ratio - `split_type: string` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") ### Instrument Analyst Consensus - `InstrumentAnalystConsensus` Aggregated analyst consensus metrics - `date: string` The date the consensus snapshot was generated - `distribution?: AnalystDistribution | null` Count of individual analyst recommendations by category - `buy: number` Number of buy recommendations - `hold: number` Number of hold recommendations - `sell: number` Number of sell recommendations - `strong_buy: number` Number of strong buy recommendations - `strong_sell: number` Number of strong sell recommendations - `price_target?: PriceTarget | null` Aggregated analyst price target statistics - `average: string` Average analyst price target - `currency: string` ISO 4217 currency code of the price targets - `high: string` Highest analyst price target - `low: string` Lowest analyst price target - `rating?: AnalystRating | null` Consensus analyst rating - `"STRONG_BUY"` - `"BUY"` - `"HOLD"` - `"SELL"` - `"STRONG_SELL"` ### Instrument Balance Sheet Statement - `InstrumentBalanceSheetStatement` A quarterly balance sheet statement for an instrument. - `accepted_date: string` The date and time when the filing was accepted by the SEC - `filing_date: string` The date the financial statement was filed - `period: string` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: string` The currency in which the statement is reported (ISO 4217) - `year: number` The fiscal year of the statement - `account_payables?: string | null` Account payables - `accounts_receivables?: string | null` Accounts receivables - `accrued_expenses?: string | null` Accrued expenses - `accumulated_other_comprehensive_income_loss?: string | null` Accumulated other comprehensive income/loss - `additional_paid_in_capital?: string | null` Additional paid-in capital - `capital_lease_obligations?: string | null` Capital lease obligations (total) - `capital_lease_obligations_current?: string | null` Capital lease obligations (current portion) - `cash_and_cash_equivalents?: string | null` Cash and cash equivalents - `cash_and_short_term_investments?: string | null` Cash and short-term investments combined - `common_stock?: string | null` Common stock - `deferred_revenue?: string | null` Deferred revenue - `deferred_revenue_non_current?: string | null` Deferred revenue (non-current) - `deferred_tax_liabilities_non_current?: string | null` Deferred tax liabilities (non-current) - `goodwill?: string | null` Goodwill - `goodwill_and_intangible_assets?: string | null` Goodwill and intangible assets combined - `intangible_assets?: string | null` Intangible assets - `inventory?: string | null` Inventory - `long_term_debt?: string | null` Long-term debt - `long_term_investments?: string | null` Long-term investments - `minority_interest?: string | null` Minority interest - `net_debt?: string | null` Net debt (total debt minus cash) - `net_receivables?: string | null` Net receivables - `other_assets?: string | null` Other assets - `other_current_assets?: string | null` Other current assets - `other_current_liabilities?: string | null` Other current liabilities - `other_liabilities?: string | null` Other liabilities - `other_non_current_assets?: string | null` Other non-current assets - `other_non_current_liabilities?: string | null` Other non-current liabilities - `other_payables?: string | null` Other payables - `other_receivables?: string | null` Other receivables - `other_total_stockholders_equity?: string | null` Other total stockholders equity - `preferred_stock?: string | null` Preferred stock - `prepaids?: string | null` Prepaids - `property_plant_and_equipment_net?: string | null` Property, plant and equipment net of depreciation - `retained_earnings?: string | null` Retained earnings - `short_term_debt?: string | null` Short-term debt - `short_term_investments?: string | null` Short-term investments - `tax_assets?: string | null` Tax assets - `tax_payables?: string | null` Tax payables - `total_assets?: string | null` Total assets - `total_current_assets?: string | null` Total current assets - `total_current_liabilities?: string | null` Total current liabilities - `total_debt?: string | null` Total debt - `total_equity?: string | null` Total equity - `total_investments?: string | null` Total investments - `total_liabilities?: string | null` Total liabilities - `total_liabilities_and_total_equity?: string | null` Total liabilities and total equity - `total_non_current_assets?: string | null` Total non-current assets - `total_non_current_liabilities?: string | null` Total non-current liabilities - `total_payables?: string | null` Total payables - `total_stockholders_equity?: string | null` Total stockholders equity - `treasury_stock?: string | null` Treasury stock ### Instrument Balance Sheet Statement List - `InstrumentBalanceSheetStatementList = Array` - `accepted_date: string` The date and time when the filing was accepted by the SEC - `filing_date: string` The date the financial statement was filed - `period: string` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: string` The currency in which the statement is reported (ISO 4217) - `year: number` The fiscal year of the statement - `account_payables?: string | null` Account payables - `accounts_receivables?: string | null` Accounts receivables - `accrued_expenses?: string | null` Accrued expenses - `accumulated_other_comprehensive_income_loss?: string | null` Accumulated other comprehensive income/loss - `additional_paid_in_capital?: string | null` Additional paid-in capital - `capital_lease_obligations?: string | null` Capital lease obligations (total) - `capital_lease_obligations_current?: string | null` Capital lease obligations (current portion) - `cash_and_cash_equivalents?: string | null` Cash and cash equivalents - `cash_and_short_term_investments?: string | null` Cash and short-term investments combined - `common_stock?: string | null` Common stock - `deferred_revenue?: string | null` Deferred revenue - `deferred_revenue_non_current?: string | null` Deferred revenue (non-current) - `deferred_tax_liabilities_non_current?: string | null` Deferred tax liabilities (non-current) - `goodwill?: string | null` Goodwill - `goodwill_and_intangible_assets?: string | null` Goodwill and intangible assets combined - `intangible_assets?: string | null` Intangible assets - `inventory?: string | null` Inventory - `long_term_debt?: string | null` Long-term debt - `long_term_investments?: string | null` Long-term investments - `minority_interest?: string | null` Minority interest - `net_debt?: string | null` Net debt (total debt minus cash) - `net_receivables?: string | null` Net receivables - `other_assets?: string | null` Other assets - `other_current_assets?: string | null` Other current assets - `other_current_liabilities?: string | null` Other current liabilities - `other_liabilities?: string | null` Other liabilities - `other_non_current_assets?: string | null` Other non-current assets - `other_non_current_liabilities?: string | null` Other non-current liabilities - `other_payables?: string | null` Other payables - `other_receivables?: string | null` Other receivables - `other_total_stockholders_equity?: string | null` Other total stockholders equity - `preferred_stock?: string | null` Preferred stock - `prepaids?: string | null` Prepaids - `property_plant_and_equipment_net?: string | null` Property, plant and equipment net of depreciation - `retained_earnings?: string | null` Retained earnings - `short_term_debt?: string | null` Short-term debt - `short_term_investments?: string | null` Short-term investments - `tax_assets?: string | null` Tax assets - `tax_payables?: string | null` Tax payables - `total_assets?: string | null` Total assets - `total_current_assets?: string | null` Total current assets - `total_current_liabilities?: string | null` Total current liabilities - `total_debt?: string | null` Total debt - `total_equity?: string | null` Total equity - `total_investments?: string | null` Total investments - `total_liabilities?: string | null` Total liabilities - `total_liabilities_and_total_equity?: string | null` Total liabilities and total equity - `total_non_current_assets?: string | null` Total non-current assets - `total_non_current_liabilities?: string | null` Total non-current liabilities - `total_payables?: string | null` Total payables - `total_stockholders_equity?: string | null` Total stockholders equity - `treasury_stock?: string | null` Treasury stock ### Instrument Cash Flow Statement - `InstrumentCashFlowStatement` A quarterly cash flow statement for an instrument. - `accepted_date: string` The date and time when the filing was accepted by the SEC - `filing_date: string` The date the financial statement was filed - `period: string` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: string` The currency in which the statement is reported (ISO 4217) - `year: number` The fiscal year of the statement - `accounts_payables?: string | null` Change in accounts payables - `accounts_receivables?: string | null` Change in accounts receivables - `acquisitions_net?: string | null` Net acquisitions - `capital_expenditure?: string | null` Capital expenditure - `cash_at_beginning_of_period?: string | null` Cash and cash equivalents at beginning of period - `cash_at_end_of_period?: string | null` Cash and cash equivalents at end of period - `change_in_working_capital?: string | null` Change in working capital - `common_dividends_paid?: string | null` Common dividends paid - `common_stock_issuance?: string | null` Common stock issuance - `common_stock_repurchased?: string | null` Common stock repurchased (buybacks) - `deferred_income_tax?: string | null` Deferred income tax expense - `depreciation_and_amortization?: string | null` Depreciation and amortization expense - `effect_of_forex_changes_on_cash?: string | null` Effect of foreign exchange changes on cash - `free_cash_flow?: string | null` Free cash flow (operating cash flow minus capital expenditure) - `income_taxes_paid?: string | null` Income taxes paid - `interest_paid?: string | null` Interest paid - `inventory?: string | null` Change in inventory - `investments_in_property_plant_and_equipment?: string | null` Investments in property, plant, and equipment - `long_term_net_debt_issuance?: string | null` Long-term net debt issuance - `net_cash_provided_by_financing_activities?: string | null` Net cash provided by financing activities - `net_cash_provided_by_investing_activities?: string | null` Net cash provided by investing activities - `net_cash_provided_by_operating_activities?: string | null` Net cash provided by operating activities - `net_change_in_cash?: string | null` Net change in cash during the period - `net_common_stock_issuance?: string | null` Net common stock issuance - `net_debt_issuance?: string | null` Net debt issuance (long-term + short-term) - `net_dividends_paid?: string | null` Net dividends paid (common + preferred) - `net_income?: string | null` Net income for the period - `net_preferred_stock_issuance?: string | null` Net preferred stock issuance - `net_stock_issuance?: string | null` Net stock issuance (common + preferred) - `operating_cash_flow?: string | null` Operating cash flow (alternative calculation) - `other_financing_activities?: string | null` Other financing activities - `other_investing_activities?: string | null` Other investing activities - `other_non_cash_items?: string | null` Other non-cash items - `other_working_capital?: string | null` Change in other working capital - `preferred_dividends_paid?: string | null` Preferred dividends paid - `purchases_of_investments?: string | null` Purchases of investments - `sales_maturities_of_investments?: string | null` Sales and maturities of investments - `short_term_net_debt_issuance?: string | null` Short-term net debt issuance - `stock_based_compensation?: string | null` Stock-based compensation expense ### Instrument Cash Flow Statement List - `InstrumentCashFlowStatementList = Array` - `accepted_date: string` The date and time when the filing was accepted by the SEC - `filing_date: string` The date the financial statement was filed - `period: string` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: string` The currency in which the statement is reported (ISO 4217) - `year: number` The fiscal year of the statement - `accounts_payables?: string | null` Change in accounts payables - `accounts_receivables?: string | null` Change in accounts receivables - `acquisitions_net?: string | null` Net acquisitions - `capital_expenditure?: string | null` Capital expenditure - `cash_at_beginning_of_period?: string | null` Cash and cash equivalents at beginning of period - `cash_at_end_of_period?: string | null` Cash and cash equivalents at end of period - `change_in_working_capital?: string | null` Change in working capital - `common_dividends_paid?: string | null` Common dividends paid - `common_stock_issuance?: string | null` Common stock issuance - `common_stock_repurchased?: string | null` Common stock repurchased (buybacks) - `deferred_income_tax?: string | null` Deferred income tax expense - `depreciation_and_amortization?: string | null` Depreciation and amortization expense - `effect_of_forex_changes_on_cash?: string | null` Effect of foreign exchange changes on cash - `free_cash_flow?: string | null` Free cash flow (operating cash flow minus capital expenditure) - `income_taxes_paid?: string | null` Income taxes paid - `interest_paid?: string | null` Interest paid - `inventory?: string | null` Change in inventory - `investments_in_property_plant_and_equipment?: string | null` Investments in property, plant, and equipment - `long_term_net_debt_issuance?: string | null` Long-term net debt issuance - `net_cash_provided_by_financing_activities?: string | null` Net cash provided by financing activities - `net_cash_provided_by_investing_activities?: string | null` Net cash provided by investing activities - `net_cash_provided_by_operating_activities?: string | null` Net cash provided by operating activities - `net_change_in_cash?: string | null` Net change in cash during the period - `net_common_stock_issuance?: string | null` Net common stock issuance - `net_debt_issuance?: string | null` Net debt issuance (long-term + short-term) - `net_dividends_paid?: string | null` Net dividends paid (common + preferred) - `net_income?: string | null` Net income for the period - `net_preferred_stock_issuance?: string | null` Net preferred stock issuance - `net_stock_issuance?: string | null` Net stock issuance (common + preferred) - `operating_cash_flow?: string | null` Operating cash flow (alternative calculation) - `other_financing_activities?: string | null` Other financing activities - `other_investing_activities?: string | null` Other investing activities - `other_non_cash_items?: string | null` Other non-cash items - `other_working_capital?: string | null` Change in other working capital - `preferred_dividends_paid?: string | null` Preferred dividends paid - `purchases_of_investments?: string | null` Purchases of investments - `sales_maturities_of_investments?: string | null` Sales and maturities of investments - `short_term_net_debt_issuance?: string | null` Short-term net debt issuance - `stock_based_compensation?: string | null` Stock-based compensation expense ### Instrument Dividend Event - `InstrumentDividendEvent` Represents a dividend event for an instrument - `adjusted_dividend_amount: string` The adjusted dividend amount accounting for any splits. - `ex_date: string` The day the stock starts trading without the right to receive that dividend. - `declaration_date?: string | null` The declaration date of the dividend - `dividend_amount?: string | null` The dividend amount per share. - `dividend_yield?: string | null` The dividend yield as a percentage of the stock price. - `frequency?: string | null` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `payment_date?: string | null` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `record_date?: string | null` The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. ### Instrument Earnings - `InstrumentEarnings` Represents instrument earnings data - `date: string` The date when the earnings report was published - `eps_actual?: string | null` The actual earnings per share (EPS) for the period - `eps_estimate?: string | null` The estimated earnings per share (EPS) for the period - `eps_surprise_percent?: string | null` The percentage difference between actual and estimated EPS - `revenue_actual?: string | null` The actual total revenue for the period - `revenue_estimate?: string | null` The estimated total revenue for the period - `revenue_surprise_percent?: string | null` The percentage difference between actual and estimated revenue ### Instrument Event Envelope - `InstrumentEventEnvelope` Unified envelope for the all-events response. - `symbol: string` Symbol associated with the event. - `type: AllEventsEventType` Event type discriminator. - `"EARNINGS"` - `"DIVIDEND"` - `"STOCK_SPLIT"` - `"IPO"` - `dividend_event_data?: InstrumentDividendEvent | null` Dividend payload when type is DIVIDEND. - `adjusted_dividend_amount: string` The adjusted dividend amount accounting for any splits. - `ex_date: string` The day the stock starts trading without the right to receive that dividend. - `declaration_date?: string | null` The declaration date of the dividend - `dividend_amount?: string | null` The dividend amount per share. - `dividend_yield?: string | null` The dividend yield as a percentage of the stock price. - `frequency?: string | null` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `payment_date?: string | null` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `record_date?: string | null` The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. - `earnings_event_data?: InstrumentEarnings | null` Earnings payload when type is EARNINGS. - `date: string` The date when the earnings report was published - `eps_actual?: string | null` The actual earnings per share (EPS) for the period - `eps_estimate?: string | null` The estimated earnings per share (EPS) for the period - `eps_surprise_percent?: string | null` The percentage difference between actual and estimated EPS - `revenue_actual?: string | null` The actual total revenue for the period - `revenue_estimate?: string | null` The estimated total revenue for the period - `revenue_surprise_percent?: string | null` The percentage difference between actual and estimated revenue - `instrument_id?: string | null` OEMS instrument identifier, when the instrument is found in the instrument cache. - `ipo_event_data?: InstrumentEventIpoItem | null` IPO payload when type is IPO. - `actions?: string | null` IPO action. - `announced_at?: string | null` IPO announced timestamp. - `company?: string | null` IPO company name. - `exchange?: string | null` IPO exchange. - `market_cap?: string | null` IPO market cap. - `price_range?: string | null` IPO price range. - `shares?: string | null` IPO shares offered. - `name?: string | null` Instrument name associated with the event, when available. - `reporting_currency?: string | null` The currency used for reporting financial data. - `stock_split_event_data?: InstrumentSplitEvent | null` Stock split payload when type is STOCK_SPLIT. - `date: string` The date of the stock split - `denominator: string` The denominator of the split ratio - `numerator: string` The numerator of the split ratio - `split_type: string` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") ### Instrument Event Ipo Item - `InstrumentEventIpoItem` IPO event in the all-events date grouping response. - `actions?: string | null` IPO action. - `announced_at?: string | null` IPO announced timestamp. - `company?: string | null` IPO company name. - `exchange?: string | null` IPO exchange. - `market_cap?: string | null` IPO market cap. - `price_range?: string | null` IPO price range. - `shares?: string | null` IPO shares offered. ### Instrument Events By Date - `InstrumentEventsByDate` Instrument events for a single date. - `date: string` Event date. - `events: Array` Flat event envelopes for this date. - `symbol: string` Symbol associated with the event. - `type: AllEventsEventType` Event type discriminator. - `"EARNINGS"` - `"DIVIDEND"` - `"STOCK_SPLIT"` - `"IPO"` - `dividend_event_data?: InstrumentDividendEvent | null` Dividend payload when type is DIVIDEND. - `adjusted_dividend_amount: string` The adjusted dividend amount accounting for any splits. - `ex_date: string` The day the stock starts trading without the right to receive that dividend. - `declaration_date?: string | null` The declaration date of the dividend - `dividend_amount?: string | null` The dividend amount per share. - `dividend_yield?: string | null` The dividend yield as a percentage of the stock price. - `frequency?: string | null` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `payment_date?: string | null` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `record_date?: string | null` The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. - `earnings_event_data?: InstrumentEarnings | null` Earnings payload when type is EARNINGS. - `date: string` The date when the earnings report was published - `eps_actual?: string | null` The actual earnings per share (EPS) for the period - `eps_estimate?: string | null` The estimated earnings per share (EPS) for the period - `eps_surprise_percent?: string | null` The percentage difference between actual and estimated EPS - `revenue_actual?: string | null` The actual total revenue for the period - `revenue_estimate?: string | null` The estimated total revenue for the period - `revenue_surprise_percent?: string | null` The percentage difference between actual and estimated revenue - `instrument_id?: string | null` OEMS instrument identifier, when the instrument is found in the instrument cache. - `ipo_event_data?: InstrumentEventIpoItem | null` IPO payload when type is IPO. - `actions?: string | null` IPO action. - `announced_at?: string | null` IPO announced timestamp. - `company?: string | null` IPO company name. - `exchange?: string | null` IPO exchange. - `market_cap?: string | null` IPO market cap. - `price_range?: string | null` IPO price range. - `shares?: string | null` IPO shares offered. - `name?: string | null` Instrument name associated with the event, when available. - `reporting_currency?: string | null` The currency used for reporting financial data. - `stock_split_event_data?: InstrumentSplitEvent | null` Stock split payload when type is STOCK_SPLIT. - `date: string` The date of the stock split - `denominator: string` The denominator of the split ratio - `numerator: string` The numerator of the split ratio - `split_type: string` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") ### Instrument Events Data - `InstrumentEventsData` Grouped instrument events by type - `dividends: Array` Dividend distribution events - `adjusted_dividend_amount: string` The adjusted dividend amount accounting for any splits. - `ex_date: string` The day the stock starts trading without the right to receive that dividend. - `declaration_date?: string | null` The declaration date of the dividend - `dividend_amount?: string | null` The dividend amount per share. - `dividend_yield?: string | null` The dividend yield as a percentage of the stock price. - `frequency?: string | null` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `payment_date?: string | null` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `record_date?: string | null` The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. - `earnings: Array` Earnings announcement events - `date: string` The date when the earnings report was published - `eps_actual?: string | null` The actual earnings per share (EPS) for the period - `eps_estimate?: string | null` The estimated earnings per share (EPS) for the period - `eps_surprise_percent?: string | null` The percentage difference between actual and estimated EPS - `revenue_actual?: string | null` The actual total revenue for the period - `revenue_estimate?: string | null` The estimated total revenue for the period - `revenue_surprise_percent?: string | null` The percentage difference between actual and estimated revenue - `instrument_id: string` OEMS instrument UUID from the request - `splits: Array` Stock split events - `date: string` The date of the stock split - `denominator: string` The denominator of the split ratio - `numerator: string` The numerator of the split ratio - `split_type: string` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") - `reporting_currency?: string | null` The currency used for reporting financial data ### Instrument Fundamentals - `InstrumentFundamentals` Supplemental fundamentals and company profile data for an instrument. - `average_volume?: number | null` The average daily trading volume over the past 30 days - `beta?: string | null` The beta value, measuring the instrument's volatility relative to the overall market - `description?: string | null` A detailed description of the instrument or company - `dividend_yield?: string | null` The trailing twelve months (TTM) dividend yield - `earnings_per_share?: string | null` The trailing twelve months (TTM) earnings per share - `fifty_two_week_high?: string | null` The highest price over the last 52 weeks - `fifty_two_week_low?: string | null` The lowest price over the last 52 weeks - `industry?: string | null` The specific industry of the instrument's issuer - `list_date?: string | null` The date the instrument was first listed - `logo_url?: string | null` URL to a representative logo image for the instrument or issuer - `market_cap?: string | null` The total market capitalization - `previous_close?: string | null` The closing price from the previous trading day - `price_to_earnings?: string | null` The price-to-earnings (P/E) ratio for the trailing twelve months (TTM) - `reporting_currency?: string | null` The currency used for reporting financial data - `sector?: string | null` The business sector of the instrument's issuer ### Instrument Income Statement - `InstrumentIncomeStatement` A quarterly income statement for an instrument. - `accepted_date: string` The date and time when the filing was accepted by the SEC - `filing_date: string` The date the financial statement was filed - `period: string` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: string` The currency in which the statement is reported (ISO 4217) - `year: number` The fiscal year of the statement - `bottom_line_net_income?: string | null` Bottom line net income after all adjustments - `cost_and_expenses?: string | null` Total costs and expenses - `cost_of_revenue?: string | null` Direct costs attributable to producing goods sold - `depreciation_and_amortization?: string | null` Depreciation and amortization expenses - `ebit?: string | null` Earnings before interest and taxes - `ebitda?: string | null` Earnings before interest, taxes, depreciation, and amortization - `eps?: string | null` Basic earnings per share - `eps_diluted?: string | null` Diluted earnings per share - `general_and_administrative_expenses?: string | null` General administrative overhead expenses - `gross_profit?: string | null` Revenue minus cost of revenue - `income_before_tax?: string | null` Income before income tax expense - `income_tax_expense?: string | null` Income tax expense for the period - `interest_expense?: string | null` Interest paid on debt - `interest_income?: string | null` Interest earned on investments and cash - `net_income?: string | null` Total net income for the period - `net_income_deductions?: string | null` Deductions from net income - `net_income_from_continuing_operations?: string | null` Net income from continuing operations - `net_income_from_discontinued_operations?: string | null` Net income from discontinued operations - `net_interest_income?: string | null` Net interest income (interest income minus interest expense) - `non_operating_income_excluding_interest?: string | null` Non-operating income excluding interest - `operating_expenses?: string | null` Total operating expenses - `operating_income?: string | null` Income from core business operations - `other_adjustments_to_net_income?: string | null` Other adjustments to net income - `other_expenses?: string | null` Other miscellaneous expenses - `research_and_development_expenses?: string | null` Expenditure on research and development activities - `revenue?: string | null` Total revenue from sales of goods and services - `selling_and_marketing_expenses?: string | null` Expenditure on marketing and sales activities - `selling_general_and_administrative_expenses?: string | null` Combined selling, general, and administrative expenses - `total_other_income_expenses_net?: string | null` Net of other income and expenses - `weighted_average_shs_out?: string | null` Weighted average shares outstanding (basic) - `weighted_average_shs_out_dil?: string | null` Weighted average shares outstanding (diluted) ### Instrument Income Statement List - `InstrumentIncomeStatementList = Array` - `accepted_date: string` The date and time when the filing was accepted by the SEC - `filing_date: string` The date the financial statement was filed - `period: string` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: string` The currency in which the statement is reported (ISO 4217) - `year: number` The fiscal year of the statement - `bottom_line_net_income?: string | null` Bottom line net income after all adjustments - `cost_and_expenses?: string | null` Total costs and expenses - `cost_of_revenue?: string | null` Direct costs attributable to producing goods sold - `depreciation_and_amortization?: string | null` Depreciation and amortization expenses - `ebit?: string | null` Earnings before interest and taxes - `ebitda?: string | null` Earnings before interest, taxes, depreciation, and amortization - `eps?: string | null` Basic earnings per share - `eps_diluted?: string | null` Diluted earnings per share - `general_and_administrative_expenses?: string | null` General administrative overhead expenses - `gross_profit?: string | null` Revenue minus cost of revenue - `income_before_tax?: string | null` Income before income tax expense - `income_tax_expense?: string | null` Income tax expense for the period - `interest_expense?: string | null` Interest paid on debt - `interest_income?: string | null` Interest earned on investments and cash - `net_income?: string | null` Total net income for the period - `net_income_deductions?: string | null` Deductions from net income - `net_income_from_continuing_operations?: string | null` Net income from continuing operations - `net_income_from_discontinued_operations?: string | null` Net income from discontinued operations - `net_interest_income?: string | null` Net interest income (interest income minus interest expense) - `non_operating_income_excluding_interest?: string | null` Non-operating income excluding interest - `operating_expenses?: string | null` Total operating expenses - `operating_income?: string | null` Income from core business operations - `other_adjustments_to_net_income?: string | null` Other adjustments to net income - `other_expenses?: string | null` Other miscellaneous expenses - `research_and_development_expenses?: string | null` Expenditure on research and development activities - `revenue?: string | null` Total revenue from sales of goods and services - `selling_and_marketing_expenses?: string | null` Expenditure on marketing and sales activities - `selling_general_and_administrative_expenses?: string | null` Combined selling, general, and administrative expenses - `total_other_income_expenses_net?: string | null` Net of other income and expenses - `weighted_average_shs_out?: string | null` Weighted average shares outstanding (basic) - `weighted_average_shs_out_dil?: string | null` Weighted average shares outstanding (diluted) ### Instrument Split Event - `InstrumentSplitEvent` Represents a stock split event for an instrument - `date: string` The date of the stock split - `denominator: string` The denominator of the split ratio - `numerator: string` The numerator of the split ratio - `split_type: string` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") ### Price Target - `PriceTarget` Analyst price target statistics - `average: string` Average analyst price target - `currency: string` ISO 4217 currency code of the price targets - `high: string` Highest analyst price target - `low: string` Lowest analyst price target ### Instrument Data Get All Instrument Events Response - `InstrumentDataGetAllInstrumentEventsResponse extends BaseResponse` - `data: InstrumentAllEventsData` All-events payload grouped by date. - `event_dates: Array` Events grouped by date in descending order. - `date: string` Event date. - `events: Array` Flat event envelopes for this date. - `symbol: string` Symbol associated with the event. - `type: AllEventsEventType` Event type discriminator. - `"EARNINGS"` - `"DIVIDEND"` - `"STOCK_SPLIT"` - `"IPO"` - `dividend_event_data?: InstrumentDividendEvent | null` Dividend payload when type is DIVIDEND. - `adjusted_dividend_amount: string` The adjusted dividend amount accounting for any splits. - `ex_date: string` The day the stock starts trading without the right to receive that dividend. - `declaration_date?: string | null` The declaration date of the dividend - `dividend_amount?: string | null` The dividend amount per share. - `dividend_yield?: string | null` The dividend yield as a percentage of the stock price. - `frequency?: string | null` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `payment_date?: string | null` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `record_date?: string | null` The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. - `earnings_event_data?: InstrumentEarnings | null` Earnings payload when type is EARNINGS. - `date: string` The date when the earnings report was published - `eps_actual?: string | null` The actual earnings per share (EPS) for the period - `eps_estimate?: string | null` The estimated earnings per share (EPS) for the period - `eps_surprise_percent?: string | null` The percentage difference between actual and estimated EPS - `revenue_actual?: string | null` The actual total revenue for the period - `revenue_estimate?: string | null` The estimated total revenue for the period - `revenue_surprise_percent?: string | null` The percentage difference between actual and estimated revenue - `instrument_id?: string | null` OEMS instrument identifier, when the instrument is found in the instrument cache. - `ipo_event_data?: InstrumentEventIpoItem | null` IPO payload when type is IPO. - `actions?: string | null` IPO action. - `announced_at?: string | null` IPO announced timestamp. - `company?: string | null` IPO company name. - `exchange?: string | null` IPO exchange. - `market_cap?: string | null` IPO market cap. - `price_range?: string | null` IPO price range. - `shares?: string | null` IPO shares offered. - `name?: string | null` Instrument name associated with the event, when available. - `reporting_currency?: string | null` The currency used for reporting financial data. - `stock_split_event_data?: InstrumentSplitEvent | null` Stock split payload when type is STOCK_SPLIT. - `date: string` The date of the stock split - `denominator: string` The denominator of the split ratio - `numerator: string` The numerator of the split ratio - `split_type: string` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") ### Instrument Data Get Instrument Events Response - `InstrumentDataGetInstrumentEventsResponse extends BaseResponse` - `data: InstrumentEventsData` Grouped instrument events by type - `dividends: Array` Dividend distribution events - `adjusted_dividend_amount: string` The adjusted dividend amount accounting for any splits. - `ex_date: string` The day the stock starts trading without the right to receive that dividend. - `declaration_date?: string | null` The declaration date of the dividend - `dividend_amount?: string | null` The dividend amount per share. - `dividend_yield?: string | null` The dividend yield as a percentage of the stock price. - `frequency?: string | null` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `payment_date?: string | null` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `record_date?: string | null` The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. - `earnings: Array` Earnings announcement events - `date: string` The date when the earnings report was published - `eps_actual?: string | null` The actual earnings per share (EPS) for the period - `eps_estimate?: string | null` The estimated earnings per share (EPS) for the period - `eps_surprise_percent?: string | null` The percentage difference between actual and estimated EPS - `revenue_actual?: string | null` The actual total revenue for the period - `revenue_estimate?: string | null` The estimated total revenue for the period - `revenue_surprise_percent?: string | null` The percentage difference between actual and estimated revenue - `instrument_id: string` OEMS instrument UUID from the request - `splits: Array` Stock split events - `date: string` The date of the stock split - `denominator: string` The denominator of the split ratio - `numerator: string` The numerator of the split ratio - `split_type: string` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") - `reporting_currency?: string | null` The currency used for reporting financial data ### Instrument Data Get Instrument Fundamentals Response - `InstrumentDataGetInstrumentFundamentalsResponse extends BaseResponse` - `data: InstrumentFundamentals` Supplemental fundamentals and company profile data for an instrument. - `average_volume?: number | null` The average daily trading volume over the past 30 days - `beta?: string | null` The beta value, measuring the instrument's volatility relative to the overall market - `description?: string | null` A detailed description of the instrument or company - `dividend_yield?: string | null` The trailing twelve months (TTM) dividend yield - `earnings_per_share?: string | null` The trailing twelve months (TTM) earnings per share - `fifty_two_week_high?: string | null` The highest price over the last 52 weeks - `fifty_two_week_low?: string | null` The lowest price over the last 52 weeks - `industry?: string | null` The specific industry of the instrument's issuer - `list_date?: string | null` The date the instrument was first listed - `logo_url?: string | null` URL to a representative logo image for the instrument or issuer - `market_cap?: string | null` The total market capitalization - `previous_close?: string | null` The closing price from the previous trading day - `price_to_earnings?: string | null` The price-to-earnings (P/E) ratio for the trailing twelve months (TTM) - `reporting_currency?: string | null` The currency used for reporting financial data - `sector?: string | null` The business sector of the instrument's issuer ### Instrument Data Get Instrument Balance Sheet Statements Response - `InstrumentDataGetInstrumentBalanceSheetStatementsResponse extends BaseResponse` - `data: InstrumentBalanceSheetStatementList` - `accepted_date: string` The date and time when the filing was accepted by the SEC - `filing_date: string` The date the financial statement was filed - `period: string` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: string` The currency in which the statement is reported (ISO 4217) - `year: number` The fiscal year of the statement - `account_payables?: string | null` Account payables - `accounts_receivables?: string | null` Accounts receivables - `accrued_expenses?: string | null` Accrued expenses - `accumulated_other_comprehensive_income_loss?: string | null` Accumulated other comprehensive income/loss - `additional_paid_in_capital?: string | null` Additional paid-in capital - `capital_lease_obligations?: string | null` Capital lease obligations (total) - `capital_lease_obligations_current?: string | null` Capital lease obligations (current portion) - `cash_and_cash_equivalents?: string | null` Cash and cash equivalents - `cash_and_short_term_investments?: string | null` Cash and short-term investments combined - `common_stock?: string | null` Common stock - `deferred_revenue?: string | null` Deferred revenue - `deferred_revenue_non_current?: string | null` Deferred revenue (non-current) - `deferred_tax_liabilities_non_current?: string | null` Deferred tax liabilities (non-current) - `goodwill?: string | null` Goodwill - `goodwill_and_intangible_assets?: string | null` Goodwill and intangible assets combined - `intangible_assets?: string | null` Intangible assets - `inventory?: string | null` Inventory - `long_term_debt?: string | null` Long-term debt - `long_term_investments?: string | null` Long-term investments - `minority_interest?: string | null` Minority interest - `net_debt?: string | null` Net debt (total debt minus cash) - `net_receivables?: string | null` Net receivables - `other_assets?: string | null` Other assets - `other_current_assets?: string | null` Other current assets - `other_current_liabilities?: string | null` Other current liabilities - `other_liabilities?: string | null` Other liabilities - `other_non_current_assets?: string | null` Other non-current assets - `other_non_current_liabilities?: string | null` Other non-current liabilities - `other_payables?: string | null` Other payables - `other_receivables?: string | null` Other receivables - `other_total_stockholders_equity?: string | null` Other total stockholders equity - `preferred_stock?: string | null` Preferred stock - `prepaids?: string | null` Prepaids - `property_plant_and_equipment_net?: string | null` Property, plant and equipment net of depreciation - `retained_earnings?: string | null` Retained earnings - `short_term_debt?: string | null` Short-term debt - `short_term_investments?: string | null` Short-term investments - `tax_assets?: string | null` Tax assets - `tax_payables?: string | null` Tax payables - `total_assets?: string | null` Total assets - `total_current_assets?: string | null` Total current assets - `total_current_liabilities?: string | null` Total current liabilities - `total_debt?: string | null` Total debt - `total_equity?: string | null` Total equity - `total_investments?: string | null` Total investments - `total_liabilities?: string | null` Total liabilities - `total_liabilities_and_total_equity?: string | null` Total liabilities and total equity - `total_non_current_assets?: string | null` Total non-current assets - `total_non_current_liabilities?: string | null` Total non-current liabilities - `total_payables?: string | null` Total payables - `total_stockholders_equity?: string | null` Total stockholders equity - `treasury_stock?: string | null` Treasury stock ### Instrument Data Get Instrument Income Statements Response - `InstrumentDataGetInstrumentIncomeStatementsResponse extends BaseResponse` - `data: InstrumentIncomeStatementList` - `accepted_date: string` The date and time when the filing was accepted by the SEC - `filing_date: string` The date the financial statement was filed - `period: string` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: string` The currency in which the statement is reported (ISO 4217) - `year: number` The fiscal year of the statement - `bottom_line_net_income?: string | null` Bottom line net income after all adjustments - `cost_and_expenses?: string | null` Total costs and expenses - `cost_of_revenue?: string | null` Direct costs attributable to producing goods sold - `depreciation_and_amortization?: string | null` Depreciation and amortization expenses - `ebit?: string | null` Earnings before interest and taxes - `ebitda?: string | null` Earnings before interest, taxes, depreciation, and amortization - `eps?: string | null` Basic earnings per share - `eps_diluted?: string | null` Diluted earnings per share - `general_and_administrative_expenses?: string | null` General administrative overhead expenses - `gross_profit?: string | null` Revenue minus cost of revenue - `income_before_tax?: string | null` Income before income tax expense - `income_tax_expense?: string | null` Income tax expense for the period - `interest_expense?: string | null` Interest paid on debt - `interest_income?: string | null` Interest earned on investments and cash - `net_income?: string | null` Total net income for the period - `net_income_deductions?: string | null` Deductions from net income - `net_income_from_continuing_operations?: string | null` Net income from continuing operations - `net_income_from_discontinued_operations?: string | null` Net income from discontinued operations - `net_interest_income?: string | null` Net interest income (interest income minus interest expense) - `non_operating_income_excluding_interest?: string | null` Non-operating income excluding interest - `operating_expenses?: string | null` Total operating expenses - `operating_income?: string | null` Income from core business operations - `other_adjustments_to_net_income?: string | null` Other adjustments to net income - `other_expenses?: string | null` Other miscellaneous expenses - `research_and_development_expenses?: string | null` Expenditure on research and development activities - `revenue?: string | null` Total revenue from sales of goods and services - `selling_and_marketing_expenses?: string | null` Expenditure on marketing and sales activities - `selling_general_and_administrative_expenses?: string | null` Combined selling, general, and administrative expenses - `total_other_income_expenses_net?: string | null` Net of other income and expenses - `weighted_average_shs_out?: string | null` Weighted average shares outstanding (basic) - `weighted_average_shs_out_dil?: string | null` Weighted average shares outstanding (diluted) ### Instrument Data Get Instrument Analyst Consensus Response - `InstrumentDataGetInstrumentAnalystConsensusResponse extends BaseResponse` - `data: InstrumentAnalystConsensus` Aggregated analyst consensus metrics - `date: string` The date the consensus snapshot was generated - `distribution?: AnalystDistribution | null` Count of individual analyst recommendations by category - `buy: number` Number of buy recommendations - `hold: number` Number of hold recommendations - `sell: number` Number of sell recommendations - `strong_buy: number` Number of strong buy recommendations - `strong_sell: number` Number of strong sell recommendations - `price_target?: PriceTarget | null` Aggregated analyst price target statistics - `average: string` Average analyst price target - `currency: string` ISO 4217 currency code of the price targets - `high: string` Highest analyst price target - `low: string` Lowest analyst price target - `rating?: AnalystRating | null` Consensus analyst rating - `"STRONG_BUY"` - `"BUY"` - `"HOLD"` - `"SELL"` - `"STRONG_SELL"` ### Instrument Data Get Instrument Cash Flow Statements Response - `InstrumentDataGetInstrumentCashFlowStatementsResponse extends BaseResponse` - `data: InstrumentCashFlowStatementList` - `accepted_date: string` The date and time when the filing was accepted by the SEC - `filing_date: string` The date the financial statement was filed - `period: string` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: string` The currency in which the statement is reported (ISO 4217) - `year: number` The fiscal year of the statement - `accounts_payables?: string | null` Change in accounts payables - `accounts_receivables?: string | null` Change in accounts receivables - `acquisitions_net?: string | null` Net acquisitions - `capital_expenditure?: string | null` Capital expenditure - `cash_at_beginning_of_period?: string | null` Cash and cash equivalents at beginning of period - `cash_at_end_of_period?: string | null` Cash and cash equivalents at end of period - `change_in_working_capital?: string | null` Change in working capital - `common_dividends_paid?: string | null` Common dividends paid - `common_stock_issuance?: string | null` Common stock issuance - `common_stock_repurchased?: string | null` Common stock repurchased (buybacks) - `deferred_income_tax?: string | null` Deferred income tax expense - `depreciation_and_amortization?: string | null` Depreciation and amortization expense - `effect_of_forex_changes_on_cash?: string | null` Effect of foreign exchange changes on cash - `free_cash_flow?: string | null` Free cash flow (operating cash flow minus capital expenditure) - `income_taxes_paid?: string | null` Income taxes paid - `interest_paid?: string | null` Interest paid - `inventory?: string | null` Change in inventory - `investments_in_property_plant_and_equipment?: string | null` Investments in property, plant, and equipment - `long_term_net_debt_issuance?: string | null` Long-term net debt issuance - `net_cash_provided_by_financing_activities?: string | null` Net cash provided by financing activities - `net_cash_provided_by_investing_activities?: string | null` Net cash provided by investing activities - `net_cash_provided_by_operating_activities?: string | null` Net cash provided by operating activities - `net_change_in_cash?: string | null` Net change in cash during the period - `net_common_stock_issuance?: string | null` Net common stock issuance - `net_debt_issuance?: string | null` Net debt issuance (long-term + short-term) - `net_dividends_paid?: string | null` Net dividends paid (common + preferred) - `net_income?: string | null` Net income for the period - `net_preferred_stock_issuance?: string | null` Net preferred stock issuance - `net_stock_issuance?: string | null` Net stock issuance (common + preferred) - `operating_cash_flow?: string | null` Operating cash flow (alternative calculation) - `other_financing_activities?: string | null` Other financing activities - `other_investing_activities?: string | null` Other investing activities - `other_non_cash_items?: string | null` Other non-cash items - `other_working_capital?: string | null` Change in other working capital - `preferred_dividends_paid?: string | null` Preferred dividends paid - `purchases_of_investments?: string | null` Purchases of investments - `sales_maturities_of_investments?: string | null` Sales and maturities of investments - `short_term_net_debt_issuance?: string | null` Short-term net debt issuance - `stock_based_compensation?: string | null` Stock-based compensation expense # Market Data ## Get Snapshots `client.v1.instrumentData.marketData.getSnapshots(MarketDataGetSnapshotsParamsquery?, RequestOptionsoptions?): MarketDataGetSnapshotsResponse` **get** `/v1/market-data/snapshot` Get market data snapshots for one or more securities. ### Parameters - `query: MarketDataGetSnapshotsParams` - `instrument_ids?: Array` Comma-separated OEMS instrument UUIDs. ### Returns - `MarketDataGetSnapshotsResponse extends BaseResponse` - `data: MarketDataSnapshotList` - `instrument_id: string` OEMS instrument identifier. - `symbol: string` Display symbol for the security. - `cumulative_volume?: number | null` Cumulative traded volume reported on the most recent trade, in shares for equities or contracts for options. Absent when no trade is available. - `last_quote?: SnapshotQuote | null` Most recent quote if available. - `ask: string` Current best ask. - `bid: string` Current best bid. - `midpoint: string` Midpoint of bid and ask. - `ask_size?: number | null` Size at the best ask, in shares. - `bid_size?: number | null` Size at the best bid, in shares. - `last_trade?: SnapshotLastTrade | null` Most recent last-sale trade if available. - `price: string` Most recent last-sale eligible trade price. - `name?: string | null` Security name if available. - `session?: SnapshotSession | null` Session metrics computed from previous close and last trade, if available. - `change: string` Absolute change from previous close to last trade. - `change_percent: string` Percent change from previous close to last trade. - `previous_close: string` Previous session close price. ### Example ```typescript import ClearStreet from '@clear-street-internal/sdk'; const client = new ClearStreet({ apiKey: 'My API Key', }); const response = await client.v1.instrumentData.marketData.getSnapshots(); console.log(response); ``` #### Response ```json { "data": [ { "cumulative_volume": 12345678, "instrument_id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8", "last_quote": { "ask": "210.14", "ask_size": 120, "bid": "210.10", "bid_size": 100, "midpoint": "210.12" }, "last_trade": { "price": "210.12" }, "name": "Apple Inc.", "session": { "change": "1.82", "change_percent": "0.8737", "previous_close": "208.30" }, "symbol": "AAPL" } ], "error": null, "metadata": { "request_id": "2d0c9159-8f5d-49ca-a861-0d8346fd11da" } } ``` ## Get Daily Aggregate Summaries `client.v1.instrumentData.marketData.getDailySummaries(MarketDataGetDailySummariesParamsquery, RequestOptionsoptions?): MarketDataGetDailySummariesResponse` **get** `/v1/market-data/daily-summary` Returns the most recent OHLV and current price for the requested OEMS instruments. Backed by the in-memory Polygon snapshot cache. Response contract: every request returns one row per **unique** `instrument_id`, in first-seen request order. Unresolvable IDs come back with `symbol = null` and every market-data field `null`; resolvable IDs with no cache entry come back with `symbol` populated but market-data fields `null`. **Note (temporary):** ID resolution currently goes through the supplemental screener (OEMS instrument_id → FMP fmp_symbol → metadata_id → realtime cache). Removed when the market-data service serves daily aggregates directly, or when Polygon symbology is loaded into the instrument cache. ### Parameters - `query: MarketDataGetDailySummariesParams` - `instrument_ids: string` Comma-separated OEMS instrument UUIDs (required, 1..=100) ### Returns - `MarketDataGetDailySummariesResponse extends BaseResponse` - `data: DailySummaryList` - `instrument_id: string` OEMS instrument identifier. Always populated; echoes the request ID. - `high?: string | null` Session high. - `low?: string | null` Session low. - `open?: string | null` Opening price for the session. - `symbol?: string | null` Display symbol for the security. `None` for unresolvable IDs. - `trade_date?: string | null` Session date the OHLV represents, US/Eastern. - `volume?: number | null` Session cumulative trading volume. ### Example ```typescript import ClearStreet from '@clear-street-internal/sdk'; const client = new ClearStreet({ apiKey: 'My API Key', }); const response = await client.v1.instrumentData.marketData.getDailySummaries({ instrument_ids: 'instrument_ids', }); console.log(response); ``` #### Response ```json { "metadata": { "request_id": "request_id", "next_page_token": "U3RhaW5sZXNzIHJvY2tz", "page_number": 0, "previous_page_token": "U3RhaW5sZXNzIHJvY2tz", "total_items": 0, "total_pages": 0 }, "error": { "code": 400, "message": "Order quantity must be greater than zero", "details": [ { "foo": "bar" } ] }, "data": [ { "instrument_id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8", "high": "215.20", "low": "210.10", "open": "211.00", "symbol": "AAPL", "trade_date": "2026-04-23", "volume": 88000000 } ] } ``` ## Domain Types ### Daily Summary - `DailySummary` Daily aggregate (OHLV) summary for a single instrument. Returned by `GET /market-data/daily-summary`. Every field except `instrument_id` is `Option`: - Unresolvable `instrument_id` → all other fields `None` (including `symbol`). - Resolvable `instrument_id` with no realtime cache entry → `symbol` populated, OHLV/`trade_date` `None`. - `trade_date` reflects the session the OHLV represents (today during trading hours, the last trading date during weekends/holidays). - `instrument_id: string` OEMS instrument identifier. Always populated; echoes the request ID. - `high?: string | null` Session high. - `low?: string | null` Session low. - `open?: string | null` Opening price for the session. - `symbol?: string | null` Display symbol for the security. `None` for unresolvable IDs. - `trade_date?: string | null` Session date the OHLV represents, US/Eastern. - `volume?: number | null` Session cumulative trading volume. ### Daily Summary List - `DailySummaryList = Array` - `instrument_id: string` OEMS instrument identifier. Always populated; echoes the request ID. - `high?: string | null` Session high. - `low?: string | null` Session low. - `open?: string | null` Opening price for the session. - `symbol?: string | null` Display symbol for the security. `None` for unresolvable IDs. - `trade_date?: string | null` Session date the OHLV represents, US/Eastern. - `volume?: number | null` Session cumulative trading volume. ### Market Data Snapshot - `MarketDataSnapshot` Market data snapshot for a single security. - `instrument_id: string` OEMS instrument identifier. - `symbol: string` Display symbol for the security. - `cumulative_volume?: number | null` Cumulative traded volume reported on the most recent trade, in shares for equities or contracts for options. Absent when no trade is available. - `last_quote?: SnapshotQuote | null` Most recent quote if available. - `ask: string` Current best ask. - `bid: string` Current best bid. - `midpoint: string` Midpoint of bid and ask. - `ask_size?: number | null` Size at the best ask, in shares. - `bid_size?: number | null` Size at the best bid, in shares. - `last_trade?: SnapshotLastTrade | null` Most recent last-sale trade if available. - `price: string` Most recent last-sale eligible trade price. - `name?: string | null` Security name if available. - `session?: SnapshotSession | null` Session metrics computed from previous close and last trade, if available. - `change: string` Absolute change from previous close to last trade. - `change_percent: string` Percent change from previous close to last trade. - `previous_close: string` Previous session close price. ### Market Data Snapshot List - `MarketDataSnapshotList = Array` - `instrument_id: string` OEMS instrument identifier. - `symbol: string` Display symbol for the security. - `cumulative_volume?: number | null` Cumulative traded volume reported on the most recent trade, in shares for equities or contracts for options. Absent when no trade is available. - `last_quote?: SnapshotQuote | null` Most recent quote if available. - `ask: string` Current best ask. - `bid: string` Current best bid. - `midpoint: string` Midpoint of bid and ask. - `ask_size?: number | null` Size at the best ask, in shares. - `bid_size?: number | null` Size at the best bid, in shares. - `last_trade?: SnapshotLastTrade | null` Most recent last-sale trade if available. - `price: string` Most recent last-sale eligible trade price. - `name?: string | null` Security name if available. - `session?: SnapshotSession | null` Session metrics computed from previous close and last trade, if available. - `change: string` Absolute change from previous close to last trade. - `change_percent: string` Percent change from previous close to last trade. - `previous_close: string` Previous session close price. ### Snapshot Last Trade - `SnapshotLastTrade` Last-trade fields for a market data snapshot. - `price: string` Most recent last-sale eligible trade price. ### Snapshot Quote - `SnapshotQuote` L1 quote fields for a market data snapshot. - `ask: string` Current best ask. - `bid: string` Current best bid. - `midpoint: string` Midpoint of bid and ask. - `ask_size?: number | null` Size at the best ask, in shares. - `bid_size?: number | null` Size at the best bid, in shares. ### Snapshot Session - `SnapshotSession` Session-level pricing metrics for a market data snapshot. - `change: string` Absolute change from previous close to last trade. - `change_percent: string` Percent change from previous close to last trade. - `previous_close: string` Previous session close price. ### Market Data Get Snapshots Response - `MarketDataGetSnapshotsResponse extends BaseResponse` - `data: MarketDataSnapshotList` - `instrument_id: string` OEMS instrument identifier. - `symbol: string` Display symbol for the security. - `cumulative_volume?: number | null` Cumulative traded volume reported on the most recent trade, in shares for equities or contracts for options. Absent when no trade is available. - `last_quote?: SnapshotQuote | null` Most recent quote if available. - `ask: string` Current best ask. - `bid: string` Current best bid. - `midpoint: string` Midpoint of bid and ask. - `ask_size?: number | null` Size at the best ask, in shares. - `bid_size?: number | null` Size at the best bid, in shares. - `last_trade?: SnapshotLastTrade | null` Most recent last-sale trade if available. - `price: string` Most recent last-sale eligible trade price. - `name?: string | null` Security name if available. - `session?: SnapshotSession | null` Session metrics computed from previous close and last trade, if available. - `change: string` Absolute change from previous close to last trade. - `change_percent: string` Percent change from previous close to last trade. - `previous_close: string` Previous session close price. ### Market Data Get Daily Summaries Response - `MarketDataGetDailySummariesResponse extends BaseResponse` - `data: DailySummaryList` - `instrument_id: string` OEMS instrument identifier. Always populated; echoes the request ID. - `high?: string | null` Session high. - `low?: string | null` Session low. - `open?: string | null` Opening price for the session. - `symbol?: string | null` Display symbol for the security. `None` for unresolvable IDs. - `trade_date?: string | null` Session date the OHLV represents, US/Eastern. - `volume?: number | null` Session cumulative trading volume. # News ## Get News `client.v1.instrumentData.news.getNews(NewsGetNewsParamsquery?, RequestOptionsoptions?): NewsGetNewsResponse` **get** `/v1/news` Retrieves news items with optional filtering by security IDs, time range, publisher, type, and text query. ### Parameters - `query: NewsGetNewsParams` - `exclude_publishers?: string` Comma-separated list of publishers to exclude (mutually exclusive with include_publishers). - `from?: string` Inclusive start timestamp. Accepts `YYYY-MM-DD` or RFC3339 datetime. - `include_publishers?: string` Comma-separated list of publishers to include (mutually exclusive with exclude_publishers). - `instrument_ids?: Array` Comma-delimited OEMS instrument UUIDs to filter by. - `news_type?: "NEWS" | "PRESS_RELEASE"` Filter by news type. - `"NEWS"` - `"PRESS_RELEASE"` - `page_size?: number` The number of items to return per page. Only used when page_token is not provided. - `page_token?: string` Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored. - `search_query?: string` Free-text query matched against title/text and associated security IDs. - `sectors?: Array<"BASIC_MATERIALS" | "COMMUNICATION_SERVICES" | "CONSUMER_CYCLICAL" | 8 more>` Comma-separated sector values to filter by. - `"BASIC_MATERIALS"` - `"COMMUNICATION_SERVICES"` - `"CONSUMER_CYCLICAL"` - `"CONSUMER_DEFENSIVE"` - `"ENERGY"` - `"FINANCIAL_SERVICES"` - `"HEALTHCARE"` - `"INDUSTRIALS"` - `"REAL_ESTATE"` - `"TECHNOLOGY"` - `"UTILITIES"` - `to?: string` Inclusive end timestamp. Accepts `YYYY-MM-DD` or RFC3339 datetime. ### Returns - `NewsGetNewsResponse extends BaseResponse` - `data: NewsItemList` - `instruments: Array` Instruments associated with this news item. - `instrument_id: string` OEMS instrument UUID. - `name?: string | null` Instrument name/description, if available from instrument cache enrichment. - `symbol?: string | null` Trading symbol, if available from instrument cache enrichment. - `news_type: NewsType` Classification of the item. - `"NEWS"` - `"PRESS_RELEASE"` - `published_at: string` The published date/time of the article in UTC. - `publisher: string` The publisher or newswire source. - `title: string` The headline/title of the article. - `url: string` Canonical URL to the full article. - `image_url?: string | null` URL of an associated image if provided by the source. - `site?: string | null` The primary domain/site of the publisher. - `text?: string | null` The full or excerpted article body. ### Example ```typescript import ClearStreet from '@clear-street-internal/sdk'; const client = new ClearStreet({ apiKey: 'My API Key', }); const response = await client.v1.instrumentData.news.getNews(); console.log(response); ``` #### Response ```json { "data": [ { "instruments": [ { "instrument_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479", "name": "Apple Inc.", "symbol": "AAPL" } ], "news_type": "NEWS", "published_at": "2025-10-31T14:30:00.000000000Z", "publisher": "Reuters", "site": "reuters.com", "title": "Apple announces new hardware lineup", "url": "https://example.com/news/1" } ], "error": null, "metadata": { "next_page_token": "cGFnZT0yJmxhc3Rfc3ltYm9sPVRTM0E", "page_number": 1, "request_id": "0f1a2b3c-4d5e-6f78-9012-3a4b5c6d7e8f", "total_items": 25, "total_pages": 3 } } ``` ## Domain Types ### News Instrument - `NewsInstrument` Instrument associated with a news item. - `instrument_id: string` OEMS instrument UUID. - `name?: string | null` Instrument name/description, if available from instrument cache enrichment. - `symbol?: string | null` Trading symbol, if available from instrument cache enrichment. ### News Item - `NewsItem` A single news item and its associated instruments. - `instruments: Array` Instruments associated with this news item. - `instrument_id: string` OEMS instrument UUID. - `name?: string | null` Instrument name/description, if available from instrument cache enrichment. - `symbol?: string | null` Trading symbol, if available from instrument cache enrichment. - `news_type: NewsType` Classification of the item. - `"NEWS"` - `"PRESS_RELEASE"` - `published_at: string` The published date/time of the article in UTC. - `publisher: string` The publisher or newswire source. - `title: string` The headline/title of the article. - `url: string` Canonical URL to the full article. - `image_url?: string | null` URL of an associated image if provided by the source. - `site?: string | null` The primary domain/site of the publisher. - `text?: string | null` The full or excerpted article body. ### News Item List - `NewsItemList = Array` - `instruments: Array` Instruments associated with this news item. - `instrument_id: string` OEMS instrument UUID. - `name?: string | null` Instrument name/description, if available from instrument cache enrichment. - `symbol?: string | null` Trading symbol, if available from instrument cache enrichment. - `news_type: NewsType` Classification of the item. - `"NEWS"` - `"PRESS_RELEASE"` - `published_at: string` The published date/time of the article in UTC. - `publisher: string` The publisher or newswire source. - `title: string` The headline/title of the article. - `url: string` Canonical URL to the full article. - `image_url?: string | null` URL of an associated image if provided by the source. - `site?: string | null` The primary domain/site of the publisher. - `text?: string | null` The full or excerpted article body. ### News Type - `NewsType = "NEWS" | "PRESS_RELEASE"` News item classification. - `"NEWS"` - `"PRESS_RELEASE"` ### News Get News Response - `NewsGetNewsResponse extends BaseResponse` - `data: NewsItemList` - `instruments: Array` Instruments associated with this news item. - `instrument_id: string` OEMS instrument UUID. - `name?: string | null` Instrument name/description, if available from instrument cache enrichment. - `symbol?: string | null` Trading symbol, if available from instrument cache enrichment. - `news_type: NewsType` Classification of the item. - `"NEWS"` - `"PRESS_RELEASE"` - `published_at: string` The published date/time of the article in UTC. - `publisher: string` The publisher or newswire source. - `title: string` The headline/title of the article. - `url: string` Canonical URL to the full article. - `image_url?: string | null` URL of an associated image if provided by the source. - `site?: string | null` The primary domain/site of the publisher. - `text?: string | null` The full or excerpted article body.