Instrument Data
Get Instrument 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
get/v1/instruments/{instrument_id}/events
Path parameters
Instrument ID (UUID) or symbol (equity ticker or OSI option symbol).
Query parameters
from_datestring
The start date for the query range, inclusive (YYYY-MM-DD).
to_datestring
The end date for the query range, inclusive (YYYY-MM-DD).
Response
Instrument events grouped by type
Example response
{
"error": {
"code": 400,
"message": "Order quantity must be greater than zero"
},
"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",
"splits": [
{
"date": "2020-08-31",
"denominator": "1",
"numerator": "4",
"split_type": "stock-split"
}
]
}
}