## Get Instrument Events

`client.V1.InstrumentData.GetInstrumentEvents(ctx, instrumentID, query) (*V1InstrumentDataGetInstrumentEventsResponse, error)`

**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

### Parameters

- `InstrumentID InstrumentIDOrSymbol`

  OEMS instrument UUID

- `query V1InstrumentDataGetInstrumentEventsParams`

  - `FromDate param.Field[string]`

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

  - `ToDate param.Field[string]`

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

### Returns

- `type V1InstrumentDataGetInstrumentEventsResponse struct{…}`

  - `Data InstrumentEventsData`

    Grouped instrument events by type

    - `Dividends []InstrumentDividendEvent`

      Dividend distribution events

      - `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.

      - `DeclarationDate Time`

        The declaration date of the dividend

      - `DividendAmount string`

        The dividend amount per share.

      - `DividendYield string`

        The dividend yield as a percentage of the stock price.

      - `Frequency string`

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

      - `PaymentDate Time`

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

      - `RecordDate Time`

        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.

    - `Earnings []InstrumentEarnings`

      Earnings announcement events

      - `Date Time`

        The date when the earnings report was published

      - `EpsActual string`

        The actual earnings per share (EPS) for the period

      - `EpsEstimate string`

        The estimated earnings per share (EPS) for the period

      - `EpsSurprisePercent string`

        The percentage difference between actual and estimated EPS

      - `RevenueActual string`

        The actual total revenue for the period

      - `RevenueEstimate string`

        The estimated total revenue for the period

      - `RevenueSurprisePercent string`

        The percentage difference between actual and estimated revenue

    - `InstrumentID string`

      OEMS instrument UUID from the request

    - `Splits []InstrumentSplitEvent`

      Stock split events

      - `Date Time`

        The date of the stock split

      - `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")

    - `ReportingCurrency string`

      The currency used for reporting financial data

### Example

```go
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.GetInstrumentEvents(
    context.TODO(),
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    clearstreet.V1InstrumentDataGetInstrumentEventsParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response)
}
```

#### Response

```json
{
  "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"
  }
}
```