Skip to content
Get started

Get All Instrument Events

client.V1.InstrumentData.GetAllInstrumentEvents(ctx, query) (*V1InstrumentDataGetAllInstrumentEventsResponse, error)
GET/v1/instruments/events

List instrument events across all securities.

Retrieves all instrument events grouped by date.

ParametersExpand Collapse
query V1InstrumentDataGetAllInstrumentEventsParams
EventTypes param.Field[[]AllEventsEventType]Optional

Filter by event type(s). Comma-delimited list. Example: event_types=EARNINGS,IPO.

const AllEventsEventTypeEarnings AllEventsEventType = "EARNINGS"
const AllEventsEventTypeDividend AllEventsEventType = "DIVIDEND"
const AllEventsEventTypeStockSplit AllEventsEventType = "STOCK_SPLIT"
const AllEventsEventTypeIpo AllEventsEventType = "IPO"
FromDate param.Field[string]Optional

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

InstrumentIDs param.Field[[]string]Optional

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

ToDate param.Field[string]Optional

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

ReturnsExpand Collapse
type V1InstrumentDataGetAllInstrumentEventsResponse struct{…}

All-events payload grouped by date.

Events grouped by date in descending order.

Date Time

Event date.

formatdate

Flat event envelopes for this date.

Symbol string

Symbol associated with the event.

Event type discriminator.

One of the following:
const AllEventsEventTypeEarnings AllEventsEventType = "EARNINGS"
const AllEventsEventTypeDividend AllEventsEventType = "DIVIDEND"
const AllEventsEventTypeStockSplit AllEventsEventType = "STOCK_SPLIT"
const AllEventsEventTypeIpo AllEventsEventType = "IPO"
DividendEventData InstrumentDividendEventOptional

Dividend payload when type is DIVIDEND.

AdjustedDividendAmount string

The adjusted dividend amount accounting for any splits.

ExDate Time

The day the stock starts trading without the right to receive that dividend.

formatdate
DeclarationDate TimeOptional

The declaration date of the dividend

formatdate
DividendAmount stringOptional

The dividend amount per share.

DividendYield stringOptional

The dividend yield as a percentage of the stock price.

Frequency stringOptional

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

PaymentDate TimeOptional

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

formatdate
RecordDate TimeOptional

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
EarningsEventData InstrumentEarningsOptional

Earnings payload when type is EARNINGS.

Date Time

The date when the earnings report was published

formatdate
EpsActual stringOptional

The actual earnings per share (EPS) for the period

EpsEstimate stringOptional

The estimated earnings per share (EPS) for the period

EpsSurprisePercent stringOptional

The percentage difference between actual and estimated EPS

RevenueActual stringOptional

The actual total revenue for the period

RevenueEstimate stringOptional

The estimated total revenue for the period

RevenueSurprisePercent stringOptional

The percentage difference between actual and estimated revenue

InstrumentID stringOptional

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

formatuuid
IpoEventData InstrumentEventIpoItemOptional

IPO payload when type is IPO.

Actions stringOptional

IPO action.

AnnouncedAt TimeOptional

IPO announced timestamp.

formatdate-time
Company stringOptional

IPO company name.

Exchange stringOptional

IPO exchange.

MarketCap stringOptional

IPO market cap.

PriceRange stringOptional

IPO price range.

Shares stringOptional

IPO shares offered.

Name stringOptional

Instrument name associated with the event, when available.

ReportingCurrency stringOptional

The currency used for reporting financial data.

StockSplitEventData InstrumentSplitEventOptional

Stock split payload when type is STOCK_SPLIT.

Date Time

The date of the stock split

formatdate
Denominator string

The denominator of the split ratio

Numerator string

The numerator of the split ratio

SplitType string

The type of stock split (e.g., “stock-split”, “stock-dividend”, “bonus-issue”)

Get All Instrument Events

package main

import (
  "context"
  "fmt"

  "github.com/clear-street/clear-street-go"
  "github.com/clear-street/clear-street-go/option"
)

func main() {
  client := clearstreet.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.V1.InstrumentData.GetAllInstrumentEvents(context.TODO(), clearstreet.V1InstrumentDataGetAllInstrumentEventsParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response)
}
{
  "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"
  }
}