## 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" } } ```