# Instrument Data ## Get All Instrument Events `v1.instrument_data.get_all_instrument_events(InstrumentDataGetAllInstrumentEventsParams**kwargs) -> InstrumentDataGetAllInstrumentEventsResponse` **get** `/v1/instruments/events` List instrument events across all securities. Retrieves all instrument events grouped by date. ### Parameters - `event_types: Optional[List[AllEventsEventType]]` Filter by event type(s). Comma-delimited list. Example: `event_types=EARNINGS,IPO`. - `"EARNINGS"` - `"DIVIDEND"` - `"STOCK_SPLIT"` - `"IPO"` - `from_date: Optional[str]` The start date for the query range, inclusive (YYYY-MM-DD). - `instrument_ids: Optional[Sequence[str]]` Filter by OEMS instrument ID(s). Comma-delimited list of UUIDs. Example: `instrument_ids=550e8400-e29b-41d4-a716-446655440000`. - `to_date: Optional[str]` The end date for the query range, inclusive (YYYY-MM-DD). ### Returns - `class InstrumentDataGetAllInstrumentEventsResponse: …` - `data: InstrumentAllEventsData` All-events payload grouped by date. - `event_dates: List[InstrumentEventsByDate]` Events grouped by date in descending order. - `date: date` Event date. - `events: List[InstrumentEventEnvelope]` Flat event envelopes for this date. - `symbol: str` Symbol associated with the event. - `type: AllEventsEventType` Event type discriminator. - `"EARNINGS"` - `"DIVIDEND"` - `"STOCK_SPLIT"` - `"IPO"` - `dividend_event_data: Optional[InstrumentDividendEvent]` Dividend payload when type is DIVIDEND. - `adjusted_dividend_amount: str` The adjusted dividend amount accounting for any splits. - `ex_date: date` The day the stock starts trading without the right to receive that dividend. - `declaration_date: Optional[date]` The declaration date of the dividend - `dividend_amount: Optional[str]` The dividend amount per share. - `dividend_yield: Optional[str]` The dividend yield as a percentage of the stock price. - `frequency: Optional[str]` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `payment_date: Optional[date]` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `record_date: Optional[date]` The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. - `earnings_event_data: Optional[InstrumentEarnings]` Earnings payload when type is EARNINGS. - `date: date` The date when the earnings report was published - `eps_actual: Optional[str]` The actual earnings per share (EPS) for the period - `eps_estimate: Optional[str]` The estimated earnings per share (EPS) for the period - `eps_surprise_percent: Optional[str]` The percentage difference between actual and estimated EPS - `revenue_actual: Optional[str]` The actual total revenue for the period - `revenue_estimate: Optional[str]` The estimated total revenue for the period - `revenue_surprise_percent: Optional[str]` The percentage difference between actual and estimated revenue - `instrument_id: Optional[str]` OEMS instrument identifier, when the instrument is found in the instrument cache. - `ipo_event_data: Optional[InstrumentEventIpoItem]` IPO payload when type is IPO. - `actions: Optional[str]` IPO action. - `announced_at: Optional[datetime]` IPO announced timestamp. - `company: Optional[str]` IPO company name. - `exchange: Optional[str]` IPO exchange. - `market_cap: Optional[str]` IPO market cap. - `price_range: Optional[str]` IPO price range. - `shares: Optional[str]` IPO shares offered. - `name: Optional[str]` Instrument name associated with the event, when available. - `reporting_currency: Optional[str]` The currency used for reporting financial data. - `stock_split_event_data: Optional[InstrumentSplitEvent]` Stock split payload when type is STOCK_SPLIT. - `date: date` The date of the stock split - `denominator: str` The denominator of the split ratio - `numerator: str` The numerator of the split ratio - `split_type: str` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") ### Example ```python from clear_street import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.instrument_data.get_all_instrument_events() print(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 `v1.instrument_data.get_instrument_events(InstrumentIDOrSymbolinstrument_id, InstrumentDataGetInstrumentEventsParams**kwargs) -> 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 - `from_date: Optional[str]` The start date for the query range, inclusive (YYYY-MM-DD). - `to_date: Optional[str]` The end date for the query range, inclusive (YYYY-MM-DD). ### Returns - `class InstrumentDataGetInstrumentEventsResponse: …` - `data: InstrumentEventsData` Grouped instrument events by type - `dividends: List[InstrumentDividendEvent]` Dividend distribution events - `adjusted_dividend_amount: str` The adjusted dividend amount accounting for any splits. - `ex_date: date` The day the stock starts trading without the right to receive that dividend. - `declaration_date: Optional[date]` The declaration date of the dividend - `dividend_amount: Optional[str]` The dividend amount per share. - `dividend_yield: Optional[str]` The dividend yield as a percentage of the stock price. - `frequency: Optional[str]` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `payment_date: Optional[date]` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `record_date: Optional[date]` 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: List[InstrumentEarnings]` Earnings announcement events - `date: date` The date when the earnings report was published - `eps_actual: Optional[str]` The actual earnings per share (EPS) for the period - `eps_estimate: Optional[str]` The estimated earnings per share (EPS) for the period - `eps_surprise_percent: Optional[str]` The percentage difference between actual and estimated EPS - `revenue_actual: Optional[str]` The actual total revenue for the period - `revenue_estimate: Optional[str]` The estimated total revenue for the period - `revenue_surprise_percent: Optional[str]` The percentage difference between actual and estimated revenue - `instrument_id: str` OEMS instrument UUID from the request - `splits: List[InstrumentSplitEvent]` Stock split events - `date: date` The date of the stock split - `denominator: str` The denominator of the split ratio - `numerator: str` The numerator of the split ratio - `split_type: str` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") - `reporting_currency: Optional[str]` The currency used for reporting financial data ### Example ```python from clear_street import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.instrument_data.get_instrument_events( instrument_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", ) print(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 `v1.instrument_data.get_instrument_fundamentals(InstrumentIDOrSymbolinstrument_id) -> 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 - `class InstrumentDataGetInstrumentFundamentalsResponse: …` - `data: InstrumentFundamentals` Supplemental fundamentals and company profile data for an instrument. - `average_volume: Optional[int]` The average daily trading volume over the past 30 days - `beta: Optional[str]` The beta value, measuring the instrument's volatility relative to the overall market - `description: Optional[str]` A detailed description of the instrument or company - `dividend_yield: Optional[str]` The trailing twelve months (TTM) dividend yield - `earnings_per_share: Optional[str]` The trailing twelve months (TTM) earnings per share - `fifty_two_week_high: Optional[str]` The highest price over the last 52 weeks - `fifty_two_week_low: Optional[str]` The lowest price over the last 52 weeks - `industry: Optional[str]` The specific industry of the instrument's issuer - `list_date: Optional[date]` The date the instrument was first listed - `logo_url: Optional[str]` URL to a representative logo image for the instrument or issuer - `market_cap: Optional[str]` The total market capitalization - `previous_close: Optional[str]` The closing price from the previous trading day - `price_to_earnings: Optional[str]` The price-to-earnings (P/E) ratio for the trailing twelve months (TTM) - `reporting_currency: Optional[str]` The currency used for reporting financial data - `sector: Optional[str]` The business sector of the instrument's issuer ### Example ```python from clear_street import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.instrument_data.get_instrument_fundamentals( "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", ) print(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 `v1.instrument_data.get_instrument_balance_sheet_statements(InstrumentIDOrSymbolinstrument_id, InstrumentDataGetInstrumentBalanceSheetStatementsParams**kwargs) -> 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 - `from_date: Optional[str]` The start date for the query range, inclusive (YYYY-MM-DD). - `page_size: Optional[int]` The number of items to return per page. Only used when page_token is not provided. - `page_token: Optional[Union[str, Base64FileInput]]` Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored. - `to_date: Optional[str]` The end date for the query range, inclusive (YYYY-MM-DD). ### Returns - `class InstrumentDataGetInstrumentBalanceSheetStatementsResponse: …` - `data: InstrumentBalanceSheetStatementList` - `accepted_date: datetime` The date and time when the filing was accepted by the SEC - `filing_date: date` The date the financial statement was filed - `period: str` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: str` The currency in which the statement is reported (ISO 4217) - `year: int` The fiscal year of the statement - `account_payables: Optional[str]` Account payables - `accounts_receivables: Optional[str]` Accounts receivables - `accrued_expenses: Optional[str]` Accrued expenses - `accumulated_other_comprehensive_income_loss: Optional[str]` Accumulated other comprehensive income/loss - `additional_paid_in_capital: Optional[str]` Additional paid-in capital - `capital_lease_obligations: Optional[str]` Capital lease obligations (total) - `capital_lease_obligations_current: Optional[str]` Capital lease obligations (current portion) - `cash_and_cash_equivalents: Optional[str]` Cash and cash equivalents - `cash_and_short_term_investments: Optional[str]` Cash and short-term investments combined - `common_stock: Optional[str]` Common stock - `deferred_revenue: Optional[str]` Deferred revenue - `deferred_revenue_non_current: Optional[str]` Deferred revenue (non-current) - `deferred_tax_liabilities_non_current: Optional[str]` Deferred tax liabilities (non-current) - `goodwill: Optional[str]` Goodwill - `goodwill_and_intangible_assets: Optional[str]` Goodwill and intangible assets combined - `intangible_assets: Optional[str]` Intangible assets - `inventory: Optional[str]` Inventory - `long_term_debt: Optional[str]` Long-term debt - `long_term_investments: Optional[str]` Long-term investments - `minority_interest: Optional[str]` Minority interest - `net_debt: Optional[str]` Net debt (total debt minus cash) - `net_receivables: Optional[str]` Net receivables - `other_assets: Optional[str]` Other assets - `other_current_assets: Optional[str]` Other current assets - `other_current_liabilities: Optional[str]` Other current liabilities - `other_liabilities: Optional[str]` Other liabilities - `other_non_current_assets: Optional[str]` Other non-current assets - `other_non_current_liabilities: Optional[str]` Other non-current liabilities - `other_payables: Optional[str]` Other payables - `other_receivables: Optional[str]` Other receivables - `other_total_stockholders_equity: Optional[str]` Other total stockholders equity - `preferred_stock: Optional[str]` Preferred stock - `prepaids: Optional[str]` Prepaids - `property_plant_and_equipment_net: Optional[str]` Property, plant and equipment net of depreciation - `retained_earnings: Optional[str]` Retained earnings - `short_term_debt: Optional[str]` Short-term debt - `short_term_investments: Optional[str]` Short-term investments - `tax_assets: Optional[str]` Tax assets - `tax_payables: Optional[str]` Tax payables - `total_assets: Optional[str]` Total assets - `total_current_assets: Optional[str]` Total current assets - `total_current_liabilities: Optional[str]` Total current liabilities - `total_debt: Optional[str]` Total debt - `total_equity: Optional[str]` Total equity - `total_investments: Optional[str]` Total investments - `total_liabilities: Optional[str]` Total liabilities - `total_liabilities_and_total_equity: Optional[str]` Total liabilities and total equity - `total_non_current_assets: Optional[str]` Total non-current assets - `total_non_current_liabilities: Optional[str]` Total non-current liabilities - `total_payables: Optional[str]` Total payables - `total_stockholders_equity: Optional[str]` Total stockholders equity - `treasury_stock: Optional[str]` Treasury stock ### Example ```python from clear_street import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.instrument_data.get_instrument_balance_sheet_statements( instrument_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", ) print(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 `v1.instrument_data.get_instrument_income_statements(InstrumentIDOrSymbolinstrument_id, InstrumentDataGetInstrumentIncomeStatementsParams**kwargs) -> 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 - `from_date: Optional[str]` The start date for the query range, inclusive (YYYY-MM-DD). - `page_size: Optional[int]` The number of items to return per page. Only used when page_token is not provided. - `page_token: Optional[Union[str, Base64FileInput]]` Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored. - `to_date: Optional[str]` The end date for the query range, inclusive (YYYY-MM-DD). ### Returns - `class InstrumentDataGetInstrumentIncomeStatementsResponse: …` - `data: InstrumentIncomeStatementList` - `accepted_date: datetime` The date and time when the filing was accepted by the SEC - `filing_date: date` The date the financial statement was filed - `period: str` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: str` The currency in which the statement is reported (ISO 4217) - `year: int` The fiscal year of the statement - `bottom_line_net_income: Optional[str]` Bottom line net income after all adjustments - `cost_and_expenses: Optional[str]` Total costs and expenses - `cost_of_revenue: Optional[str]` Direct costs attributable to producing goods sold - `depreciation_and_amortization: Optional[str]` Depreciation and amortization expenses - `ebit: Optional[str]` Earnings before interest and taxes - `ebitda: Optional[str]` Earnings before interest, taxes, depreciation, and amortization - `eps: Optional[str]` Basic earnings per share - `eps_diluted: Optional[str]` Diluted earnings per share - `general_and_administrative_expenses: Optional[str]` General administrative overhead expenses - `gross_profit: Optional[str]` Revenue minus cost of revenue - `income_before_tax: Optional[str]` Income before income tax expense - `income_tax_expense: Optional[str]` Income tax expense for the period - `interest_expense: Optional[str]` Interest paid on debt - `interest_income: Optional[str]` Interest earned on investments and cash - `net_income: Optional[str]` Total net income for the period - `net_income_deductions: Optional[str]` Deductions from net income - `net_income_from_continuing_operations: Optional[str]` Net income from continuing operations - `net_income_from_discontinued_operations: Optional[str]` Net income from discontinued operations - `net_interest_income: Optional[str]` Net interest income (interest income minus interest expense) - `non_operating_income_excluding_interest: Optional[str]` Non-operating income excluding interest - `operating_expenses: Optional[str]` Total operating expenses - `operating_income: Optional[str]` Income from core business operations - `other_adjustments_to_net_income: Optional[str]` Other adjustments to net income - `other_expenses: Optional[str]` Other miscellaneous expenses - `research_and_development_expenses: Optional[str]` Expenditure on research and development activities - `revenue: Optional[str]` Total revenue from sales of goods and services - `selling_and_marketing_expenses: Optional[str]` Expenditure on marketing and sales activities - `selling_general_and_administrative_expenses: Optional[str]` Combined selling, general, and administrative expenses - `total_other_income_expenses_net: Optional[str]` Net of other income and expenses - `weighted_average_shs_out: Optional[str]` Weighted average shares outstanding (basic) - `weighted_average_shs_out_dil: Optional[str]` Weighted average shares outstanding (diluted) ### Example ```python from clear_street import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.instrument_data.get_instrument_income_statements( instrument_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", ) print(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 `v1.instrument_data.get_instrument_analyst_consensus(InstrumentIDOrSymbolinstrument_id, InstrumentDataGetInstrumentAnalystConsensusParams**kwargs) -> InstrumentDataGetInstrumentAnalystConsensusResponse` **get** `/v1/instruments/{instrument_id}/analyst-reporting` Retrieves analyst ratings and price targets for an instrument. ### Parameters - `instrument_id: InstrumentIDOrSymbol` OEMS instrument UUID - `from_: Optional[Union[null, null]]` The start date for the query range, inclusive (YYYY-MM-DD) - `to: Optional[Union[null, null]]` The end date for the query range, inclusive (YYYY-MM-DD) ### Returns - `class InstrumentDataGetInstrumentAnalystConsensusResponse: …` - `data: InstrumentAnalystConsensus` Aggregated analyst consensus metrics - `date: date` The date the consensus snapshot was generated - `distribution: Optional[AnalystDistribution]` Count of individual analyst recommendations by category - `buy: int` Number of buy recommendations - `hold: int` Number of hold recommendations - `sell: int` Number of sell recommendations - `strong_buy: int` Number of strong buy recommendations - `strong_sell: int` Number of strong sell recommendations - `price_target: Optional[PriceTarget]` Aggregated analyst price target statistics - `average: str` Average analyst price target - `currency: str` ISO 4217 currency code of the price targets - `high: str` Highest analyst price target - `low: str` Lowest analyst price target - `rating: Optional[AnalystRating]` Consensus analyst rating - `"STRONG_BUY"` - `"BUY"` - `"HOLD"` - `"SELL"` - `"STRONG_SELL"` ### Example ```python from clear_street import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.instrument_data.get_instrument_analyst_consensus( instrument_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", ) print(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 `v1.instrument_data.get_instrument_cash_flow_statements(InstrumentIDOrSymbolinstrument_id, InstrumentDataGetInstrumentCashFlowStatementsParams**kwargs) -> 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 - `from_date: Optional[str]` The start date for the query range, inclusive (YYYY-MM-DD). - `page_size: Optional[int]` The number of items to return per page. Only used when page_token is not provided. - `page_token: Optional[Union[str, Base64FileInput]]` Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored. - `to_date: Optional[str]` The end date for the query range, inclusive (YYYY-MM-DD). ### Returns - `class InstrumentDataGetInstrumentCashFlowStatementsResponse: …` - `data: InstrumentCashFlowStatementList` - `accepted_date: datetime` The date and time when the filing was accepted by the SEC - `filing_date: date` The date the financial statement was filed - `period: str` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: str` The currency in which the statement is reported (ISO 4217) - `year: int` The fiscal year of the statement - `accounts_payables: Optional[str]` Change in accounts payables - `accounts_receivables: Optional[str]` Change in accounts receivables - `acquisitions_net: Optional[str]` Net acquisitions - `capital_expenditure: Optional[str]` Capital expenditure - `cash_at_beginning_of_period: Optional[str]` Cash and cash equivalents at beginning of period - `cash_at_end_of_period: Optional[str]` Cash and cash equivalents at end of period - `change_in_working_capital: Optional[str]` Change in working capital - `common_dividends_paid: Optional[str]` Common dividends paid - `common_stock_issuance: Optional[str]` Common stock issuance - `common_stock_repurchased: Optional[str]` Common stock repurchased (buybacks) - `deferred_income_tax: Optional[str]` Deferred income tax expense - `depreciation_and_amortization: Optional[str]` Depreciation and amortization expense - `effect_of_forex_changes_on_cash: Optional[str]` Effect of foreign exchange changes on cash - `free_cash_flow: Optional[str]` Free cash flow (operating cash flow minus capital expenditure) - `income_taxes_paid: Optional[str]` Income taxes paid - `interest_paid: Optional[str]` Interest paid - `inventory: Optional[str]` Change in inventory - `investments_in_property_plant_and_equipment: Optional[str]` Investments in property, plant, and equipment - `long_term_net_debt_issuance: Optional[str]` Long-term net debt issuance - `net_cash_provided_by_financing_activities: Optional[str]` Net cash provided by financing activities - `net_cash_provided_by_investing_activities: Optional[str]` Net cash provided by investing activities - `net_cash_provided_by_operating_activities: Optional[str]` Net cash provided by operating activities - `net_change_in_cash: Optional[str]` Net change in cash during the period - `net_common_stock_issuance: Optional[str]` Net common stock issuance - `net_debt_issuance: Optional[str]` Net debt issuance (long-term + short-term) - `net_dividends_paid: Optional[str]` Net dividends paid (common + preferred) - `net_income: Optional[str]` Net income for the period - `net_preferred_stock_issuance: Optional[str]` Net preferred stock issuance - `net_stock_issuance: Optional[str]` Net stock issuance (common + preferred) - `operating_cash_flow: Optional[str]` Operating cash flow (alternative calculation) - `other_financing_activities: Optional[str]` Other financing activities - `other_investing_activities: Optional[str]` Other investing activities - `other_non_cash_items: Optional[str]` Other non-cash items - `other_working_capital: Optional[str]` Change in other working capital - `preferred_dividends_paid: Optional[str]` Preferred dividends paid - `purchases_of_investments: Optional[str]` Purchases of investments - `sales_maturities_of_investments: Optional[str]` Sales and maturities of investments - `short_term_net_debt_issuance: Optional[str]` Short-term net debt issuance - `stock_based_compensation: Optional[str]` Stock-based compensation expense ### Example ```python from clear_street import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.instrument_data.get_instrument_cash_flow_statements( instrument_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", ) print(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 - `Literal["EARNINGS", "DIVIDEND", "STOCK_SPLIT", "IPO"]` Event types supported by the all-events endpoint. - `"EARNINGS"` - `"DIVIDEND"` - `"STOCK_SPLIT"` - `"IPO"` ### Analyst Distribution - `class AnalystDistribution: …` Analyst recommendation distribution - `buy: int` Number of buy recommendations - `hold: int` Number of hold recommendations - `sell: int` Number of sell recommendations - `strong_buy: int` Number of strong buy recommendations - `strong_sell: int` Number of strong sell recommendations ### Analyst Rating - `Literal["STRONG_BUY", "BUY", "HOLD", 2 more]` Analyst rating category - `"STRONG_BUY"` - `"BUY"` - `"HOLD"` - `"SELL"` - `"STRONG_SELL"` ### Fiscal Period Type - `Literal["QUARTERLY", "ANNUAL", "TTM", "BIANNUAL"]` Fiscal period type for earnings reports - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` ### Instrument All Events Data - `class InstrumentAllEventsData: …` All-events payload grouped by date. - `event_dates: List[InstrumentEventsByDate]` Events grouped by date in descending order. - `date: date` Event date. - `events: List[InstrumentEventEnvelope]` Flat event envelopes for this date. - `symbol: str` Symbol associated with the event. - `type: AllEventsEventType` Event type discriminator. - `"EARNINGS"` - `"DIVIDEND"` - `"STOCK_SPLIT"` - `"IPO"` - `dividend_event_data: Optional[InstrumentDividendEvent]` Dividend payload when type is DIVIDEND. - `adjusted_dividend_amount: str` The adjusted dividend amount accounting for any splits. - `ex_date: date` The day the stock starts trading without the right to receive that dividend. - `declaration_date: Optional[date]` The declaration date of the dividend - `dividend_amount: Optional[str]` The dividend amount per share. - `dividend_yield: Optional[str]` The dividend yield as a percentage of the stock price. - `frequency: Optional[str]` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `payment_date: Optional[date]` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `record_date: Optional[date]` The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. - `earnings_event_data: Optional[InstrumentEarnings]` Earnings payload when type is EARNINGS. - `date: date` The date when the earnings report was published - `eps_actual: Optional[str]` The actual earnings per share (EPS) for the period - `eps_estimate: Optional[str]` The estimated earnings per share (EPS) for the period - `eps_surprise_percent: Optional[str]` The percentage difference between actual and estimated EPS - `revenue_actual: Optional[str]` The actual total revenue for the period - `revenue_estimate: Optional[str]` The estimated total revenue for the period - `revenue_surprise_percent: Optional[str]` The percentage difference between actual and estimated revenue - `instrument_id: Optional[str]` OEMS instrument identifier, when the instrument is found in the instrument cache. - `ipo_event_data: Optional[InstrumentEventIpoItem]` IPO payload when type is IPO. - `actions: Optional[str]` IPO action. - `announced_at: Optional[datetime]` IPO announced timestamp. - `company: Optional[str]` IPO company name. - `exchange: Optional[str]` IPO exchange. - `market_cap: Optional[str]` IPO market cap. - `price_range: Optional[str]` IPO price range. - `shares: Optional[str]` IPO shares offered. - `name: Optional[str]` Instrument name associated with the event, when available. - `reporting_currency: Optional[str]` The currency used for reporting financial data. - `stock_split_event_data: Optional[InstrumentSplitEvent]` Stock split payload when type is STOCK_SPLIT. - `date: date` The date of the stock split - `denominator: str` The denominator of the split ratio - `numerator: str` The numerator of the split ratio - `split_type: str` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") ### Instrument Analyst Consensus - `class InstrumentAnalystConsensus: …` Aggregated analyst consensus metrics - `date: date` The date the consensus snapshot was generated - `distribution: Optional[AnalystDistribution]` Count of individual analyst recommendations by category - `buy: int` Number of buy recommendations - `hold: int` Number of hold recommendations - `sell: int` Number of sell recommendations - `strong_buy: int` Number of strong buy recommendations - `strong_sell: int` Number of strong sell recommendations - `price_target: Optional[PriceTarget]` Aggregated analyst price target statistics - `average: str` Average analyst price target - `currency: str` ISO 4217 currency code of the price targets - `high: str` Highest analyst price target - `low: str` Lowest analyst price target - `rating: Optional[AnalystRating]` Consensus analyst rating - `"STRONG_BUY"` - `"BUY"` - `"HOLD"` - `"SELL"` - `"STRONG_SELL"` ### Instrument Balance Sheet Statement - `class InstrumentBalanceSheetStatement: …` A quarterly balance sheet statement for an instrument. - `accepted_date: datetime` The date and time when the filing was accepted by the SEC - `filing_date: date` The date the financial statement was filed - `period: str` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: str` The currency in which the statement is reported (ISO 4217) - `year: int` The fiscal year of the statement - `account_payables: Optional[str]` Account payables - `accounts_receivables: Optional[str]` Accounts receivables - `accrued_expenses: Optional[str]` Accrued expenses - `accumulated_other_comprehensive_income_loss: Optional[str]` Accumulated other comprehensive income/loss - `additional_paid_in_capital: Optional[str]` Additional paid-in capital - `capital_lease_obligations: Optional[str]` Capital lease obligations (total) - `capital_lease_obligations_current: Optional[str]` Capital lease obligations (current portion) - `cash_and_cash_equivalents: Optional[str]` Cash and cash equivalents - `cash_and_short_term_investments: Optional[str]` Cash and short-term investments combined - `common_stock: Optional[str]` Common stock - `deferred_revenue: Optional[str]` Deferred revenue - `deferred_revenue_non_current: Optional[str]` Deferred revenue (non-current) - `deferred_tax_liabilities_non_current: Optional[str]` Deferred tax liabilities (non-current) - `goodwill: Optional[str]` Goodwill - `goodwill_and_intangible_assets: Optional[str]` Goodwill and intangible assets combined - `intangible_assets: Optional[str]` Intangible assets - `inventory: Optional[str]` Inventory - `long_term_debt: Optional[str]` Long-term debt - `long_term_investments: Optional[str]` Long-term investments - `minority_interest: Optional[str]` Minority interest - `net_debt: Optional[str]` Net debt (total debt minus cash) - `net_receivables: Optional[str]` Net receivables - `other_assets: Optional[str]` Other assets - `other_current_assets: Optional[str]` Other current assets - `other_current_liabilities: Optional[str]` Other current liabilities - `other_liabilities: Optional[str]` Other liabilities - `other_non_current_assets: Optional[str]` Other non-current assets - `other_non_current_liabilities: Optional[str]` Other non-current liabilities - `other_payables: Optional[str]` Other payables - `other_receivables: Optional[str]` Other receivables - `other_total_stockholders_equity: Optional[str]` Other total stockholders equity - `preferred_stock: Optional[str]` Preferred stock - `prepaids: Optional[str]` Prepaids - `property_plant_and_equipment_net: Optional[str]` Property, plant and equipment net of depreciation - `retained_earnings: Optional[str]` Retained earnings - `short_term_debt: Optional[str]` Short-term debt - `short_term_investments: Optional[str]` Short-term investments - `tax_assets: Optional[str]` Tax assets - `tax_payables: Optional[str]` Tax payables - `total_assets: Optional[str]` Total assets - `total_current_assets: Optional[str]` Total current assets - `total_current_liabilities: Optional[str]` Total current liabilities - `total_debt: Optional[str]` Total debt - `total_equity: Optional[str]` Total equity - `total_investments: Optional[str]` Total investments - `total_liabilities: Optional[str]` Total liabilities - `total_liabilities_and_total_equity: Optional[str]` Total liabilities and total equity - `total_non_current_assets: Optional[str]` Total non-current assets - `total_non_current_liabilities: Optional[str]` Total non-current liabilities - `total_payables: Optional[str]` Total payables - `total_stockholders_equity: Optional[str]` Total stockholders equity - `treasury_stock: Optional[str]` Treasury stock ### Instrument Balance Sheet Statement List - `List[InstrumentBalanceSheetStatement]` - `accepted_date: datetime` The date and time when the filing was accepted by the SEC - `filing_date: date` The date the financial statement was filed - `period: str` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: str` The currency in which the statement is reported (ISO 4217) - `year: int` The fiscal year of the statement - `account_payables: Optional[str]` Account payables - `accounts_receivables: Optional[str]` Accounts receivables - `accrued_expenses: Optional[str]` Accrued expenses - `accumulated_other_comprehensive_income_loss: Optional[str]` Accumulated other comprehensive income/loss - `additional_paid_in_capital: Optional[str]` Additional paid-in capital - `capital_lease_obligations: Optional[str]` Capital lease obligations (total) - `capital_lease_obligations_current: Optional[str]` Capital lease obligations (current portion) - `cash_and_cash_equivalents: Optional[str]` Cash and cash equivalents - `cash_and_short_term_investments: Optional[str]` Cash and short-term investments combined - `common_stock: Optional[str]` Common stock - `deferred_revenue: Optional[str]` Deferred revenue - `deferred_revenue_non_current: Optional[str]` Deferred revenue (non-current) - `deferred_tax_liabilities_non_current: Optional[str]` Deferred tax liabilities (non-current) - `goodwill: Optional[str]` Goodwill - `goodwill_and_intangible_assets: Optional[str]` Goodwill and intangible assets combined - `intangible_assets: Optional[str]` Intangible assets - `inventory: Optional[str]` Inventory - `long_term_debt: Optional[str]` Long-term debt - `long_term_investments: Optional[str]` Long-term investments - `minority_interest: Optional[str]` Minority interest - `net_debt: Optional[str]` Net debt (total debt minus cash) - `net_receivables: Optional[str]` Net receivables - `other_assets: Optional[str]` Other assets - `other_current_assets: Optional[str]` Other current assets - `other_current_liabilities: Optional[str]` Other current liabilities - `other_liabilities: Optional[str]` Other liabilities - `other_non_current_assets: Optional[str]` Other non-current assets - `other_non_current_liabilities: Optional[str]` Other non-current liabilities - `other_payables: Optional[str]` Other payables - `other_receivables: Optional[str]` Other receivables - `other_total_stockholders_equity: Optional[str]` Other total stockholders equity - `preferred_stock: Optional[str]` Preferred stock - `prepaids: Optional[str]` Prepaids - `property_plant_and_equipment_net: Optional[str]` Property, plant and equipment net of depreciation - `retained_earnings: Optional[str]` Retained earnings - `short_term_debt: Optional[str]` Short-term debt - `short_term_investments: Optional[str]` Short-term investments - `tax_assets: Optional[str]` Tax assets - `tax_payables: Optional[str]` Tax payables - `total_assets: Optional[str]` Total assets - `total_current_assets: Optional[str]` Total current assets - `total_current_liabilities: Optional[str]` Total current liabilities - `total_debt: Optional[str]` Total debt - `total_equity: Optional[str]` Total equity - `total_investments: Optional[str]` Total investments - `total_liabilities: Optional[str]` Total liabilities - `total_liabilities_and_total_equity: Optional[str]` Total liabilities and total equity - `total_non_current_assets: Optional[str]` Total non-current assets - `total_non_current_liabilities: Optional[str]` Total non-current liabilities - `total_payables: Optional[str]` Total payables - `total_stockholders_equity: Optional[str]` Total stockholders equity - `treasury_stock: Optional[str]` Treasury stock ### Instrument Cash Flow Statement - `class InstrumentCashFlowStatement: …` A quarterly cash flow statement for an instrument. - `accepted_date: datetime` The date and time when the filing was accepted by the SEC - `filing_date: date` The date the financial statement was filed - `period: str` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: str` The currency in which the statement is reported (ISO 4217) - `year: int` The fiscal year of the statement - `accounts_payables: Optional[str]` Change in accounts payables - `accounts_receivables: Optional[str]` Change in accounts receivables - `acquisitions_net: Optional[str]` Net acquisitions - `capital_expenditure: Optional[str]` Capital expenditure - `cash_at_beginning_of_period: Optional[str]` Cash and cash equivalents at beginning of period - `cash_at_end_of_period: Optional[str]` Cash and cash equivalents at end of period - `change_in_working_capital: Optional[str]` Change in working capital - `common_dividends_paid: Optional[str]` Common dividends paid - `common_stock_issuance: Optional[str]` Common stock issuance - `common_stock_repurchased: Optional[str]` Common stock repurchased (buybacks) - `deferred_income_tax: Optional[str]` Deferred income tax expense - `depreciation_and_amortization: Optional[str]` Depreciation and amortization expense - `effect_of_forex_changes_on_cash: Optional[str]` Effect of foreign exchange changes on cash - `free_cash_flow: Optional[str]` Free cash flow (operating cash flow minus capital expenditure) - `income_taxes_paid: Optional[str]` Income taxes paid - `interest_paid: Optional[str]` Interest paid - `inventory: Optional[str]` Change in inventory - `investments_in_property_plant_and_equipment: Optional[str]` Investments in property, plant, and equipment - `long_term_net_debt_issuance: Optional[str]` Long-term net debt issuance - `net_cash_provided_by_financing_activities: Optional[str]` Net cash provided by financing activities - `net_cash_provided_by_investing_activities: Optional[str]` Net cash provided by investing activities - `net_cash_provided_by_operating_activities: Optional[str]` Net cash provided by operating activities - `net_change_in_cash: Optional[str]` Net change in cash during the period - `net_common_stock_issuance: Optional[str]` Net common stock issuance - `net_debt_issuance: Optional[str]` Net debt issuance (long-term + short-term) - `net_dividends_paid: Optional[str]` Net dividends paid (common + preferred) - `net_income: Optional[str]` Net income for the period - `net_preferred_stock_issuance: Optional[str]` Net preferred stock issuance - `net_stock_issuance: Optional[str]` Net stock issuance (common + preferred) - `operating_cash_flow: Optional[str]` Operating cash flow (alternative calculation) - `other_financing_activities: Optional[str]` Other financing activities - `other_investing_activities: Optional[str]` Other investing activities - `other_non_cash_items: Optional[str]` Other non-cash items - `other_working_capital: Optional[str]` Change in other working capital - `preferred_dividends_paid: Optional[str]` Preferred dividends paid - `purchases_of_investments: Optional[str]` Purchases of investments - `sales_maturities_of_investments: Optional[str]` Sales and maturities of investments - `short_term_net_debt_issuance: Optional[str]` Short-term net debt issuance - `stock_based_compensation: Optional[str]` Stock-based compensation expense ### Instrument Cash Flow Statement List - `List[InstrumentCashFlowStatement]` - `accepted_date: datetime` The date and time when the filing was accepted by the SEC - `filing_date: date` The date the financial statement was filed - `period: str` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: str` The currency in which the statement is reported (ISO 4217) - `year: int` The fiscal year of the statement - `accounts_payables: Optional[str]` Change in accounts payables - `accounts_receivables: Optional[str]` Change in accounts receivables - `acquisitions_net: Optional[str]` Net acquisitions - `capital_expenditure: Optional[str]` Capital expenditure - `cash_at_beginning_of_period: Optional[str]` Cash and cash equivalents at beginning of period - `cash_at_end_of_period: Optional[str]` Cash and cash equivalents at end of period - `change_in_working_capital: Optional[str]` Change in working capital - `common_dividends_paid: Optional[str]` Common dividends paid - `common_stock_issuance: Optional[str]` Common stock issuance - `common_stock_repurchased: Optional[str]` Common stock repurchased (buybacks) - `deferred_income_tax: Optional[str]` Deferred income tax expense - `depreciation_and_amortization: Optional[str]` Depreciation and amortization expense - `effect_of_forex_changes_on_cash: Optional[str]` Effect of foreign exchange changes on cash - `free_cash_flow: Optional[str]` Free cash flow (operating cash flow minus capital expenditure) - `income_taxes_paid: Optional[str]` Income taxes paid - `interest_paid: Optional[str]` Interest paid - `inventory: Optional[str]` Change in inventory - `investments_in_property_plant_and_equipment: Optional[str]` Investments in property, plant, and equipment - `long_term_net_debt_issuance: Optional[str]` Long-term net debt issuance - `net_cash_provided_by_financing_activities: Optional[str]` Net cash provided by financing activities - `net_cash_provided_by_investing_activities: Optional[str]` Net cash provided by investing activities - `net_cash_provided_by_operating_activities: Optional[str]` Net cash provided by operating activities - `net_change_in_cash: Optional[str]` Net change in cash during the period - `net_common_stock_issuance: Optional[str]` Net common stock issuance - `net_debt_issuance: Optional[str]` Net debt issuance (long-term + short-term) - `net_dividends_paid: Optional[str]` Net dividends paid (common + preferred) - `net_income: Optional[str]` Net income for the period - `net_preferred_stock_issuance: Optional[str]` Net preferred stock issuance - `net_stock_issuance: Optional[str]` Net stock issuance (common + preferred) - `operating_cash_flow: Optional[str]` Operating cash flow (alternative calculation) - `other_financing_activities: Optional[str]` Other financing activities - `other_investing_activities: Optional[str]` Other investing activities - `other_non_cash_items: Optional[str]` Other non-cash items - `other_working_capital: Optional[str]` Change in other working capital - `preferred_dividends_paid: Optional[str]` Preferred dividends paid - `purchases_of_investments: Optional[str]` Purchases of investments - `sales_maturities_of_investments: Optional[str]` Sales and maturities of investments - `short_term_net_debt_issuance: Optional[str]` Short-term net debt issuance - `stock_based_compensation: Optional[str]` Stock-based compensation expense ### Instrument Dividend Event - `class InstrumentDividendEvent: …` Represents a dividend event for an instrument - `adjusted_dividend_amount: str` The adjusted dividend amount accounting for any splits. - `ex_date: date` The day the stock starts trading without the right to receive that dividend. - `declaration_date: Optional[date]` The declaration date of the dividend - `dividend_amount: Optional[str]` The dividend amount per share. - `dividend_yield: Optional[str]` The dividend yield as a percentage of the stock price. - `frequency: Optional[str]` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `payment_date: Optional[date]` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `record_date: Optional[date]` 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 - `class InstrumentEarnings: …` Represents instrument earnings data - `date: date` The date when the earnings report was published - `eps_actual: Optional[str]` The actual earnings per share (EPS) for the period - `eps_estimate: Optional[str]` The estimated earnings per share (EPS) for the period - `eps_surprise_percent: Optional[str]` The percentage difference between actual and estimated EPS - `revenue_actual: Optional[str]` The actual total revenue for the period - `revenue_estimate: Optional[str]` The estimated total revenue for the period - `revenue_surprise_percent: Optional[str]` The percentage difference between actual and estimated revenue ### Instrument Event Envelope - `class InstrumentEventEnvelope: …` Unified envelope for the all-events response. - `symbol: str` Symbol associated with the event. - `type: AllEventsEventType` Event type discriminator. - `"EARNINGS"` - `"DIVIDEND"` - `"STOCK_SPLIT"` - `"IPO"` - `dividend_event_data: Optional[InstrumentDividendEvent]` Dividend payload when type is DIVIDEND. - `adjusted_dividend_amount: str` The adjusted dividend amount accounting for any splits. - `ex_date: date` The day the stock starts trading without the right to receive that dividend. - `declaration_date: Optional[date]` The declaration date of the dividend - `dividend_amount: Optional[str]` The dividend amount per share. - `dividend_yield: Optional[str]` The dividend yield as a percentage of the stock price. - `frequency: Optional[str]` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `payment_date: Optional[date]` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `record_date: Optional[date]` The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. - `earnings_event_data: Optional[InstrumentEarnings]` Earnings payload when type is EARNINGS. - `date: date` The date when the earnings report was published - `eps_actual: Optional[str]` The actual earnings per share (EPS) for the period - `eps_estimate: Optional[str]` The estimated earnings per share (EPS) for the period - `eps_surprise_percent: Optional[str]` The percentage difference between actual and estimated EPS - `revenue_actual: Optional[str]` The actual total revenue for the period - `revenue_estimate: Optional[str]` The estimated total revenue for the period - `revenue_surprise_percent: Optional[str]` The percentage difference between actual and estimated revenue - `instrument_id: Optional[str]` OEMS instrument identifier, when the instrument is found in the instrument cache. - `ipo_event_data: Optional[InstrumentEventIpoItem]` IPO payload when type is IPO. - `actions: Optional[str]` IPO action. - `announced_at: Optional[datetime]` IPO announced timestamp. - `company: Optional[str]` IPO company name. - `exchange: Optional[str]` IPO exchange. - `market_cap: Optional[str]` IPO market cap. - `price_range: Optional[str]` IPO price range. - `shares: Optional[str]` IPO shares offered. - `name: Optional[str]` Instrument name associated with the event, when available. - `reporting_currency: Optional[str]` The currency used for reporting financial data. - `stock_split_event_data: Optional[InstrumentSplitEvent]` Stock split payload when type is STOCK_SPLIT. - `date: date` The date of the stock split - `denominator: str` The denominator of the split ratio - `numerator: str` The numerator of the split ratio - `split_type: str` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") ### Instrument Event Ipo Item - `class InstrumentEventIpoItem: …` IPO event in the all-events date grouping response. - `actions: Optional[str]` IPO action. - `announced_at: Optional[datetime]` IPO announced timestamp. - `company: Optional[str]` IPO company name. - `exchange: Optional[str]` IPO exchange. - `market_cap: Optional[str]` IPO market cap. - `price_range: Optional[str]` IPO price range. - `shares: Optional[str]` IPO shares offered. ### Instrument Events By Date - `class InstrumentEventsByDate: …` Instrument events for a single date. - `date: date` Event date. - `events: List[InstrumentEventEnvelope]` Flat event envelopes for this date. - `symbol: str` Symbol associated with the event. - `type: AllEventsEventType` Event type discriminator. - `"EARNINGS"` - `"DIVIDEND"` - `"STOCK_SPLIT"` - `"IPO"` - `dividend_event_data: Optional[InstrumentDividendEvent]` Dividend payload when type is DIVIDEND. - `adjusted_dividend_amount: str` The adjusted dividend amount accounting for any splits. - `ex_date: date` The day the stock starts trading without the right to receive that dividend. - `declaration_date: Optional[date]` The declaration date of the dividend - `dividend_amount: Optional[str]` The dividend amount per share. - `dividend_yield: Optional[str]` The dividend yield as a percentage of the stock price. - `frequency: Optional[str]` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `payment_date: Optional[date]` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `record_date: Optional[date]` The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. - `earnings_event_data: Optional[InstrumentEarnings]` Earnings payload when type is EARNINGS. - `date: date` The date when the earnings report was published - `eps_actual: Optional[str]` The actual earnings per share (EPS) for the period - `eps_estimate: Optional[str]` The estimated earnings per share (EPS) for the period - `eps_surprise_percent: Optional[str]` The percentage difference between actual and estimated EPS - `revenue_actual: Optional[str]` The actual total revenue for the period - `revenue_estimate: Optional[str]` The estimated total revenue for the period - `revenue_surprise_percent: Optional[str]` The percentage difference between actual and estimated revenue - `instrument_id: Optional[str]` OEMS instrument identifier, when the instrument is found in the instrument cache. - `ipo_event_data: Optional[InstrumentEventIpoItem]` IPO payload when type is IPO. - `actions: Optional[str]` IPO action. - `announced_at: Optional[datetime]` IPO announced timestamp. - `company: Optional[str]` IPO company name. - `exchange: Optional[str]` IPO exchange. - `market_cap: Optional[str]` IPO market cap. - `price_range: Optional[str]` IPO price range. - `shares: Optional[str]` IPO shares offered. - `name: Optional[str]` Instrument name associated with the event, when available. - `reporting_currency: Optional[str]` The currency used for reporting financial data. - `stock_split_event_data: Optional[InstrumentSplitEvent]` Stock split payload when type is STOCK_SPLIT. - `date: date` The date of the stock split - `denominator: str` The denominator of the split ratio - `numerator: str` The numerator of the split ratio - `split_type: str` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") ### Instrument Events Data - `class InstrumentEventsData: …` Grouped instrument events by type - `dividends: List[InstrumentDividendEvent]` Dividend distribution events - `adjusted_dividend_amount: str` The adjusted dividend amount accounting for any splits. - `ex_date: date` The day the stock starts trading without the right to receive that dividend. - `declaration_date: Optional[date]` The declaration date of the dividend - `dividend_amount: Optional[str]` The dividend amount per share. - `dividend_yield: Optional[str]` The dividend yield as a percentage of the stock price. - `frequency: Optional[str]` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `payment_date: Optional[date]` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `record_date: Optional[date]` 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: List[InstrumentEarnings]` Earnings announcement events - `date: date` The date when the earnings report was published - `eps_actual: Optional[str]` The actual earnings per share (EPS) for the period - `eps_estimate: Optional[str]` The estimated earnings per share (EPS) for the period - `eps_surprise_percent: Optional[str]` The percentage difference between actual and estimated EPS - `revenue_actual: Optional[str]` The actual total revenue for the period - `revenue_estimate: Optional[str]` The estimated total revenue for the period - `revenue_surprise_percent: Optional[str]` The percentage difference between actual and estimated revenue - `instrument_id: str` OEMS instrument UUID from the request - `splits: List[InstrumentSplitEvent]` Stock split events - `date: date` The date of the stock split - `denominator: str` The denominator of the split ratio - `numerator: str` The numerator of the split ratio - `split_type: str` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") - `reporting_currency: Optional[str]` The currency used for reporting financial data ### Instrument Fundamentals - `class InstrumentFundamentals: …` Supplemental fundamentals and company profile data for an instrument. - `average_volume: Optional[int]` The average daily trading volume over the past 30 days - `beta: Optional[str]` The beta value, measuring the instrument's volatility relative to the overall market - `description: Optional[str]` A detailed description of the instrument or company - `dividend_yield: Optional[str]` The trailing twelve months (TTM) dividend yield - `earnings_per_share: Optional[str]` The trailing twelve months (TTM) earnings per share - `fifty_two_week_high: Optional[str]` The highest price over the last 52 weeks - `fifty_two_week_low: Optional[str]` The lowest price over the last 52 weeks - `industry: Optional[str]` The specific industry of the instrument's issuer - `list_date: Optional[date]` The date the instrument was first listed - `logo_url: Optional[str]` URL to a representative logo image for the instrument or issuer - `market_cap: Optional[str]` The total market capitalization - `previous_close: Optional[str]` The closing price from the previous trading day - `price_to_earnings: Optional[str]` The price-to-earnings (P/E) ratio for the trailing twelve months (TTM) - `reporting_currency: Optional[str]` The currency used for reporting financial data - `sector: Optional[str]` The business sector of the instrument's issuer ### Instrument Income Statement - `class InstrumentIncomeStatement: …` A quarterly income statement for an instrument. - `accepted_date: datetime` The date and time when the filing was accepted by the SEC - `filing_date: date` The date the financial statement was filed - `period: str` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: str` The currency in which the statement is reported (ISO 4217) - `year: int` The fiscal year of the statement - `bottom_line_net_income: Optional[str]` Bottom line net income after all adjustments - `cost_and_expenses: Optional[str]` Total costs and expenses - `cost_of_revenue: Optional[str]` Direct costs attributable to producing goods sold - `depreciation_and_amortization: Optional[str]` Depreciation and amortization expenses - `ebit: Optional[str]` Earnings before interest and taxes - `ebitda: Optional[str]` Earnings before interest, taxes, depreciation, and amortization - `eps: Optional[str]` Basic earnings per share - `eps_diluted: Optional[str]` Diluted earnings per share - `general_and_administrative_expenses: Optional[str]` General administrative overhead expenses - `gross_profit: Optional[str]` Revenue minus cost of revenue - `income_before_tax: Optional[str]` Income before income tax expense - `income_tax_expense: Optional[str]` Income tax expense for the period - `interest_expense: Optional[str]` Interest paid on debt - `interest_income: Optional[str]` Interest earned on investments and cash - `net_income: Optional[str]` Total net income for the period - `net_income_deductions: Optional[str]` Deductions from net income - `net_income_from_continuing_operations: Optional[str]` Net income from continuing operations - `net_income_from_discontinued_operations: Optional[str]` Net income from discontinued operations - `net_interest_income: Optional[str]` Net interest income (interest income minus interest expense) - `non_operating_income_excluding_interest: Optional[str]` Non-operating income excluding interest - `operating_expenses: Optional[str]` Total operating expenses - `operating_income: Optional[str]` Income from core business operations - `other_adjustments_to_net_income: Optional[str]` Other adjustments to net income - `other_expenses: Optional[str]` Other miscellaneous expenses - `research_and_development_expenses: Optional[str]` Expenditure on research and development activities - `revenue: Optional[str]` Total revenue from sales of goods and services - `selling_and_marketing_expenses: Optional[str]` Expenditure on marketing and sales activities - `selling_general_and_administrative_expenses: Optional[str]` Combined selling, general, and administrative expenses - `total_other_income_expenses_net: Optional[str]` Net of other income and expenses - `weighted_average_shs_out: Optional[str]` Weighted average shares outstanding (basic) - `weighted_average_shs_out_dil: Optional[str]` Weighted average shares outstanding (diluted) ### Instrument Income Statement List - `List[InstrumentIncomeStatement]` - `accepted_date: datetime` The date and time when the filing was accepted by the SEC - `filing_date: date` The date the financial statement was filed - `period: str` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: str` The currency in which the statement is reported (ISO 4217) - `year: int` The fiscal year of the statement - `bottom_line_net_income: Optional[str]` Bottom line net income after all adjustments - `cost_and_expenses: Optional[str]` Total costs and expenses - `cost_of_revenue: Optional[str]` Direct costs attributable to producing goods sold - `depreciation_and_amortization: Optional[str]` Depreciation and amortization expenses - `ebit: Optional[str]` Earnings before interest and taxes - `ebitda: Optional[str]` Earnings before interest, taxes, depreciation, and amortization - `eps: Optional[str]` Basic earnings per share - `eps_diluted: Optional[str]` Diluted earnings per share - `general_and_administrative_expenses: Optional[str]` General administrative overhead expenses - `gross_profit: Optional[str]` Revenue minus cost of revenue - `income_before_tax: Optional[str]` Income before income tax expense - `income_tax_expense: Optional[str]` Income tax expense for the period - `interest_expense: Optional[str]` Interest paid on debt - `interest_income: Optional[str]` Interest earned on investments and cash - `net_income: Optional[str]` Total net income for the period - `net_income_deductions: Optional[str]` Deductions from net income - `net_income_from_continuing_operations: Optional[str]` Net income from continuing operations - `net_income_from_discontinued_operations: Optional[str]` Net income from discontinued operations - `net_interest_income: Optional[str]` Net interest income (interest income minus interest expense) - `non_operating_income_excluding_interest: Optional[str]` Non-operating income excluding interest - `operating_expenses: Optional[str]` Total operating expenses - `operating_income: Optional[str]` Income from core business operations - `other_adjustments_to_net_income: Optional[str]` Other adjustments to net income - `other_expenses: Optional[str]` Other miscellaneous expenses - `research_and_development_expenses: Optional[str]` Expenditure on research and development activities - `revenue: Optional[str]` Total revenue from sales of goods and services - `selling_and_marketing_expenses: Optional[str]` Expenditure on marketing and sales activities - `selling_general_and_administrative_expenses: Optional[str]` Combined selling, general, and administrative expenses - `total_other_income_expenses_net: Optional[str]` Net of other income and expenses - `weighted_average_shs_out: Optional[str]` Weighted average shares outstanding (basic) - `weighted_average_shs_out_dil: Optional[str]` Weighted average shares outstanding (diluted) ### Instrument Split Event - `class InstrumentSplitEvent: …` Represents a stock split event for an instrument - `date: date` The date of the stock split - `denominator: str` The denominator of the split ratio - `numerator: str` The numerator of the split ratio - `split_type: str` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") ### Price Target - `class PriceTarget: …` Analyst price target statistics - `average: str` Average analyst price target - `currency: str` ISO 4217 currency code of the price targets - `high: str` Highest analyst price target - `low: str` Lowest analyst price target ### Instrument Data Get All Instrument Events Response - `class InstrumentDataGetAllInstrumentEventsResponse: …` - `data: InstrumentAllEventsData` All-events payload grouped by date. - `event_dates: List[InstrumentEventsByDate]` Events grouped by date in descending order. - `date: date` Event date. - `events: List[InstrumentEventEnvelope]` Flat event envelopes for this date. - `symbol: str` Symbol associated with the event. - `type: AllEventsEventType` Event type discriminator. - `"EARNINGS"` - `"DIVIDEND"` - `"STOCK_SPLIT"` - `"IPO"` - `dividend_event_data: Optional[InstrumentDividendEvent]` Dividend payload when type is DIVIDEND. - `adjusted_dividend_amount: str` The adjusted dividend amount accounting for any splits. - `ex_date: date` The day the stock starts trading without the right to receive that dividend. - `declaration_date: Optional[date]` The declaration date of the dividend - `dividend_amount: Optional[str]` The dividend amount per share. - `dividend_yield: Optional[str]` The dividend yield as a percentage of the stock price. - `frequency: Optional[str]` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `payment_date: Optional[date]` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `record_date: Optional[date]` The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. - `earnings_event_data: Optional[InstrumentEarnings]` Earnings payload when type is EARNINGS. - `date: date` The date when the earnings report was published - `eps_actual: Optional[str]` The actual earnings per share (EPS) for the period - `eps_estimate: Optional[str]` The estimated earnings per share (EPS) for the period - `eps_surprise_percent: Optional[str]` The percentage difference between actual and estimated EPS - `revenue_actual: Optional[str]` The actual total revenue for the period - `revenue_estimate: Optional[str]` The estimated total revenue for the period - `revenue_surprise_percent: Optional[str]` The percentage difference between actual and estimated revenue - `instrument_id: Optional[str]` OEMS instrument identifier, when the instrument is found in the instrument cache. - `ipo_event_data: Optional[InstrumentEventIpoItem]` IPO payload when type is IPO. - `actions: Optional[str]` IPO action. - `announced_at: Optional[datetime]` IPO announced timestamp. - `company: Optional[str]` IPO company name. - `exchange: Optional[str]` IPO exchange. - `market_cap: Optional[str]` IPO market cap. - `price_range: Optional[str]` IPO price range. - `shares: Optional[str]` IPO shares offered. - `name: Optional[str]` Instrument name associated with the event, when available. - `reporting_currency: Optional[str]` The currency used for reporting financial data. - `stock_split_event_data: Optional[InstrumentSplitEvent]` Stock split payload when type is STOCK_SPLIT. - `date: date` The date of the stock split - `denominator: str` The denominator of the split ratio - `numerator: str` The numerator of the split ratio - `split_type: str` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") ### Instrument Data Get Instrument Events Response - `class InstrumentDataGetInstrumentEventsResponse: …` - `data: InstrumentEventsData` Grouped instrument events by type - `dividends: List[InstrumentDividendEvent]` Dividend distribution events - `adjusted_dividend_amount: str` The adjusted dividend amount accounting for any splits. - `ex_date: date` The day the stock starts trading without the right to receive that dividend. - `declaration_date: Optional[date]` The declaration date of the dividend - `dividend_amount: Optional[str]` The dividend amount per share. - `dividend_yield: Optional[str]` The dividend yield as a percentage of the stock price. - `frequency: Optional[str]` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `payment_date: Optional[date]` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `record_date: Optional[date]` 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: List[InstrumentEarnings]` Earnings announcement events - `date: date` The date when the earnings report was published - `eps_actual: Optional[str]` The actual earnings per share (EPS) for the period - `eps_estimate: Optional[str]` The estimated earnings per share (EPS) for the period - `eps_surprise_percent: Optional[str]` The percentage difference between actual and estimated EPS - `revenue_actual: Optional[str]` The actual total revenue for the period - `revenue_estimate: Optional[str]` The estimated total revenue for the period - `revenue_surprise_percent: Optional[str]` The percentage difference between actual and estimated revenue - `instrument_id: str` OEMS instrument UUID from the request - `splits: List[InstrumentSplitEvent]` Stock split events - `date: date` The date of the stock split - `denominator: str` The denominator of the split ratio - `numerator: str` The numerator of the split ratio - `split_type: str` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") - `reporting_currency: Optional[str]` The currency used for reporting financial data ### Instrument Data Get Instrument Fundamentals Response - `class InstrumentDataGetInstrumentFundamentalsResponse: …` - `data: InstrumentFundamentals` Supplemental fundamentals and company profile data for an instrument. - `average_volume: Optional[int]` The average daily trading volume over the past 30 days - `beta: Optional[str]` The beta value, measuring the instrument's volatility relative to the overall market - `description: Optional[str]` A detailed description of the instrument or company - `dividend_yield: Optional[str]` The trailing twelve months (TTM) dividend yield - `earnings_per_share: Optional[str]` The trailing twelve months (TTM) earnings per share - `fifty_two_week_high: Optional[str]` The highest price over the last 52 weeks - `fifty_two_week_low: Optional[str]` The lowest price over the last 52 weeks - `industry: Optional[str]` The specific industry of the instrument's issuer - `list_date: Optional[date]` The date the instrument was first listed - `logo_url: Optional[str]` URL to a representative logo image for the instrument or issuer - `market_cap: Optional[str]` The total market capitalization - `previous_close: Optional[str]` The closing price from the previous trading day - `price_to_earnings: Optional[str]` The price-to-earnings (P/E) ratio for the trailing twelve months (TTM) - `reporting_currency: Optional[str]` The currency used for reporting financial data - `sector: Optional[str]` The business sector of the instrument's issuer ### Instrument Data Get Instrument Balance Sheet Statements Response - `class InstrumentDataGetInstrumentBalanceSheetStatementsResponse: …` - `data: InstrumentBalanceSheetStatementList` - `accepted_date: datetime` The date and time when the filing was accepted by the SEC - `filing_date: date` The date the financial statement was filed - `period: str` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: str` The currency in which the statement is reported (ISO 4217) - `year: int` The fiscal year of the statement - `account_payables: Optional[str]` Account payables - `accounts_receivables: Optional[str]` Accounts receivables - `accrued_expenses: Optional[str]` Accrued expenses - `accumulated_other_comprehensive_income_loss: Optional[str]` Accumulated other comprehensive income/loss - `additional_paid_in_capital: Optional[str]` Additional paid-in capital - `capital_lease_obligations: Optional[str]` Capital lease obligations (total) - `capital_lease_obligations_current: Optional[str]` Capital lease obligations (current portion) - `cash_and_cash_equivalents: Optional[str]` Cash and cash equivalents - `cash_and_short_term_investments: Optional[str]` Cash and short-term investments combined - `common_stock: Optional[str]` Common stock - `deferred_revenue: Optional[str]` Deferred revenue - `deferred_revenue_non_current: Optional[str]` Deferred revenue (non-current) - `deferred_tax_liabilities_non_current: Optional[str]` Deferred tax liabilities (non-current) - `goodwill: Optional[str]` Goodwill - `goodwill_and_intangible_assets: Optional[str]` Goodwill and intangible assets combined - `intangible_assets: Optional[str]` Intangible assets - `inventory: Optional[str]` Inventory - `long_term_debt: Optional[str]` Long-term debt - `long_term_investments: Optional[str]` Long-term investments - `minority_interest: Optional[str]` Minority interest - `net_debt: Optional[str]` Net debt (total debt minus cash) - `net_receivables: Optional[str]` Net receivables - `other_assets: Optional[str]` Other assets - `other_current_assets: Optional[str]` Other current assets - `other_current_liabilities: Optional[str]` Other current liabilities - `other_liabilities: Optional[str]` Other liabilities - `other_non_current_assets: Optional[str]` Other non-current assets - `other_non_current_liabilities: Optional[str]` Other non-current liabilities - `other_payables: Optional[str]` Other payables - `other_receivables: Optional[str]` Other receivables - `other_total_stockholders_equity: Optional[str]` Other total stockholders equity - `preferred_stock: Optional[str]` Preferred stock - `prepaids: Optional[str]` Prepaids - `property_plant_and_equipment_net: Optional[str]` Property, plant and equipment net of depreciation - `retained_earnings: Optional[str]` Retained earnings - `short_term_debt: Optional[str]` Short-term debt - `short_term_investments: Optional[str]` Short-term investments - `tax_assets: Optional[str]` Tax assets - `tax_payables: Optional[str]` Tax payables - `total_assets: Optional[str]` Total assets - `total_current_assets: Optional[str]` Total current assets - `total_current_liabilities: Optional[str]` Total current liabilities - `total_debt: Optional[str]` Total debt - `total_equity: Optional[str]` Total equity - `total_investments: Optional[str]` Total investments - `total_liabilities: Optional[str]` Total liabilities - `total_liabilities_and_total_equity: Optional[str]` Total liabilities and total equity - `total_non_current_assets: Optional[str]` Total non-current assets - `total_non_current_liabilities: Optional[str]` Total non-current liabilities - `total_payables: Optional[str]` Total payables - `total_stockholders_equity: Optional[str]` Total stockholders equity - `treasury_stock: Optional[str]` Treasury stock ### Instrument Data Get Instrument Income Statements Response - `class InstrumentDataGetInstrumentIncomeStatementsResponse: …` - `data: InstrumentIncomeStatementList` - `accepted_date: datetime` The date and time when the filing was accepted by the SEC - `filing_date: date` The date the financial statement was filed - `period: str` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: str` The currency in which the statement is reported (ISO 4217) - `year: int` The fiscal year of the statement - `bottom_line_net_income: Optional[str]` Bottom line net income after all adjustments - `cost_and_expenses: Optional[str]` Total costs and expenses - `cost_of_revenue: Optional[str]` Direct costs attributable to producing goods sold - `depreciation_and_amortization: Optional[str]` Depreciation and amortization expenses - `ebit: Optional[str]` Earnings before interest and taxes - `ebitda: Optional[str]` Earnings before interest, taxes, depreciation, and amortization - `eps: Optional[str]` Basic earnings per share - `eps_diluted: Optional[str]` Diluted earnings per share - `general_and_administrative_expenses: Optional[str]` General administrative overhead expenses - `gross_profit: Optional[str]` Revenue minus cost of revenue - `income_before_tax: Optional[str]` Income before income tax expense - `income_tax_expense: Optional[str]` Income tax expense for the period - `interest_expense: Optional[str]` Interest paid on debt - `interest_income: Optional[str]` Interest earned on investments and cash - `net_income: Optional[str]` Total net income for the period - `net_income_deductions: Optional[str]` Deductions from net income - `net_income_from_continuing_operations: Optional[str]` Net income from continuing operations - `net_income_from_discontinued_operations: Optional[str]` Net income from discontinued operations - `net_interest_income: Optional[str]` Net interest income (interest income minus interest expense) - `non_operating_income_excluding_interest: Optional[str]` Non-operating income excluding interest - `operating_expenses: Optional[str]` Total operating expenses - `operating_income: Optional[str]` Income from core business operations - `other_adjustments_to_net_income: Optional[str]` Other adjustments to net income - `other_expenses: Optional[str]` Other miscellaneous expenses - `research_and_development_expenses: Optional[str]` Expenditure on research and development activities - `revenue: Optional[str]` Total revenue from sales of goods and services - `selling_and_marketing_expenses: Optional[str]` Expenditure on marketing and sales activities - `selling_general_and_administrative_expenses: Optional[str]` Combined selling, general, and administrative expenses - `total_other_income_expenses_net: Optional[str]` Net of other income and expenses - `weighted_average_shs_out: Optional[str]` Weighted average shares outstanding (basic) - `weighted_average_shs_out_dil: Optional[str]` Weighted average shares outstanding (diluted) ### Instrument Data Get Instrument Analyst Consensus Response - `class InstrumentDataGetInstrumentAnalystConsensusResponse: …` - `data: InstrumentAnalystConsensus` Aggregated analyst consensus metrics - `date: date` The date the consensus snapshot was generated - `distribution: Optional[AnalystDistribution]` Count of individual analyst recommendations by category - `buy: int` Number of buy recommendations - `hold: int` Number of hold recommendations - `sell: int` Number of sell recommendations - `strong_buy: int` Number of strong buy recommendations - `strong_sell: int` Number of strong sell recommendations - `price_target: Optional[PriceTarget]` Aggregated analyst price target statistics - `average: str` Average analyst price target - `currency: str` ISO 4217 currency code of the price targets - `high: str` Highest analyst price target - `low: str` Lowest analyst price target - `rating: Optional[AnalystRating]` Consensus analyst rating - `"STRONG_BUY"` - `"BUY"` - `"HOLD"` - `"SELL"` - `"STRONG_SELL"` ### Instrument Data Get Instrument Cash Flow Statements Response - `class InstrumentDataGetInstrumentCashFlowStatementsResponse: …` - `data: InstrumentCashFlowStatementList` - `accepted_date: datetime` The date and time when the filing was accepted by the SEC - `filing_date: date` The date the financial statement was filed - `period: str` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `period_type: FiscalPeriodType` The type of fiscal period - `"QUARTERLY"` - `"ANNUAL"` - `"TTM"` - `"BIANNUAL"` - `reported_currency: str` The currency in which the statement is reported (ISO 4217) - `year: int` The fiscal year of the statement - `accounts_payables: Optional[str]` Change in accounts payables - `accounts_receivables: Optional[str]` Change in accounts receivables - `acquisitions_net: Optional[str]` Net acquisitions - `capital_expenditure: Optional[str]` Capital expenditure - `cash_at_beginning_of_period: Optional[str]` Cash and cash equivalents at beginning of period - `cash_at_end_of_period: Optional[str]` Cash and cash equivalents at end of period - `change_in_working_capital: Optional[str]` Change in working capital - `common_dividends_paid: Optional[str]` Common dividends paid - `common_stock_issuance: Optional[str]` Common stock issuance - `common_stock_repurchased: Optional[str]` Common stock repurchased (buybacks) - `deferred_income_tax: Optional[str]` Deferred income tax expense - `depreciation_and_amortization: Optional[str]` Depreciation and amortization expense - `effect_of_forex_changes_on_cash: Optional[str]` Effect of foreign exchange changes on cash - `free_cash_flow: Optional[str]` Free cash flow (operating cash flow minus capital expenditure) - `income_taxes_paid: Optional[str]` Income taxes paid - `interest_paid: Optional[str]` Interest paid - `inventory: Optional[str]` Change in inventory - `investments_in_property_plant_and_equipment: Optional[str]` Investments in property, plant, and equipment - `long_term_net_debt_issuance: Optional[str]` Long-term net debt issuance - `net_cash_provided_by_financing_activities: Optional[str]` Net cash provided by financing activities - `net_cash_provided_by_investing_activities: Optional[str]` Net cash provided by investing activities - `net_cash_provided_by_operating_activities: Optional[str]` Net cash provided by operating activities - `net_change_in_cash: Optional[str]` Net change in cash during the period - `net_common_stock_issuance: Optional[str]` Net common stock issuance - `net_debt_issuance: Optional[str]` Net debt issuance (long-term + short-term) - `net_dividends_paid: Optional[str]` Net dividends paid (common + preferred) - `net_income: Optional[str]` Net income for the period - `net_preferred_stock_issuance: Optional[str]` Net preferred stock issuance - `net_stock_issuance: Optional[str]` Net stock issuance (common + preferred) - `operating_cash_flow: Optional[str]` Operating cash flow (alternative calculation) - `other_financing_activities: Optional[str]` Other financing activities - `other_investing_activities: Optional[str]` Other investing activities - `other_non_cash_items: Optional[str]` Other non-cash items - `other_working_capital: Optional[str]` Change in other working capital - `preferred_dividends_paid: Optional[str]` Preferred dividends paid - `purchases_of_investments: Optional[str]` Purchases of investments - `sales_maturities_of_investments: Optional[str]` Sales and maturities of investments - `short_term_net_debt_issuance: Optional[str]` Short-term net debt issuance - `stock_based_compensation: Optional[str]` Stock-based compensation expense # Market Data ## Get Snapshots `v1.instrument_data.market_data.get_snapshots(MarketDataGetSnapshotsParams**kwargs) -> MarketDataGetSnapshotsResponse` **get** `/v1/market-data/snapshot` Get market data snapshots for one or more securities. ### Parameters - `instrument_ids: Optional[Sequence[str]]` Comma-separated OEMS instrument UUIDs. ### Returns - `class MarketDataGetSnapshotsResponse: …` - `data: MarketDataSnapshotList` - `instrument_id: str` OEMS instrument identifier. - `symbol: str` Display symbol for the security. - `cumulative_volume: Optional[int]` Cumulative traded volume reported on the most recent trade, in shares for equities or contracts for options. Absent when no trade is available. - `last_quote: Optional[SnapshotQuote]` Most recent quote if available. - `ask: str` Current best ask. - `bid: str` Current best bid. - `midpoint: str` Midpoint of bid and ask. - `ask_size: Optional[int]` Size at the best ask, in shares. - `bid_size: Optional[int]` Size at the best bid, in shares. - `last_trade: Optional[SnapshotLastTrade]` Most recent last-sale trade if available. - `price: str` Most recent last-sale eligible trade price. - `name: Optional[str]` Security name if available. - `session: Optional[SnapshotSession]` Session metrics computed from previous close and last trade, if available. - `change: str` Absolute change from previous close to last trade. - `change_percent: str` Percent change from previous close to last trade. - `previous_close: str` Previous session close price. ### Example ```python from clear_street import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.instrument_data.market_data.get_snapshots() print(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 `v1.instrument_data.market_data.get_daily_summaries(MarketDataGetDailySummariesParams**kwargs) -> 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 - `instrument_ids: str` Comma-separated OEMS instrument UUIDs (required, 1..=100) ### Returns - `class MarketDataGetDailySummariesResponse: …` - `data: DailySummaryList` - `instrument_id: str` OEMS instrument identifier. Always populated; echoes the request ID. - `high: Optional[str]` Session high. - `low: Optional[str]` Session low. - `open: Optional[str]` Opening price for the session. - `symbol: Optional[str]` Display symbol for the security. `None` for unresolvable IDs. - `trade_date: Optional[date]` Session date the OHLV represents, US/Eastern. - `volume: Optional[int]` Session cumulative trading volume. ### Example ```python from clear_street import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.instrument_data.market_data.get_daily_summaries( instrument_ids="instrument_ids", ) print(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 - `class 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: str` OEMS instrument identifier. Always populated; echoes the request ID. - `high: Optional[str]` Session high. - `low: Optional[str]` Session low. - `open: Optional[str]` Opening price for the session. - `symbol: Optional[str]` Display symbol for the security. `None` for unresolvable IDs. - `trade_date: Optional[date]` Session date the OHLV represents, US/Eastern. - `volume: Optional[int]` Session cumulative trading volume. ### Daily Summary List - `List[DailySummary]` - `instrument_id: str` OEMS instrument identifier. Always populated; echoes the request ID. - `high: Optional[str]` Session high. - `low: Optional[str]` Session low. - `open: Optional[str]` Opening price for the session. - `symbol: Optional[str]` Display symbol for the security. `None` for unresolvable IDs. - `trade_date: Optional[date]` Session date the OHLV represents, US/Eastern. - `volume: Optional[int]` Session cumulative trading volume. ### Market Data Snapshot - `class MarketDataSnapshot: …` Market data snapshot for a single security. - `instrument_id: str` OEMS instrument identifier. - `symbol: str` Display symbol for the security. - `cumulative_volume: Optional[int]` Cumulative traded volume reported on the most recent trade, in shares for equities or contracts for options. Absent when no trade is available. - `last_quote: Optional[SnapshotQuote]` Most recent quote if available. - `ask: str` Current best ask. - `bid: str` Current best bid. - `midpoint: str` Midpoint of bid and ask. - `ask_size: Optional[int]` Size at the best ask, in shares. - `bid_size: Optional[int]` Size at the best bid, in shares. - `last_trade: Optional[SnapshotLastTrade]` Most recent last-sale trade if available. - `price: str` Most recent last-sale eligible trade price. - `name: Optional[str]` Security name if available. - `session: Optional[SnapshotSession]` Session metrics computed from previous close and last trade, if available. - `change: str` Absolute change from previous close to last trade. - `change_percent: str` Percent change from previous close to last trade. - `previous_close: str` Previous session close price. ### Market Data Snapshot List - `List[MarketDataSnapshot]` - `instrument_id: str` OEMS instrument identifier. - `symbol: str` Display symbol for the security. - `cumulative_volume: Optional[int]` Cumulative traded volume reported on the most recent trade, in shares for equities or contracts for options. Absent when no trade is available. - `last_quote: Optional[SnapshotQuote]` Most recent quote if available. - `ask: str` Current best ask. - `bid: str` Current best bid. - `midpoint: str` Midpoint of bid and ask. - `ask_size: Optional[int]` Size at the best ask, in shares. - `bid_size: Optional[int]` Size at the best bid, in shares. - `last_trade: Optional[SnapshotLastTrade]` Most recent last-sale trade if available. - `price: str` Most recent last-sale eligible trade price. - `name: Optional[str]` Security name if available. - `session: Optional[SnapshotSession]` Session metrics computed from previous close and last trade, if available. - `change: str` Absolute change from previous close to last trade. - `change_percent: str` Percent change from previous close to last trade. - `previous_close: str` Previous session close price. ### Snapshot Last Trade - `class SnapshotLastTrade: …` Last-trade fields for a market data snapshot. - `price: str` Most recent last-sale eligible trade price. ### Snapshot Quote - `class SnapshotQuote: …` L1 quote fields for a market data snapshot. - `ask: str` Current best ask. - `bid: str` Current best bid. - `midpoint: str` Midpoint of bid and ask. - `ask_size: Optional[int]` Size at the best ask, in shares. - `bid_size: Optional[int]` Size at the best bid, in shares. ### Snapshot Session - `class SnapshotSession: …` Session-level pricing metrics for a market data snapshot. - `change: str` Absolute change from previous close to last trade. - `change_percent: str` Percent change from previous close to last trade. - `previous_close: str` Previous session close price. ### Market Data Get Snapshots Response - `class MarketDataGetSnapshotsResponse: …` - `data: MarketDataSnapshotList` - `instrument_id: str` OEMS instrument identifier. - `symbol: str` Display symbol for the security. - `cumulative_volume: Optional[int]` Cumulative traded volume reported on the most recent trade, in shares for equities or contracts for options. Absent when no trade is available. - `last_quote: Optional[SnapshotQuote]` Most recent quote if available. - `ask: str` Current best ask. - `bid: str` Current best bid. - `midpoint: str` Midpoint of bid and ask. - `ask_size: Optional[int]` Size at the best ask, in shares. - `bid_size: Optional[int]` Size at the best bid, in shares. - `last_trade: Optional[SnapshotLastTrade]` Most recent last-sale trade if available. - `price: str` Most recent last-sale eligible trade price. - `name: Optional[str]` Security name if available. - `session: Optional[SnapshotSession]` Session metrics computed from previous close and last trade, if available. - `change: str` Absolute change from previous close to last trade. - `change_percent: str` Percent change from previous close to last trade. - `previous_close: str` Previous session close price. ### Market Data Get Daily Summaries Response - `class MarketDataGetDailySummariesResponse: …` - `data: DailySummaryList` - `instrument_id: str` OEMS instrument identifier. Always populated; echoes the request ID. - `high: Optional[str]` Session high. - `low: Optional[str]` Session low. - `open: Optional[str]` Opening price for the session. - `symbol: Optional[str]` Display symbol for the security. `None` for unresolvable IDs. - `trade_date: Optional[date]` Session date the OHLV represents, US/Eastern. - `volume: Optional[int]` Session cumulative trading volume. # News ## Get News `v1.instrument_data.news.get_news(NewsGetNewsParams**kwargs) -> NewsGetNewsResponse` **get** `/v1/news` Retrieves news items with optional filtering by security IDs, time range, publisher, type, and text query. ### Parameters - `exclude_publishers: Optional[str]` Comma-separated list of publishers to exclude (mutually exclusive with include_publishers). - `from_: Optional[str]` Inclusive start timestamp. Accepts `YYYY-MM-DD` or RFC3339 datetime. - `include_publishers: Optional[str]` Comma-separated list of publishers to include (mutually exclusive with exclude_publishers). - `instrument_ids: Optional[Sequence[str]]` Comma-delimited OEMS instrument UUIDs to filter by. - `news_type: Optional[Literal["NEWS", "PRESS_RELEASE"]]` Filter by news type. - `"NEWS"` - `"PRESS_RELEASE"` - `page_size: Optional[int]` The number of items to return per page. Only used when page_token is not provided. - `page_token: Optional[Union[str, Base64FileInput]]` Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored. - `search_query: Optional[str]` Free-text query matched against title/text and associated security IDs. - `sectors: Optional[List[Literal["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: Optional[str]` Inclusive end timestamp. Accepts `YYYY-MM-DD` or RFC3339 datetime. ### Returns - `class NewsGetNewsResponse: …` - `data: NewsItemList` - `instruments: List[NewsInstrument]` Instruments associated with this news item. - `instrument_id: str` OEMS instrument UUID. - `name: Optional[str]` Instrument name/description, if available from instrument cache enrichment. - `symbol: Optional[str]` Trading symbol, if available from instrument cache enrichment. - `news_type: NewsType` Classification of the item. - `"NEWS"` - `"PRESS_RELEASE"` - `published_at: datetime` The published date/time of the article in UTC. - `publisher: str` The publisher or newswire source. - `title: str` The headline/title of the article. - `url: str` Canonical URL to the full article. - `image_url: Optional[str]` URL of an associated image if provided by the source. - `site: Optional[str]` The primary domain/site of the publisher. - `text: Optional[str]` The full or excerpted article body. ### Example ```python from clear_street import ClearStreet client = ClearStreet( api_key="My API Key", ) response = client.v1.instrument_data.news.get_news() print(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 - `class NewsInstrument: …` Instrument associated with a news item. - `instrument_id: str` OEMS instrument UUID. - `name: Optional[str]` Instrument name/description, if available from instrument cache enrichment. - `symbol: Optional[str]` Trading symbol, if available from instrument cache enrichment. ### News Item - `class NewsItem: …` A single news item and its associated instruments. - `instruments: List[NewsInstrument]` Instruments associated with this news item. - `instrument_id: str` OEMS instrument UUID. - `name: Optional[str]` Instrument name/description, if available from instrument cache enrichment. - `symbol: Optional[str]` Trading symbol, if available from instrument cache enrichment. - `news_type: NewsType` Classification of the item. - `"NEWS"` - `"PRESS_RELEASE"` - `published_at: datetime` The published date/time of the article in UTC. - `publisher: str` The publisher or newswire source. - `title: str` The headline/title of the article. - `url: str` Canonical URL to the full article. - `image_url: Optional[str]` URL of an associated image if provided by the source. - `site: Optional[str]` The primary domain/site of the publisher. - `text: Optional[str]` The full or excerpted article body. ### News Item List - `List[NewsItem]` - `instruments: List[NewsInstrument]` Instruments associated with this news item. - `instrument_id: str` OEMS instrument UUID. - `name: Optional[str]` Instrument name/description, if available from instrument cache enrichment. - `symbol: Optional[str]` Trading symbol, if available from instrument cache enrichment. - `news_type: NewsType` Classification of the item. - `"NEWS"` - `"PRESS_RELEASE"` - `published_at: datetime` The published date/time of the article in UTC. - `publisher: str` The publisher or newswire source. - `title: str` The headline/title of the article. - `url: str` Canonical URL to the full article. - `image_url: Optional[str]` URL of an associated image if provided by the source. - `site: Optional[str]` The primary domain/site of the publisher. - `text: Optional[str]` The full or excerpted article body. ### News Type - `Literal["NEWS", "PRESS_RELEASE"]` News item classification. - `"NEWS"` - `"PRESS_RELEASE"` ### News Get News Response - `class NewsGetNewsResponse: …` - `data: NewsItemList` - `instruments: List[NewsInstrument]` Instruments associated with this news item. - `instrument_id: str` OEMS instrument UUID. - `name: Optional[str]` Instrument name/description, if available from instrument cache enrichment. - `symbol: Optional[str]` Trading symbol, if available from instrument cache enrichment. - `news_type: NewsType` Classification of the item. - `"NEWS"` - `"PRESS_RELEASE"` - `published_at: datetime` The published date/time of the article in UTC. - `publisher: str` The publisher or newswire source. - `title: str` The headline/title of the article. - `url: str` Canonical URL to the full article. - `image_url: Optional[str]` URL of an associated image if provided by the source. - `site: Optional[str]` The primary domain/site of the publisher. - `text: Optional[str]` The full or excerpted article body.