Skip to content
Clear Street Clear Street
Get started
API Reference
V1
Instrument Data

Get Instrument Events

v1.instrument_data.get_instrument_events(InstrumentIDOrSymbolinstrument_id, InstrumentDataGetInstrumentEventsParams**kwargs) -> InstrumentDataGetInstrumentEventsResponse
GET/v1/instruments/{instrument_id}/events

Retrieves corporate events (dividends, splits, etc.) for an instrument, grouped by event type.

Date range defaults:

  • from_date: today - 365 days
  • to_date: today + 60 days
ParametersExpand Collapse
instrument_id: InstrumentIDOrSymbol

OEMS instrument UUID

formatuuid
from_date: Optional[str]

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

to_date: Optional[str]

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

ReturnsExpand Collapse
class InstrumentDataGetInstrumentEventsResponse: …

Grouped instrument events by type

dividends: List[InstrumentDividendEvent]

Dividend distribution events

adjusted_dividend_amount: str

The adjusted dividend amount accounting for any splits.

ex_date: date

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

formatdate
declaration_date: Optional[date]

The declaration date of the dividend

formatdate
dividend_amount: Optional[str]

The dividend amount per share.

dividend_yield: Optional[str]

The dividend yield as a percentage of the stock price.

frequency: Optional[str]

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

payment_date: Optional[date]

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

formatdate
record_date: Optional[date]

The record date, set by a company’s board of directors, is when a company compiles a list of shareholders of the stock for which it has declared a dividend.

formatdate
earnings: List[InstrumentEarnings]

Earnings announcement events

date: date

The date when the earnings report was published

formatdate
eps_actual: Optional[str]

The actual earnings per share (EPS) for the period

eps_estimate: Optional[str]

The estimated earnings per share (EPS) for the period

eps_surprise_percent: Optional[str]

The percentage difference between actual and estimated EPS

revenue_actual: Optional[str]

The actual total revenue for the period

revenue_estimate: Optional[str]

The estimated total revenue for the period

revenue_surprise_percent: Optional[str]

The percentage difference between actual and estimated revenue

instrument_id: str

OEMS instrument UUID from the request

formatuuid
splits: List[InstrumentSplitEvent]

Stock split events

date: date

The date of the stock split

formatdate
denominator: str

The denominator of the split ratio

numerator: str

The numerator of the split ratio

split_type: str

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

reporting_currency: Optional[str]

The currency used for reporting financial data

Get Instrument Events

from clear_street import ClearStreet

client = ClearStreet(
    api_key="My API Key",
)
response = client.v1.instrument_data.get_instrument_events(
    instrument_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(response)
{
  "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"
  }
}
{
  "error": {
    "code": 404,
    "message": "Instrument not found: AAP"
  },
  "metadata": {
    "request_id": "fa8cc9b2-fbf0-4f5b-8ce3-b3205b9f85f2"
  }
}
Returns Examples
{
  "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"
  }
}
{
  "error": {
    "code": 404,
    "message": "Instrument not found: AAP"
  },
  "metadata": {
    "request_id": "fa8cc9b2-fbf0-4f5b-8ce3-b3205b9f85f2"
  }
}