Skip to content

Query Total Open Interest

Endpoint: /v1/futures/open_interest

Request Parameters

Required

Method: GET

Example

Bash
curl -X GET "https://oapi.websea.com/v1/futures/open_interest?symbol=BTC-USDT"

Query Parameters

Parameter Required Type Example Description
symbol Yes string BTC-USDT Trading pair. If omitted, data for all trading pairs will be returned

Response Parameters

Parameter Required Type Example Description
errno Yes int 0 Status code
errmsg Yes string success Status message
result Yes object See example Result data

Result Fields

Parameter Required Type Example Description
symbol Yes string BTC-USDT Trading pair
volume Yes int 123 Open interest (number of contracts)
base_ccy Yes string 100.110 Base currency amount
quote_ccy Yes string 12300 Quote currency amount
ts Yes long 1587925500000 Timestamp

Response Example

JSON
{
  "errno": 0,
  "errmsg": "success",
  "result": {
    "symbol": "BTC-USDT",
    "volume": 123,
    "base_ccy": "100.110",
    "quote_ccy": "12300",
    "ts": 1587925500000
  }
}