# Instrument Data ## Get All Instrument Events `InstrumentDataGetAllInstrumentEventsResponse v1().instrumentData().getAllInstrumentEvents(InstrumentDataGetAllInstrumentEventsParamsparams = InstrumentDataGetAllInstrumentEventsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **get** `/v1/instruments/events` List instrument events across all securities. Retrieves all instrument events grouped by date. ### Parameters - `InstrumentDataGetAllInstrumentEventsParams params` - `Optional> eventTypes` Filter by event type(s). Comma-delimited list. Example: `event_types=EARNINGS,IPO`. - `EARNINGS("EARNINGS")` - `DIVIDEND("DIVIDEND")` - `STOCK_SPLIT("STOCK_SPLIT")` - `IPO("IPO")` - `Optional fromDate` The start date for the query range, inclusive (YYYY-MM-DD). - `Optional> instrumentIds` Filter by OEMS instrument ID(s). Comma-delimited list of UUIDs. Example: `instrument_ids=550e8400-e29b-41d4-a716-446655440000`. - `Optional toDate` The end date for the query range, inclusive (YYYY-MM-DD). ### Returns - `class InstrumentDataGetAllInstrumentEventsResponse:` - `InstrumentAllEventsData data` All-events payload grouped by date. - `List eventDates` Events grouped by date in descending order. - `LocalDate date` Event date. - `List events` Flat event envelopes for this date. - `String symbol` Symbol associated with the event. - `AllEventsEventType type` Event type discriminator. - `EARNINGS("EARNINGS")` - `DIVIDEND("DIVIDEND")` - `STOCK_SPLIT("STOCK_SPLIT")` - `IPO("IPO")` - `Optional dividendEventData` Dividend payload when type is DIVIDEND. - `String adjustedDividendAmount` The adjusted dividend amount accounting for any splits. - `LocalDate exDate` The day the stock starts trading without the right to receive that dividend. - `Optional declarationDate` The declaration date of the dividend - `Optional dividendAmount` The dividend amount per share. - `Optional dividendYield` The dividend yield as a percentage of the stock price. - `Optional frequency` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `Optional paymentDate` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `Optional recordDate` The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. - `Optional earningsEventData` Earnings payload when type is EARNINGS. - `LocalDate date` The date when the earnings report was published - `Optional epsActual` The actual earnings per share (EPS) for the period - `Optional epsEstimate` The estimated earnings per share (EPS) for the period - `Optional epsSurprisePercent` The percentage difference between actual and estimated EPS - `Optional revenueActual` The actual total revenue for the period - `Optional revenueEstimate` The estimated total revenue for the period - `Optional revenueSurprisePercent` The percentage difference between actual and estimated revenue - `Optional instrumentId` OEMS instrument identifier, when the instrument is found in the instrument cache. - `Optional ipoEventData` IPO payload when type is IPO. - `Optional actions` IPO action. - `Optional announcedAt` IPO announced timestamp. - `Optional company` IPO company name. - `Optional exchange` IPO exchange. - `Optional marketCap` IPO market cap. - `Optional priceRange` IPO price range. - `Optional shares` IPO shares offered. - `Optional name` Instrument name associated with the event, when available. - `Optional reportingCurrency` The currency used for reporting financial data. - `Optional stockSplitEventData` Stock split payload when type is STOCK_SPLIT. - `LocalDate date` The date of the stock split - `String denominator` The denominator of the split ratio - `String numerator` The numerator of the split ratio - `String splitType` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") ### Example ```java package com.clear_street.api.example; import com.clear_street.api.client.ClearStreetClient; import com.clear_street.api.client.okhttp.ClearStreetOkHttpClient; import com.clear_street.api.models.v1.instrumentdata.InstrumentDataGetAllInstrumentEventsParams; import com.clear_street.api.models.v1.instrumentdata.InstrumentDataGetAllInstrumentEventsResponse; public final class Main { private Main() {} public static void main(String[] args) { ClearStreetClient client = ClearStreetOkHttpClient.builder() .fromEnv() .apiKey("My API Key") .build(); InstrumentDataGetAllInstrumentEventsResponse response = client.v1().instrumentData().getAllInstrumentEvents(); } } ``` #### 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 `InstrumentDataGetInstrumentEventsResponse v1().instrumentData().getInstrumentEvents(InstrumentDataGetInstrumentEventsParamsparams = InstrumentDataGetInstrumentEventsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 - `InstrumentDataGetInstrumentEventsParams params` - `Optional instrumentId` OEMS instrument UUID - `Optional fromDate` The start date for the query range, inclusive (YYYY-MM-DD). - `Optional toDate` The end date for the query range, inclusive (YYYY-MM-DD). ### Returns - `class InstrumentDataGetInstrumentEventsResponse:` - `InstrumentEventsData data` Grouped instrument events by type - `List dividends` Dividend distribution events - `String adjustedDividendAmount` The adjusted dividend amount accounting for any splits. - `LocalDate exDate` The day the stock starts trading without the right to receive that dividend. - `Optional declarationDate` The declaration date of the dividend - `Optional dividendAmount` The dividend amount per share. - `Optional dividendYield` The dividend yield as a percentage of the stock price. - `Optional frequency` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `Optional paymentDate` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `Optional recordDate` The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. - `List earnings` Earnings announcement events - `LocalDate date` The date when the earnings report was published - `Optional epsActual` The actual earnings per share (EPS) for the period - `Optional epsEstimate` The estimated earnings per share (EPS) for the period - `Optional epsSurprisePercent` The percentage difference between actual and estimated EPS - `Optional revenueActual` The actual total revenue for the period - `Optional revenueEstimate` The estimated total revenue for the period - `Optional revenueSurprisePercent` The percentage difference between actual and estimated revenue - `String instrumentId` OEMS instrument UUID from the request - `List splits` Stock split events - `LocalDate date` The date of the stock split - `String denominator` The denominator of the split ratio - `String numerator` The numerator of the split ratio - `String splitType` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") - `Optional reportingCurrency` The currency used for reporting financial data ### Example ```java package com.clear_street.api.example; import com.clear_street.api.client.ClearStreetClient; import com.clear_street.api.client.okhttp.ClearStreetOkHttpClient; import com.clear_street.api.models.v1.instrumentdata.InstrumentDataGetInstrumentEventsParams; import com.clear_street.api.models.v1.instrumentdata.InstrumentDataGetInstrumentEventsResponse; public final class Main { private Main() {} public static void main(String[] args) { ClearStreetClient client = ClearStreetOkHttpClient.builder() .fromEnv() .apiKey("My API Key") .build(); InstrumentDataGetInstrumentEventsResponse response = client.v1().instrumentData().getInstrumentEvents("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"); } } ``` #### 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 `InstrumentDataGetInstrumentFundamentalsResponse v1().instrumentData().getInstrumentFundamentals(InstrumentDataGetInstrumentFundamentalsParamsparams = InstrumentDataGetInstrumentFundamentalsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **get** `/v1/instruments/{instrument_id}/fundamentals` Retrieves supplemental fundamentals and company profile data for an instrument. ### Parameters - `InstrumentDataGetInstrumentFundamentalsParams params` - `Optional instrumentId` OEMS instrument UUID ### Returns - `class InstrumentDataGetInstrumentFundamentalsResponse:` - `InstrumentFundamentals data` Supplemental fundamentals and company profile data for an instrument. - `Optional averageVolume` The average daily trading volume over the past 30 days - `Optional beta` The beta value, measuring the instrument's volatility relative to the overall market - `Optional description` A detailed description of the instrument or company - `Optional dividendYield` The trailing twelve months (TTM) dividend yield - `Optional earningsPerShare` The trailing twelve months (TTM) earnings per share - `Optional fiftyTwoWeekHigh` The highest price over the last 52 weeks - `Optional fiftyTwoWeekLow` The lowest price over the last 52 weeks - `Optional industry` The specific industry of the instrument's issuer - `Optional listDate` The date the instrument was first listed - `Optional logoUrl` URL to a representative logo image for the instrument or issuer - `Optional marketCap` The total market capitalization - `Optional previousClose` The closing price from the previous trading day - `Optional priceToEarnings` The price-to-earnings (P/E) ratio for the trailing twelve months (TTM) - `Optional reportingCurrency` The currency used for reporting financial data - `Optional sector` The business sector of the instrument's issuer ### Example ```java package com.clear_street.api.example; import com.clear_street.api.client.ClearStreetClient; import com.clear_street.api.client.okhttp.ClearStreetOkHttpClient; import com.clear_street.api.models.v1.instrumentdata.InstrumentDataGetInstrumentFundamentalsParams; import com.clear_street.api.models.v1.instrumentdata.InstrumentDataGetInstrumentFundamentalsResponse; public final class Main { private Main() {} public static void main(String[] args) { ClearStreetClient client = ClearStreetOkHttpClient.builder() .fromEnv() .apiKey("My API Key") .build(); InstrumentDataGetInstrumentFundamentalsResponse response = client.v1().instrumentData().getInstrumentFundamentals("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"); } } ``` #### 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 `InstrumentDataGetInstrumentBalanceSheetStatementsResponse v1().instrumentData().getInstrumentBalanceSheetStatements(InstrumentDataGetInstrumentBalanceSheetStatementsParamsparams = InstrumentDataGetInstrumentBalanceSheetStatementsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 - `InstrumentDataGetInstrumentBalanceSheetStatementsParams params` - `Optional instrumentId` OEMS instrument UUID - `Optional fromDate` The start date for the query range, inclusive (YYYY-MM-DD). - `Optional pageSize` The number of items to return per page. Only used when page_token is not provided. - `Optional pageToken` Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored. - `Optional toDate` The end date for the query range, inclusive (YYYY-MM-DD). ### Returns - `class InstrumentDataGetInstrumentBalanceSheetStatementsResponse:` - `List data` - `LocalDateTime acceptedDate` The date and time when the filing was accepted by the SEC - `LocalDate filingDate` The date the financial statement was filed - `String period` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `FiscalPeriodType periodType` The type of fiscal period - `QUARTERLY("QUARTERLY")` - `ANNUAL("ANNUAL")` - `TTM("TTM")` - `BIANNUAL("BIANNUAL")` - `String reportedCurrency` The currency in which the statement is reported (ISO 4217) - `long year` The fiscal year of the statement - `Optional accountPayables` Account payables - `Optional accountsReceivables` Accounts receivables - `Optional accruedExpenses` Accrued expenses - `Optional accumulatedOtherComprehensiveIncomeLoss` Accumulated other comprehensive income/loss - `Optional additionalPaidInCapital` Additional paid-in capital - `Optional capitalLeaseObligations` Capital lease obligations (total) - `Optional capitalLeaseObligationsCurrent` Capital lease obligations (current portion) - `Optional cashAndCashEquivalents` Cash and cash equivalents - `Optional cashAndShortTermInvestments` Cash and short-term investments combined - `Optional commonStock` Common stock - `Optional deferredRevenue` Deferred revenue - `Optional deferredRevenueNonCurrent` Deferred revenue (non-current) - `Optional deferredTaxLiabilitiesNonCurrent` Deferred tax liabilities (non-current) - `Optional goodwill` Goodwill - `Optional goodwillAndIntangibleAssets` Goodwill and intangible assets combined - `Optional intangibleAssets` Intangible assets - `Optional inventory` Inventory - `Optional longTermDebt` Long-term debt - `Optional longTermInvestments` Long-term investments - `Optional minorityInterest` Minority interest - `Optional netDebt` Net debt (total debt minus cash) - `Optional netReceivables` Net receivables - `Optional otherAssets` Other assets - `Optional otherCurrentAssets` Other current assets - `Optional otherCurrentLiabilities` Other current liabilities - `Optional otherLiabilities` Other liabilities - `Optional otherNonCurrentAssets` Other non-current assets - `Optional otherNonCurrentLiabilities` Other non-current liabilities - `Optional otherPayables` Other payables - `Optional otherReceivables` Other receivables - `Optional otherTotalStockholdersEquity` Other total stockholders equity - `Optional preferredStock` Preferred stock - `Optional prepaids` Prepaids - `Optional propertyPlantAndEquipmentNet` Property, plant and equipment net of depreciation - `Optional retainedEarnings` Retained earnings - `Optional shortTermDebt` Short-term debt - `Optional shortTermInvestments` Short-term investments - `Optional taxAssets` Tax assets - `Optional taxPayables` Tax payables - `Optional totalAssets` Total assets - `Optional totalCurrentAssets` Total current assets - `Optional totalCurrentLiabilities` Total current liabilities - `Optional totalDebt` Total debt - `Optional totalEquity` Total equity - `Optional totalInvestments` Total investments - `Optional totalLiabilities` Total liabilities - `Optional totalLiabilitiesAndTotalEquity` Total liabilities and total equity - `Optional totalNonCurrentAssets` Total non-current assets - `Optional totalNonCurrentLiabilities` Total non-current liabilities - `Optional totalPayables` Total payables - `Optional totalStockholdersEquity` Total stockholders equity - `Optional treasuryStock` Treasury stock ### Example ```java package com.clear_street.api.example; import com.clear_street.api.client.ClearStreetClient; import com.clear_street.api.client.okhttp.ClearStreetOkHttpClient; import com.clear_street.api.models.v1.instrumentdata.InstrumentDataGetInstrumentBalanceSheetStatementsParams; import com.clear_street.api.models.v1.instrumentdata.InstrumentDataGetInstrumentBalanceSheetStatementsResponse; public final class Main { private Main() {} public static void main(String[] args) { ClearStreetClient client = ClearStreetOkHttpClient.builder() .fromEnv() .apiKey("My API Key") .build(); InstrumentDataGetInstrumentBalanceSheetStatementsResponse response = client.v1().instrumentData().getInstrumentBalanceSheetStatements("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"); } } ``` #### 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 `InstrumentDataGetInstrumentIncomeStatementsResponse v1().instrumentData().getInstrumentIncomeStatements(InstrumentDataGetInstrumentIncomeStatementsParamsparams = InstrumentDataGetInstrumentIncomeStatementsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 - `InstrumentDataGetInstrumentIncomeStatementsParams params` - `Optional instrumentId` OEMS instrument UUID - `Optional fromDate` The start date for the query range, inclusive (YYYY-MM-DD). - `Optional pageSize` The number of items to return per page. Only used when page_token is not provided. - `Optional pageToken` Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored. - `Optional toDate` The end date for the query range, inclusive (YYYY-MM-DD). ### Returns - `class InstrumentDataGetInstrumentIncomeStatementsResponse:` - `List data` - `LocalDateTime acceptedDate` The date and time when the filing was accepted by the SEC - `LocalDate filingDate` The date the financial statement was filed - `String period` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `FiscalPeriodType periodType` The type of fiscal period - `QUARTERLY("QUARTERLY")` - `ANNUAL("ANNUAL")` - `TTM("TTM")` - `BIANNUAL("BIANNUAL")` - `String reportedCurrency` The currency in which the statement is reported (ISO 4217) - `long year` The fiscal year of the statement - `Optional bottomLineNetIncome` Bottom line net income after all adjustments - `Optional costAndExpenses` Total costs and expenses - `Optional costOfRevenue` Direct costs attributable to producing goods sold - `Optional depreciationAndAmortization` Depreciation and amortization expenses - `Optional ebit` Earnings before interest and taxes - `Optional ebitda` Earnings before interest, taxes, depreciation, and amortization - `Optional eps` Basic earnings per share - `Optional epsDiluted` Diluted earnings per share - `Optional generalAndAdministrativeExpenses` General administrative overhead expenses - `Optional grossProfit` Revenue minus cost of revenue - `Optional incomeBeforeTax` Income before income tax expense - `Optional incomeTaxExpense` Income tax expense for the period - `Optional interestExpense` Interest paid on debt - `Optional interestIncome` Interest earned on investments and cash - `Optional netIncome` Total net income for the period - `Optional netIncomeDeductions` Deductions from net income - `Optional netIncomeFromContinuingOperations` Net income from continuing operations - `Optional netIncomeFromDiscontinuedOperations` Net income from discontinued operations - `Optional netInterestIncome` Net interest income (interest income minus interest expense) - `Optional nonOperatingIncomeExcludingInterest` Non-operating income excluding interest - `Optional operatingExpenses` Total operating expenses - `Optional operatingIncome` Income from core business operations - `Optional otherAdjustmentsToNetIncome` Other adjustments to net income - `Optional otherExpenses` Other miscellaneous expenses - `Optional researchAndDevelopmentExpenses` Expenditure on research and development activities - `Optional revenue` Total revenue from sales of goods and services - `Optional sellingAndMarketingExpenses` Expenditure on marketing and sales activities - `Optional sellingGeneralAndAdministrativeExpenses` Combined selling, general, and administrative expenses - `Optional totalOtherIncomeExpensesNet` Net of other income and expenses - `Optional weightedAverageShsOut` Weighted average shares outstanding (basic) - `Optional weightedAverageShsOutDil` Weighted average shares outstanding (diluted) ### Example ```java package com.clear_street.api.example; import com.clear_street.api.client.ClearStreetClient; import com.clear_street.api.client.okhttp.ClearStreetOkHttpClient; import com.clear_street.api.models.v1.instrumentdata.InstrumentDataGetInstrumentIncomeStatementsParams; import com.clear_street.api.models.v1.instrumentdata.InstrumentDataGetInstrumentIncomeStatementsResponse; public final class Main { private Main() {} public static void main(String[] args) { ClearStreetClient client = ClearStreetOkHttpClient.builder() .fromEnv() .apiKey("My API Key") .build(); InstrumentDataGetInstrumentIncomeStatementsResponse response = client.v1().instrumentData().getInstrumentIncomeStatements("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"); } } ``` #### 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 `InstrumentDataGetInstrumentAnalystConsensusResponse v1().instrumentData().getInstrumentAnalystConsensus(InstrumentDataGetInstrumentAnalystConsensusParamsparams = InstrumentDataGetInstrumentAnalystConsensusParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **get** `/v1/instruments/{instrument_id}/analyst-reporting` Retrieves analyst ratings and price targets for an instrument. ### Parameters - `InstrumentDataGetInstrumentAnalystConsensusParams params` - `Optional instrumentId` OEMS instrument UUID - `Optional from` The start date for the query range, inclusive (YYYY-MM-DD) - `Optional to` The end date for the query range, inclusive (YYYY-MM-DD) ### Returns - `class InstrumentDataGetInstrumentAnalystConsensusResponse:` - `InstrumentAnalystConsensus data` Aggregated analyst consensus metrics - `LocalDate date` The date the consensus snapshot was generated - `Optional distribution` Count of individual analyst recommendations by category - `long buy` Number of buy recommendations - `long hold` Number of hold recommendations - `long sell` Number of sell recommendations - `long strongBuy` Number of strong buy recommendations - `long strongSell` Number of strong sell recommendations - `Optional priceTarget` Aggregated analyst price target statistics - `String average` Average analyst price target - `String currency` ISO 4217 currency code of the price targets - `String high` Highest analyst price target - `String low` Lowest analyst price target - `Optional rating` Consensus analyst rating - `STRONG_BUY("STRONG_BUY")` - `BUY("BUY")` - `HOLD("HOLD")` - `SELL("SELL")` - `STRONG_SELL("STRONG_SELL")` ### Example ```java package com.clear_street.api.example; import com.clear_street.api.client.ClearStreetClient; import com.clear_street.api.client.okhttp.ClearStreetOkHttpClient; import com.clear_street.api.models.v1.instrumentdata.InstrumentDataGetInstrumentAnalystConsensusParams; import com.clear_street.api.models.v1.instrumentdata.InstrumentDataGetInstrumentAnalystConsensusResponse; public final class Main { private Main() {} public static void main(String[] args) { ClearStreetClient client = ClearStreetOkHttpClient.builder() .fromEnv() .apiKey("My API Key") .build(); InstrumentDataGetInstrumentAnalystConsensusResponse response = client.v1().instrumentData().getInstrumentAnalystConsensus("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"); } } ``` #### 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 `InstrumentDataGetInstrumentCashFlowStatementsResponse v1().instrumentData().getInstrumentCashFlowStatements(InstrumentDataGetInstrumentCashFlowStatementsParamsparams = InstrumentDataGetInstrumentCashFlowStatementsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **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 - `InstrumentDataGetInstrumentCashFlowStatementsParams params` - `Optional instrumentId` OEMS instrument UUID - `Optional fromDate` The start date for the query range, inclusive (YYYY-MM-DD). - `Optional pageSize` The number of items to return per page. Only used when page_token is not provided. - `Optional pageToken` Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored. - `Optional toDate` The end date for the query range, inclusive (YYYY-MM-DD). ### Returns - `class InstrumentDataGetInstrumentCashFlowStatementsResponse:` - `List data` - `LocalDateTime acceptedDate` The date and time when the filing was accepted by the SEC - `LocalDate filingDate` The date the financial statement was filed - `String period` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `FiscalPeriodType periodType` The type of fiscal period - `QUARTERLY("QUARTERLY")` - `ANNUAL("ANNUAL")` - `TTM("TTM")` - `BIANNUAL("BIANNUAL")` - `String reportedCurrency` The currency in which the statement is reported (ISO 4217) - `long year` The fiscal year of the statement - `Optional accountsPayables` Change in accounts payables - `Optional accountsReceivables` Change in accounts receivables - `Optional acquisitionsNet` Net acquisitions - `Optional capitalExpenditure` Capital expenditure - `Optional cashAtBeginningOfPeriod` Cash and cash equivalents at beginning of period - `Optional cashAtEndOfPeriod` Cash and cash equivalents at end of period - `Optional changeInWorkingCapital` Change in working capital - `Optional commonDividendsPaid` Common dividends paid - `Optional commonStockIssuance` Common stock issuance - `Optional commonStockRepurchased` Common stock repurchased (buybacks) - `Optional deferredIncomeTax` Deferred income tax expense - `Optional depreciationAndAmortization` Depreciation and amortization expense - `Optional effectOfForexChangesOnCash` Effect of foreign exchange changes on cash - `Optional freeCashFlow` Free cash flow (operating cash flow minus capital expenditure) - `Optional incomeTaxesPaid` Income taxes paid - `Optional interestPaid` Interest paid - `Optional inventory` Change in inventory - `Optional investmentsInPropertyPlantAndEquipment` Investments in property, plant, and equipment - `Optional longTermNetDebtIssuance` Long-term net debt issuance - `Optional netCashProvidedByFinancingActivities` Net cash provided by financing activities - `Optional netCashProvidedByInvestingActivities` Net cash provided by investing activities - `Optional netCashProvidedByOperatingActivities` Net cash provided by operating activities - `Optional netChangeInCash` Net change in cash during the period - `Optional netCommonStockIssuance` Net common stock issuance - `Optional netDebtIssuance` Net debt issuance (long-term + short-term) - `Optional netDividendsPaid` Net dividends paid (common + preferred) - `Optional netIncome` Net income for the period - `Optional netPreferredStockIssuance` Net preferred stock issuance - `Optional netStockIssuance` Net stock issuance (common + preferred) - `Optional operatingCashFlow` Operating cash flow (alternative calculation) - `Optional otherFinancingActivities` Other financing activities - `Optional otherInvestingActivities` Other investing activities - `Optional otherNonCashItems` Other non-cash items - `Optional otherWorkingCapital` Change in other working capital - `Optional preferredDividendsPaid` Preferred dividends paid - `Optional purchasesOfInvestments` Purchases of investments - `Optional salesMaturitiesOfInvestments` Sales and maturities of investments - `Optional shortTermNetDebtIssuance` Short-term net debt issuance - `Optional stockBasedCompensation` Stock-based compensation expense ### Example ```java package com.clear_street.api.example; import com.clear_street.api.client.ClearStreetClient; import com.clear_street.api.client.okhttp.ClearStreetOkHttpClient; import com.clear_street.api.models.v1.instrumentdata.InstrumentDataGetInstrumentCashFlowStatementsParams; import com.clear_street.api.models.v1.instrumentdata.InstrumentDataGetInstrumentCashFlowStatementsResponse; public final class Main { private Main() {} public static void main(String[] args) { ClearStreetClient client = ClearStreetOkHttpClient.builder() .fromEnv() .apiKey("My API Key") .build(); InstrumentDataGetInstrumentCashFlowStatementsResponse response = client.v1().instrumentData().getInstrumentCashFlowStatements("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"); } } ``` #### 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 - `enum AllEventsEventType:` Event types supported by the all-events endpoint. - `EARNINGS("EARNINGS")` - `DIVIDEND("DIVIDEND")` - `STOCK_SPLIT("STOCK_SPLIT")` - `IPO("IPO")` ### Analyst Distribution - `class AnalystDistribution:` Analyst recommendation distribution - `long buy` Number of buy recommendations - `long hold` Number of hold recommendations - `long sell` Number of sell recommendations - `long strongBuy` Number of strong buy recommendations - `long strongSell` Number of strong sell recommendations ### Analyst Rating - `enum AnalystRating:` Analyst rating category - `STRONG_BUY("STRONG_BUY")` - `BUY("BUY")` - `HOLD("HOLD")` - `SELL("SELL")` - `STRONG_SELL("STRONG_SELL")` ### Fiscal Period Type - `enum FiscalPeriodType:` Fiscal period type for earnings reports - `QUARTERLY("QUARTERLY")` - `ANNUAL("ANNUAL")` - `TTM("TTM")` - `BIANNUAL("BIANNUAL")` ### Instrument All Events Data - `class InstrumentAllEventsData:` All-events payload grouped by date. - `List eventDates` Events grouped by date in descending order. - `LocalDate date` Event date. - `List events` Flat event envelopes for this date. - `String symbol` Symbol associated with the event. - `AllEventsEventType type` Event type discriminator. - `EARNINGS("EARNINGS")` - `DIVIDEND("DIVIDEND")` - `STOCK_SPLIT("STOCK_SPLIT")` - `IPO("IPO")` - `Optional dividendEventData` Dividend payload when type is DIVIDEND. - `String adjustedDividendAmount` The adjusted dividend amount accounting for any splits. - `LocalDate exDate` The day the stock starts trading without the right to receive that dividend. - `Optional declarationDate` The declaration date of the dividend - `Optional dividendAmount` The dividend amount per share. - `Optional dividendYield` The dividend yield as a percentage of the stock price. - `Optional frequency` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `Optional paymentDate` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `Optional recordDate` The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. - `Optional earningsEventData` Earnings payload when type is EARNINGS. - `LocalDate date` The date when the earnings report was published - `Optional epsActual` The actual earnings per share (EPS) for the period - `Optional epsEstimate` The estimated earnings per share (EPS) for the period - `Optional epsSurprisePercent` The percentage difference between actual and estimated EPS - `Optional revenueActual` The actual total revenue for the period - `Optional revenueEstimate` The estimated total revenue for the period - `Optional revenueSurprisePercent` The percentage difference between actual and estimated revenue - `Optional instrumentId` OEMS instrument identifier, when the instrument is found in the instrument cache. - `Optional ipoEventData` IPO payload when type is IPO. - `Optional actions` IPO action. - `Optional announcedAt` IPO announced timestamp. - `Optional company` IPO company name. - `Optional exchange` IPO exchange. - `Optional marketCap` IPO market cap. - `Optional priceRange` IPO price range. - `Optional shares` IPO shares offered. - `Optional name` Instrument name associated with the event, when available. - `Optional reportingCurrency` The currency used for reporting financial data. - `Optional stockSplitEventData` Stock split payload when type is STOCK_SPLIT. - `LocalDate date` The date of the stock split - `String denominator` The denominator of the split ratio - `String numerator` The numerator of the split ratio - `String splitType` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") ### Instrument Analyst Consensus - `class InstrumentAnalystConsensus:` Aggregated analyst consensus metrics - `LocalDate date` The date the consensus snapshot was generated - `Optional distribution` Count of individual analyst recommendations by category - `long buy` Number of buy recommendations - `long hold` Number of hold recommendations - `long sell` Number of sell recommendations - `long strongBuy` Number of strong buy recommendations - `long strongSell` Number of strong sell recommendations - `Optional priceTarget` Aggregated analyst price target statistics - `String average` Average analyst price target - `String currency` ISO 4217 currency code of the price targets - `String high` Highest analyst price target - `String low` Lowest analyst price target - `Optional rating` Consensus analyst rating - `STRONG_BUY("STRONG_BUY")` - `BUY("BUY")` - `HOLD("HOLD")` - `SELL("SELL")` - `STRONG_SELL("STRONG_SELL")` ### Instrument Balance Sheet Statement - `class InstrumentBalanceSheetStatement:` A quarterly balance sheet statement for an instrument. - `LocalDateTime acceptedDate` The date and time when the filing was accepted by the SEC - `LocalDate filingDate` The date the financial statement was filed - `String period` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `FiscalPeriodType periodType` The type of fiscal period - `QUARTERLY("QUARTERLY")` - `ANNUAL("ANNUAL")` - `TTM("TTM")` - `BIANNUAL("BIANNUAL")` - `String reportedCurrency` The currency in which the statement is reported (ISO 4217) - `long year` The fiscal year of the statement - `Optional accountPayables` Account payables - `Optional accountsReceivables` Accounts receivables - `Optional accruedExpenses` Accrued expenses - `Optional accumulatedOtherComprehensiveIncomeLoss` Accumulated other comprehensive income/loss - `Optional additionalPaidInCapital` Additional paid-in capital - `Optional capitalLeaseObligations` Capital lease obligations (total) - `Optional capitalLeaseObligationsCurrent` Capital lease obligations (current portion) - `Optional cashAndCashEquivalents` Cash and cash equivalents - `Optional cashAndShortTermInvestments` Cash and short-term investments combined - `Optional commonStock` Common stock - `Optional deferredRevenue` Deferred revenue - `Optional deferredRevenueNonCurrent` Deferred revenue (non-current) - `Optional deferredTaxLiabilitiesNonCurrent` Deferred tax liabilities (non-current) - `Optional goodwill` Goodwill - `Optional goodwillAndIntangibleAssets` Goodwill and intangible assets combined - `Optional intangibleAssets` Intangible assets - `Optional inventory` Inventory - `Optional longTermDebt` Long-term debt - `Optional longTermInvestments` Long-term investments - `Optional minorityInterest` Minority interest - `Optional netDebt` Net debt (total debt minus cash) - `Optional netReceivables` Net receivables - `Optional otherAssets` Other assets - `Optional otherCurrentAssets` Other current assets - `Optional otherCurrentLiabilities` Other current liabilities - `Optional otherLiabilities` Other liabilities - `Optional otherNonCurrentAssets` Other non-current assets - `Optional otherNonCurrentLiabilities` Other non-current liabilities - `Optional otherPayables` Other payables - `Optional otherReceivables` Other receivables - `Optional otherTotalStockholdersEquity` Other total stockholders equity - `Optional preferredStock` Preferred stock - `Optional prepaids` Prepaids - `Optional propertyPlantAndEquipmentNet` Property, plant and equipment net of depreciation - `Optional retainedEarnings` Retained earnings - `Optional shortTermDebt` Short-term debt - `Optional shortTermInvestments` Short-term investments - `Optional taxAssets` Tax assets - `Optional taxPayables` Tax payables - `Optional totalAssets` Total assets - `Optional totalCurrentAssets` Total current assets - `Optional totalCurrentLiabilities` Total current liabilities - `Optional totalDebt` Total debt - `Optional totalEquity` Total equity - `Optional totalInvestments` Total investments - `Optional totalLiabilities` Total liabilities - `Optional totalLiabilitiesAndTotalEquity` Total liabilities and total equity - `Optional totalNonCurrentAssets` Total non-current assets - `Optional totalNonCurrentLiabilities` Total non-current liabilities - `Optional totalPayables` Total payables - `Optional totalStockholdersEquity` Total stockholders equity - `Optional treasuryStock` Treasury stock ### Instrument Cash Flow Statement - `class InstrumentCashFlowStatement:` A quarterly cash flow statement for an instrument. - `LocalDateTime acceptedDate` The date and time when the filing was accepted by the SEC - `LocalDate filingDate` The date the financial statement was filed - `String period` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `FiscalPeriodType periodType` The type of fiscal period - `QUARTERLY("QUARTERLY")` - `ANNUAL("ANNUAL")` - `TTM("TTM")` - `BIANNUAL("BIANNUAL")` - `String reportedCurrency` The currency in which the statement is reported (ISO 4217) - `long year` The fiscal year of the statement - `Optional accountsPayables` Change in accounts payables - `Optional accountsReceivables` Change in accounts receivables - `Optional acquisitionsNet` Net acquisitions - `Optional capitalExpenditure` Capital expenditure - `Optional cashAtBeginningOfPeriod` Cash and cash equivalents at beginning of period - `Optional cashAtEndOfPeriod` Cash and cash equivalents at end of period - `Optional changeInWorkingCapital` Change in working capital - `Optional commonDividendsPaid` Common dividends paid - `Optional commonStockIssuance` Common stock issuance - `Optional commonStockRepurchased` Common stock repurchased (buybacks) - `Optional deferredIncomeTax` Deferred income tax expense - `Optional depreciationAndAmortization` Depreciation and amortization expense - `Optional effectOfForexChangesOnCash` Effect of foreign exchange changes on cash - `Optional freeCashFlow` Free cash flow (operating cash flow minus capital expenditure) - `Optional incomeTaxesPaid` Income taxes paid - `Optional interestPaid` Interest paid - `Optional inventory` Change in inventory - `Optional investmentsInPropertyPlantAndEquipment` Investments in property, plant, and equipment - `Optional longTermNetDebtIssuance` Long-term net debt issuance - `Optional netCashProvidedByFinancingActivities` Net cash provided by financing activities - `Optional netCashProvidedByInvestingActivities` Net cash provided by investing activities - `Optional netCashProvidedByOperatingActivities` Net cash provided by operating activities - `Optional netChangeInCash` Net change in cash during the period - `Optional netCommonStockIssuance` Net common stock issuance - `Optional netDebtIssuance` Net debt issuance (long-term + short-term) - `Optional netDividendsPaid` Net dividends paid (common + preferred) - `Optional netIncome` Net income for the period - `Optional netPreferredStockIssuance` Net preferred stock issuance - `Optional netStockIssuance` Net stock issuance (common + preferred) - `Optional operatingCashFlow` Operating cash flow (alternative calculation) - `Optional otherFinancingActivities` Other financing activities - `Optional otherInvestingActivities` Other investing activities - `Optional otherNonCashItems` Other non-cash items - `Optional otherWorkingCapital` Change in other working capital - `Optional preferredDividendsPaid` Preferred dividends paid - `Optional purchasesOfInvestments` Purchases of investments - `Optional salesMaturitiesOfInvestments` Sales and maturities of investments - `Optional shortTermNetDebtIssuance` Short-term net debt issuance - `Optional stockBasedCompensation` Stock-based compensation expense ### Instrument Dividend Event - `class InstrumentDividendEvent:` Represents a dividend event for an instrument - `String adjustedDividendAmount` The adjusted dividend amount accounting for any splits. - `LocalDate exDate` The day the stock starts trading without the right to receive that dividend. - `Optional declarationDate` The declaration date of the dividend - `Optional dividendAmount` The dividend amount per share. - `Optional dividendYield` The dividend yield as a percentage of the stock price. - `Optional frequency` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `Optional paymentDate` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `Optional recordDate` The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. ### Instrument Earnings - `class InstrumentEarnings:` Represents instrument earnings data - `LocalDate date` The date when the earnings report was published - `Optional epsActual` The actual earnings per share (EPS) for the period - `Optional epsEstimate` The estimated earnings per share (EPS) for the period - `Optional epsSurprisePercent` The percentage difference between actual and estimated EPS - `Optional revenueActual` The actual total revenue for the period - `Optional revenueEstimate` The estimated total revenue for the period - `Optional revenueSurprisePercent` The percentage difference between actual and estimated revenue ### Instrument Event Envelope - `class InstrumentEventEnvelope:` Unified envelope for the all-events response. - `String symbol` Symbol associated with the event. - `AllEventsEventType type` Event type discriminator. - `EARNINGS("EARNINGS")` - `DIVIDEND("DIVIDEND")` - `STOCK_SPLIT("STOCK_SPLIT")` - `IPO("IPO")` - `Optional dividendEventData` Dividend payload when type is DIVIDEND. - `String adjustedDividendAmount` The adjusted dividend amount accounting for any splits. - `LocalDate exDate` The day the stock starts trading without the right to receive that dividend. - `Optional declarationDate` The declaration date of the dividend - `Optional dividendAmount` The dividend amount per share. - `Optional dividendYield` The dividend yield as a percentage of the stock price. - `Optional frequency` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `Optional paymentDate` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `Optional recordDate` The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. - `Optional earningsEventData` Earnings payload when type is EARNINGS. - `LocalDate date` The date when the earnings report was published - `Optional epsActual` The actual earnings per share (EPS) for the period - `Optional epsEstimate` The estimated earnings per share (EPS) for the period - `Optional epsSurprisePercent` The percentage difference between actual and estimated EPS - `Optional revenueActual` The actual total revenue for the period - `Optional revenueEstimate` The estimated total revenue for the period - `Optional revenueSurprisePercent` The percentage difference between actual and estimated revenue - `Optional instrumentId` OEMS instrument identifier, when the instrument is found in the instrument cache. - `Optional ipoEventData` IPO payload when type is IPO. - `Optional actions` IPO action. - `Optional announcedAt` IPO announced timestamp. - `Optional company` IPO company name. - `Optional exchange` IPO exchange. - `Optional marketCap` IPO market cap. - `Optional priceRange` IPO price range. - `Optional shares` IPO shares offered. - `Optional name` Instrument name associated with the event, when available. - `Optional reportingCurrency` The currency used for reporting financial data. - `Optional stockSplitEventData` Stock split payload when type is STOCK_SPLIT. - `LocalDate date` The date of the stock split - `String denominator` The denominator of the split ratio - `String numerator` The numerator of the split ratio - `String splitType` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") ### Instrument Event Ipo Item - `class InstrumentEventIpoItem:` IPO event in the all-events date grouping response. - `Optional actions` IPO action. - `Optional announcedAt` IPO announced timestamp. - `Optional company` IPO company name. - `Optional exchange` IPO exchange. - `Optional marketCap` IPO market cap. - `Optional priceRange` IPO price range. - `Optional shares` IPO shares offered. ### Instrument Events By Date - `class InstrumentEventsByDate:` Instrument events for a single date. - `LocalDate date` Event date. - `List events` Flat event envelopes for this date. - `String symbol` Symbol associated with the event. - `AllEventsEventType type` Event type discriminator. - `EARNINGS("EARNINGS")` - `DIVIDEND("DIVIDEND")` - `STOCK_SPLIT("STOCK_SPLIT")` - `IPO("IPO")` - `Optional dividendEventData` Dividend payload when type is DIVIDEND. - `String adjustedDividendAmount` The adjusted dividend amount accounting for any splits. - `LocalDate exDate` The day the stock starts trading without the right to receive that dividend. - `Optional declarationDate` The declaration date of the dividend - `Optional dividendAmount` The dividend amount per share. - `Optional dividendYield` The dividend yield as a percentage of the stock price. - `Optional frequency` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `Optional paymentDate` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `Optional recordDate` The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. - `Optional earningsEventData` Earnings payload when type is EARNINGS. - `LocalDate date` The date when the earnings report was published - `Optional epsActual` The actual earnings per share (EPS) for the period - `Optional epsEstimate` The estimated earnings per share (EPS) for the period - `Optional epsSurprisePercent` The percentage difference between actual and estimated EPS - `Optional revenueActual` The actual total revenue for the period - `Optional revenueEstimate` The estimated total revenue for the period - `Optional revenueSurprisePercent` The percentage difference between actual and estimated revenue - `Optional instrumentId` OEMS instrument identifier, when the instrument is found in the instrument cache. - `Optional ipoEventData` IPO payload when type is IPO. - `Optional actions` IPO action. - `Optional announcedAt` IPO announced timestamp. - `Optional company` IPO company name. - `Optional exchange` IPO exchange. - `Optional marketCap` IPO market cap. - `Optional priceRange` IPO price range. - `Optional shares` IPO shares offered. - `Optional name` Instrument name associated with the event, when available. - `Optional reportingCurrency` The currency used for reporting financial data. - `Optional stockSplitEventData` Stock split payload when type is STOCK_SPLIT. - `LocalDate date` The date of the stock split - `String denominator` The denominator of the split ratio - `String numerator` The numerator of the split ratio - `String splitType` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") ### Instrument Events Data - `class InstrumentEventsData:` Grouped instrument events by type - `List dividends` Dividend distribution events - `String adjustedDividendAmount` The adjusted dividend amount accounting for any splits. - `LocalDate exDate` The day the stock starts trading without the right to receive that dividend. - `Optional declarationDate` The declaration date of the dividend - `Optional dividendAmount` The dividend amount per share. - `Optional dividendYield` The dividend yield as a percentage of the stock price. - `Optional frequency` The frequency of the dividend payments (e.g., "Quarterly", "Annual"). - `Optional paymentDate` The payment date is the date on which a declared stock dividend is scheduled to be paid. - `Optional recordDate` The record date, set by a company's board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend. - `List earnings` Earnings announcement events - `LocalDate date` The date when the earnings report was published - `Optional epsActual` The actual earnings per share (EPS) for the period - `Optional epsEstimate` The estimated earnings per share (EPS) for the period - `Optional epsSurprisePercent` The percentage difference between actual and estimated EPS - `Optional revenueActual` The actual total revenue for the period - `Optional revenueEstimate` The estimated total revenue for the period - `Optional revenueSurprisePercent` The percentage difference between actual and estimated revenue - `String instrumentId` OEMS instrument UUID from the request - `List splits` Stock split events - `LocalDate date` The date of the stock split - `String denominator` The denominator of the split ratio - `String numerator` The numerator of the split ratio - `String splitType` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") - `Optional reportingCurrency` The currency used for reporting financial data ### Instrument Fundamentals - `class InstrumentFundamentals:` Supplemental fundamentals and company profile data for an instrument. - `Optional averageVolume` The average daily trading volume over the past 30 days - `Optional beta` The beta value, measuring the instrument's volatility relative to the overall market - `Optional description` A detailed description of the instrument or company - `Optional dividendYield` The trailing twelve months (TTM) dividend yield - `Optional earningsPerShare` The trailing twelve months (TTM) earnings per share - `Optional fiftyTwoWeekHigh` The highest price over the last 52 weeks - `Optional fiftyTwoWeekLow` The lowest price over the last 52 weeks - `Optional industry` The specific industry of the instrument's issuer - `Optional listDate` The date the instrument was first listed - `Optional logoUrl` URL to a representative logo image for the instrument or issuer - `Optional marketCap` The total market capitalization - `Optional previousClose` The closing price from the previous trading day - `Optional priceToEarnings` The price-to-earnings (P/E) ratio for the trailing twelve months (TTM) - `Optional reportingCurrency` The currency used for reporting financial data - `Optional sector` The business sector of the instrument's issuer ### Instrument Income Statement - `class InstrumentIncomeStatement:` A quarterly income statement for an instrument. - `LocalDateTime acceptedDate` The date and time when the filing was accepted by the SEC - `LocalDate filingDate` The date the financial statement was filed - `String period` The fiscal period identifier (e.g., "Q1", "Q2", "Q3", "Q4") - `FiscalPeriodType periodType` The type of fiscal period - `QUARTERLY("QUARTERLY")` - `ANNUAL("ANNUAL")` - `TTM("TTM")` - `BIANNUAL("BIANNUAL")` - `String reportedCurrency` The currency in which the statement is reported (ISO 4217) - `long year` The fiscal year of the statement - `Optional bottomLineNetIncome` Bottom line net income after all adjustments - `Optional costAndExpenses` Total costs and expenses - `Optional costOfRevenue` Direct costs attributable to producing goods sold - `Optional depreciationAndAmortization` Depreciation and amortization expenses - `Optional ebit` Earnings before interest and taxes - `Optional ebitda` Earnings before interest, taxes, depreciation, and amortization - `Optional eps` Basic earnings per share - `Optional epsDiluted` Diluted earnings per share - `Optional generalAndAdministrativeExpenses` General administrative overhead expenses - `Optional grossProfit` Revenue minus cost of revenue - `Optional incomeBeforeTax` Income before income tax expense - `Optional incomeTaxExpense` Income tax expense for the period - `Optional interestExpense` Interest paid on debt - `Optional interestIncome` Interest earned on investments and cash - `Optional netIncome` Total net income for the period - `Optional netIncomeDeductions` Deductions from net income - `Optional netIncomeFromContinuingOperations` Net income from continuing operations - `Optional netIncomeFromDiscontinuedOperations` Net income from discontinued operations - `Optional netInterestIncome` Net interest income (interest income minus interest expense) - `Optional nonOperatingIncomeExcludingInterest` Non-operating income excluding interest - `Optional operatingExpenses` Total operating expenses - `Optional operatingIncome` Income from core business operations - `Optional otherAdjustmentsToNetIncome` Other adjustments to net income - `Optional otherExpenses` Other miscellaneous expenses - `Optional researchAndDevelopmentExpenses` Expenditure on research and development activities - `Optional revenue` Total revenue from sales of goods and services - `Optional sellingAndMarketingExpenses` Expenditure on marketing and sales activities - `Optional sellingGeneralAndAdministrativeExpenses` Combined selling, general, and administrative expenses - `Optional totalOtherIncomeExpensesNet` Net of other income and expenses - `Optional weightedAverageShsOut` Weighted average shares outstanding (basic) - `Optional weightedAverageShsOutDil` Weighted average shares outstanding (diluted) ### Instrument Split Event - `class InstrumentSplitEvent:` Represents a stock split event for an instrument - `LocalDate date` The date of the stock split - `String denominator` The denominator of the split ratio - `String numerator` The numerator of the split ratio - `String splitType` The type of stock split (e.g., "stock-split", "stock-dividend", "bonus-issue") ### Price Target - `class PriceTarget:` Analyst price target statistics - `String average` Average analyst price target - `String currency` ISO 4217 currency code of the price targets - `String high` Highest analyst price target - `String low` Lowest analyst price target # Market Data ## Get Snapshots `MarketDataGetSnapshotsResponse v1().instrumentData().marketData().getSnapshots(MarketDataGetSnapshotsParamsparams = MarketDataGetSnapshotsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **get** `/v1/market-data/snapshot` Get market data snapshots for one or more securities. ### Parameters - `MarketDataGetSnapshotsParams params` - `Optional> instrumentIds` Comma-separated OEMS instrument UUIDs. ### Returns - `class MarketDataGetSnapshotsResponse:` - `List data` - `String instrumentId` OEMS instrument identifier. - `String symbol` Display symbol for the security. - `Optional cumulativeVolume` Cumulative traded volume reported on the most recent trade, in shares for equities or contracts for options. Absent when no trade is available. - `Optional lastQuote` Most recent quote if available. - `String ask` Current best ask. - `String bid` Current best bid. - `String midpoint` Midpoint of bid and ask. - `Optional askSize` Size at the best ask, in shares. - `Optional bidSize` Size at the best bid, in shares. - `Optional lastTrade` Most recent last-sale trade if available. - `String price` Most recent last-sale eligible trade price. - `Optional name` Security name if available. - `Optional session` Session metrics computed from previous close and last trade, if available. - `String change` Absolute change from previous close to last trade. - `String changePercent` Percent change from previous close to last trade. - `String previousClose` Previous session close price. ### Example ```java package com.clear_street.api.example; import com.clear_street.api.client.ClearStreetClient; import com.clear_street.api.client.okhttp.ClearStreetOkHttpClient; import com.clear_street.api.models.v1.instrumentdata.marketdata.MarketDataGetSnapshotsParams; import com.clear_street.api.models.v1.instrumentdata.marketdata.MarketDataGetSnapshotsResponse; public final class Main { private Main() {} public static void main(String[] args) { ClearStreetClient client = ClearStreetOkHttpClient.builder() .fromEnv() .apiKey("My API Key") .build(); MarketDataGetSnapshotsResponse response = client.v1().instrumentData().marketData().getSnapshots(); } } ``` #### 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 `MarketDataGetDailySummariesResponse v1().instrumentData().marketData().getDailySummaries(MarketDataGetDailySummariesParamsparams, RequestOptionsrequestOptions = RequestOptions.none())` **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 - `MarketDataGetDailySummariesParams params` - `String instrumentIds` Comma-separated OEMS instrument UUIDs (required, 1..=100) ### Returns - `class MarketDataGetDailySummariesResponse:` - `List data` - `String instrumentId` OEMS instrument identifier. Always populated; echoes the request ID. - `Optional high` Session high. - `Optional low` Session low. - `Optional open` Opening price for the session. - `Optional symbol` Display symbol for the security. `None` for unresolvable IDs. - `Optional tradeDate` Session date the OHLV represents, US/Eastern. - `Optional volume` Session cumulative trading volume. ### Example ```java package com.clear_street.api.example; import com.clear_street.api.client.ClearStreetClient; import com.clear_street.api.client.okhttp.ClearStreetOkHttpClient; import com.clear_street.api.models.v1.instrumentdata.marketdata.MarketDataGetDailySummariesParams; import com.clear_street.api.models.v1.instrumentdata.marketdata.MarketDataGetDailySummariesResponse; public final class Main { private Main() {} public static void main(String[] args) { ClearStreetClient client = ClearStreetOkHttpClient.builder() .fromEnv() .apiKey("My API Key") .build(); MarketDataGetDailySummariesParams params = MarketDataGetDailySummariesParams.builder() .instrumentIds("instrument_ids") .build(); MarketDataGetDailySummariesResponse response = client.v1().instrumentData().marketData().getDailySummaries(params); } } ``` #### 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). - `String instrumentId` OEMS instrument identifier. Always populated; echoes the request ID. - `Optional high` Session high. - `Optional low` Session low. - `Optional open` Opening price for the session. - `Optional symbol` Display symbol for the security. `None` for unresolvable IDs. - `Optional tradeDate` Session date the OHLV represents, US/Eastern. - `Optional volume` Session cumulative trading volume. ### Market Data Snapshot - `class MarketDataSnapshot:` Market data snapshot for a single security. - `String instrumentId` OEMS instrument identifier. - `String symbol` Display symbol for the security. - `Optional cumulativeVolume` Cumulative traded volume reported on the most recent trade, in shares for equities or contracts for options. Absent when no trade is available. - `Optional lastQuote` Most recent quote if available. - `String ask` Current best ask. - `String bid` Current best bid. - `String midpoint` Midpoint of bid and ask. - `Optional askSize` Size at the best ask, in shares. - `Optional bidSize` Size at the best bid, in shares. - `Optional lastTrade` Most recent last-sale trade if available. - `String price` Most recent last-sale eligible trade price. - `Optional name` Security name if available. - `Optional session` Session metrics computed from previous close and last trade, if available. - `String change` Absolute change from previous close to last trade. - `String changePercent` Percent change from previous close to last trade. - `String previousClose` Previous session close price. ### Snapshot Last Trade - `class SnapshotLastTrade:` Last-trade fields for a market data snapshot. - `String price` Most recent last-sale eligible trade price. ### Snapshot Quote - `class SnapshotQuote:` L1 quote fields for a market data snapshot. - `String ask` Current best ask. - `String bid` Current best bid. - `String midpoint` Midpoint of bid and ask. - `Optional askSize` Size at the best ask, in shares. - `Optional bidSize` Size at the best bid, in shares. ### Snapshot Session - `class SnapshotSession:` Session-level pricing metrics for a market data snapshot. - `String change` Absolute change from previous close to last trade. - `String changePercent` Percent change from previous close to last trade. - `String previousClose` Previous session close price. # News ## Get News `NewsGetNewsResponse v1().instrumentData().news().getNews(NewsGetNewsParamsparams = NewsGetNewsParams.none(), RequestOptionsrequestOptions = RequestOptions.none())` **get** `/v1/news` Retrieves news items with optional filtering by security IDs, time range, publisher, type, and text query. ### Parameters - `NewsGetNewsParams params` - `Optional excludePublishers` Comma-separated list of publishers to exclude (mutually exclusive with include_publishers). - `Optional from` Inclusive start timestamp. Accepts `YYYY-MM-DD` or RFC3339 datetime. - `Optional includePublishers` Comma-separated list of publishers to include (mutually exclusive with exclude_publishers). - `Optional> instrumentIds` Comma-delimited OEMS instrument UUIDs to filter by. - `Optional newsType` Filter by news type. - `NEWS("NEWS")` - `PRESS_RELEASE("PRESS_RELEASE")` - `Optional pageSize` The number of items to return per page. Only used when page_token is not provided. - `Optional pageToken` Token for retrieving the next or previous page of results. Contains encoded pagination state; when provided, page_size is ignored. - `Optional searchQuery` Free-text query matched against title/text and associated security IDs. - `Optional> sectors` Comma-separated sector values to filter by. - `BASIC_MATERIALS("BASIC_MATERIALS")` - `COMMUNICATION_SERVICES("COMMUNICATION_SERVICES")` - `CONSUMER_CYCLICAL("CONSUMER_CYCLICAL")` - `CONSUMER_DEFENSIVE("CONSUMER_DEFENSIVE")` - `ENERGY("ENERGY")` - `FINANCIAL_SERVICES("FINANCIAL_SERVICES")` - `HEALTHCARE("HEALTHCARE")` - `INDUSTRIALS("INDUSTRIALS")` - `REAL_ESTATE("REAL_ESTATE")` - `TECHNOLOGY("TECHNOLOGY")` - `UTILITIES("UTILITIES")` - `Optional to` Inclusive end timestamp. Accepts `YYYY-MM-DD` or RFC3339 datetime. ### Returns - `class NewsGetNewsResponse:` - `List data` - `List instruments` Instruments associated with this news item. - `String instrumentId` OEMS instrument UUID. - `Optional name` Instrument name/description, if available from instrument cache enrichment. - `Optional symbol` Trading symbol, if available from instrument cache enrichment. - `NewsType newsType` Classification of the item. - `NEWS("NEWS")` - `PRESS_RELEASE("PRESS_RELEASE")` - `LocalDateTime publishedAt` The published date/time of the article in UTC. - `String publisher` The publisher or newswire source. - `String title` The headline/title of the article. - `String url` Canonical URL to the full article. - `Optional imageUrl` URL of an associated image if provided by the source. - `Optional site` The primary domain/site of the publisher. - `Optional text` The full or excerpted article body. ### Example ```java package com.clear_street.api.example; import com.clear_street.api.client.ClearStreetClient; import com.clear_street.api.client.okhttp.ClearStreetOkHttpClient; import com.clear_street.api.models.v1.instrumentdata.news.NewsGetNewsParams; import com.clear_street.api.models.v1.instrumentdata.news.NewsGetNewsResponse; public final class Main { private Main() {} public static void main(String[] args) { ClearStreetClient client = ClearStreetOkHttpClient.builder() .fromEnv() .apiKey("My API Key") .build(); NewsGetNewsResponse response = client.v1().instrumentData().news().getNews(); } } ``` #### 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. - `String instrumentId` OEMS instrument UUID. - `Optional name` Instrument name/description, if available from instrument cache enrichment. - `Optional symbol` Trading symbol, if available from instrument cache enrichment. ### News Item - `class NewsItem:` A single news item and its associated instruments. - `List instruments` Instruments associated with this news item. - `String instrumentId` OEMS instrument UUID. - `Optional name` Instrument name/description, if available from instrument cache enrichment. - `Optional symbol` Trading symbol, if available from instrument cache enrichment. - `NewsType newsType` Classification of the item. - `NEWS("NEWS")` - `PRESS_RELEASE("PRESS_RELEASE")` - `LocalDateTime publishedAt` The published date/time of the article in UTC. - `String publisher` The publisher or newswire source. - `String title` The headline/title of the article. - `String url` Canonical URL to the full article. - `Optional imageUrl` URL of an associated image if provided by the source. - `Optional site` The primary domain/site of the publisher. - `Optional text` The full or excerpted article body. ### News Type - `enum NewsType:` News item classification. - `NEWS("NEWS")` - `PRESS_RELEASE("PRESS_RELEASE")`