Retrieves the historical time series open interest for the specified exchange and instrument(s).
Important Notice: Upcoming Changes to Batch Request Parameters
Starting January 6, 2025, we will be implementing new restrictions on batch requests to optimize performance across our platform. Specifically, batch requests using the
startDateparameter will no longer be allowed to retrieve data older than 60 days. Any requests attempting to access data beyond this limit will result in an error. Please use the Historical endpoint for those needs.Additionally, if the
startDateandendDateparameters are not provided, the API will currently return the previous 12 months of daily data by default. Beginning January 6, 2025, this default behavior will change to return only the previous 60 days of data.We are providing this advance notice to help ensure a smooth transition for all our customers. Please review and update your systems accordingly to avoid any disruptions. If you have any questions or need assistance in preparing for this change, feel free to reach out to our support team.
Thank you for your understanding and cooperation.
Time Range Limit
The maximum time range (difference between startDate and endDate) is 1 year.
Not specifying startDate and endDate
If the
startDateandendDatequery parameters are not provided, the API will return the data from the previous 1 year with a 1 day frequency.
RESPONSE DATA
| JSON Field/Path | Value Type | Description |
|---|---|---|
| payload.metadata.next | string | The URL for the next page of data (nullable if there is no next page). |
| payload.metadata.api-version | string | The version of the API used for this request. |
| payload.data[].instrument | string | The instrument or trading pair for which open interest data is recorded (e.g., BTCUSD_PERP). |
| payload.data[].exchange | string | The name of the exchange where the open interest data applies (e.g., binance). |
| payload.data[].exchangeTimestamp | integer | The timestamp from the exchange when the open interest data was recorded. |
| payload.data[].exchangeTimestampNanoseconds | integer | The nanoseconds part of the timestamp, representing sub-second precision (usually 0). |
| payload.data[].value | integer | The open interest value at the specified timestamp. |
| payload.data[].type | string | The type of the open interest contract (e.g., PERPETUAL). |