---
title: "Hourly open interest history"
method: GET
path: "/api/markets/open-interest/{slug}"
tags: ["Crypto"]
---

# Hourly open interest history

`GET /api/markets/open-interest/{slug}`

## Request

- Base URL: `https://xoomar.com`
- URL: `https://xoomar.com/api/markets/open-interest/{slug}`
- Auth: one of:
  - none
  - API key in header `x-api-key`

Open interest history per symbol from Binance, hourly or daily; history starts in 2021 and the free API returns the last six months. Live open interest per venue is in /api/markets/funding-rates. Docs: https://xoomar.com/markets/api/open-interest

## Path parameters

- `slug` string, required

## Query parameters

- `from` string
- `to` string
- `period` '1h' | '1d'
- `limit` integer

## Response `200`

OK

- object
  - `data` object[]
    - `exchange` string: binance (hourly history)
    - `ts` string: Observation hour (ISO timestamp)
    - `openInterest` string, nullable: Open interest in contracts
    - `openInterestValue` string, nullable: Open interest notional in USD
    - `longShortRatio` string, nullable: Global long/short account ratio where available
    - `topTraderRatio` string, nullable: Top trader long/short positions ratio where available
    - `canonicalUrl` string, uri: The matching page on xoomar.com
  - `updatedAt` string, date-time: When the response was built; a few dated feeds give the date of their newest row instead
  - `source` 'xoomar.com'
  - `docs` string
  - `license` string: Data terms
  - `attribution` string
  - `canonicalUrl` string, uri: The matching page on xoomar.com
  - `meta` object: Who publishes the data and how to credit it
    - `source` string: The publisher or publishers of the data, comma-separated
    - `sourceAttribution` string: The credit line to show wherever the data is displayed
    - `notice` string: Requests without a key only: the free key, app registration and the credit

## Other responses

- `404`: Unknown slug, ticker or country
- `429`: Rate limit: 10 requests a minute without a key, 30 with a free key

---

[API](https://skmtc.dev/xoomar/apis/xoomar-market-data-api.md) · [All operations](https://skmtc.dev/xoomar/apis/xoomar-market-data-api/llms.txt) · [OpenAPI document](https://skmtc.dev/xoomar/apis/xoomar-market-data-api/revisions/07b78401eaaa?raw)