Skip to content
Get started

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.

ParametersExpand Collapse
InstrumentDataGetAllInstrumentEventsParams params
Optional<List<AllEventsEventType>> 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<String> fromDate

The start date for the query range, inclusive (YYYY-MM-DD).

Optional<List<String>> instrumentIds

Filter by OEMS instrument ID(s). Comma-delimited list of UUIDs. Example: instrument_ids=550e8400-e29b-41d4-a716-446655440000.

Optional<String> toDate

The end date for the query range, inclusive (YYYY-MM-DD).

ReturnsExpand Collapse
class InstrumentDataGetAllInstrumentEventsResponse:

All-events payload grouped by date.

List<InstrumentEventsByDate> eventDates

Events grouped by date in descending order.

LocalDate date

Event date.

formatdate

Flat event envelopes for this date.

String symbol

Symbol associated with the event.

Event type discriminator.

One of the following:
EARNINGS("EARNINGS")
DIVIDEND("DIVIDEND")
STOCK_SPLIT("STOCK_SPLIT")
IPO("IPO")
Optional<InstrumentDividendEvent> 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.

formatdate
Optional<LocalDate> declarationDate

The declaration date of the dividend

formatdate
Optional<String> dividendAmount

The dividend amount per share.

Optional<String> dividendYield

The dividend yield as a percentage of the stock price.

Optional<String> frequency

The frequency of the dividend payments (e.g., “Quarterly”, “Annual”).

Optional<LocalDate> paymentDate

The payment date is the date on which a declared stock dividend is scheduled to be paid.

formatdate
Optional<LocalDate> 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.

formatdate
Optional<InstrumentEarnings> earningsEventData

Earnings payload when type is EARNINGS.

LocalDate date

The date when the earnings report was published

formatdate
Optional<String> epsActual

The actual earnings per share (EPS) for the period

Optional<String> epsEstimate

The estimated earnings per share (EPS) for the period

Optional<String> epsSurprisePercent

The percentage difference between actual and estimated EPS

Optional<String> revenueActual

The actual total revenue for the period

Optional<String> revenueEstimate

The estimated total revenue for the period

Optional<String> revenueSurprisePercent

The percentage difference between actual and estimated revenue

Optional<String> instrumentId

OEMS instrument identifier, when the instrument is found in the instrument cache.

formatuuid
Optional<InstrumentEventIpoItem> ipoEventData

IPO payload when type is IPO.

Optional<String> actions

IPO action.

Optional<LocalDateTime> announcedAt

IPO announced timestamp.

formatdate-time
Optional<String> company

IPO company name.

Optional<String> exchange

IPO exchange.

Optional<String> marketCap

IPO market cap.

Optional<String> priceRange

IPO price range.

Optional<String> shares

IPO shares offered.

Optional<String> name

Instrument name associated with the event, when available.

Optional<String> reportingCurrency

The currency used for reporting financial data.

Optional<InstrumentSplitEvent> stockSplitEventData

Stock split payload when type is STOCK_SPLIT.

LocalDate date

The date of the stock split

formatdate
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”)

Get All Instrument Events

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();
    }
}
{
  "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"
  }
}
{
  "error": {
    "code": 400,
    "message": "Failed to deserialize query string. Error: premature end of input"
  },
  "metadata": {
    "request_id": "e0a9bd3a-8510-41a7-8144-c51a27787b9c"
  }
}
Returns Examples
{
  "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"
  }
}
{
  "error": {
    "code": 400,
    "message": "Failed to deserialize query string. Error: premature end of input"
  },
  "metadata": {
    "request_id": "e0a9bd3a-8510-41a7-8144-c51a27787b9c"
  }
}