Get Open Interest

Get the open interest of each symbol.

Covers: USDT perpetual / USDC contract / Inverse contract

info

• The upper limit time you can query is the launch time of the symbol.

HTTP Request

GET /v5/market/open-interest

Request Parameters

Parameter	Required	Type	Comments
category	true	string	Product type. linear,inverse
symbol	true	string	Symbol name, like BTCUSDT, uppercase only
intervalTime	true	string	Interval time. 5min,15min,30min,1h,4h,1d
startTime	false	integer	The start timestamp (ms)
endTime	false	integer	The end timestamp (ms)
limit	false	integer	Limit for data size per page. [1, 200]. Default: 50
cursor	false	string	Cursor. Used to paginate

Response Parameters

Parameter	Type	Comments
category	string	Product type
symbol	string	Symbol name
list	array	Object
> openInterest	string	Open interest. The value is the sum of both sides
> timestamp	string	The timestamp (ms)
nextPageCursor	string	Used to paginate

---

Request Example

HTTP

GET /v5/market/open-interest?category=inverse&symbol=BTCUSD&intervalTime=5min&startTime=1669571100000&endTime=1669571400000 HTTP/1.1
Host: api-testnet.bybit.com

Python

from pybit.unified_trading import HTTP
session = HTTP(testnet=True)
print(session.get_open_interest(
    category="inverse",
    symbol="BTCUSD",
    intervalTime="5min",
    startTime=1669571100000,
    endTime=1669571400000,
))

GO

import (
    "context"
    "fmt"
    bybit "github.com/wuhewuhe/bybit.go.api"
)
client := bybit.NewBybitHttpClient("", "", bybit.WithBaseURL(bybit.TESTNET))
params := map[string]interface{}{"category": "linear", "symbol": "BTCUSDT"}
client.NewUtaBybitServiceWithParams(params).GetOpenInterests(context.Background())

Java

import com.bybit.api.client.domain.CategoryType;
import com.bybit.api.client.domain.market.*;
import com.bybit.api.client.domain.market.request.MarketDataRequest;
import com.bybit.api.client.service.BybitApiClientFactory;
var client = BybitApiClientFactory.newInstance().newAsyncMarketDataRestClient();
var openInterest = MarketDataRequest.builder().category(CategoryType.LINEAR).symbol("BTCUSDT").marketInterval(MarketInterval.FIVE_MINUTES).build();
client.getOpenInterest(openInterest, System.out::println);

Node.js

const { RestClientV5 } = require('bybit-api');

const client = new RestClientV5({
    testnet: true,
});

client
    .getOpenInterest({
        category: 'inverse',
        symbol: 'BTCUSD',
        intervalTime: '5min',
        startTime: 1669571100000,
        endTime: 1669571400000,
    })
    .then((response) => {
        console.log(response);
    })
    .catch((error) => {
        console.error(error);
    });

Response Example

{
    "retCode": 0,
    "retMsg": "OK",
    "result": {
        "symbol": "BTCUSD",
        "category": "inverse",
        "list": [
            {
                "openInterest": "461134384.00000000",
                "timestamp": "1669571400000"
            },
            {
                "openInterest": "461134292.00000000",
                "timestamp": "1669571100000"
            }
        ],
        "nextPageCursor": ""
    },
    "retExtInfo": {},
    "time": 1672053548579
}