General Info
Some endpoints will require an API Key. Please refer to this page.
The basbe endpoinpus: https://open-api.coinglass.com
All endpoints return either a JSON object or array.
HTTP Return Codes
HTTP 4XX return codes are used for for malformed requests; the issue is on the sender's side.HTTP 403 return code is used when the WAF Limit (Web Application Firewall) has been violated.
HTTP 429 return code is used when breaking a request rate limit.HTTP 418 return code is used when an IP has been auto-banned for continuing to send requests after receiving 429 codes.
General parameters
Symbol:
BTC,ETH,EOS,BCH,LTC,XRP,BSV,ETC,TRX,LINK are now supported
Exchange Name:
Bitmex,Binance,Bybit,Okex,Huobi,FTX,Deribit,Kraken,Bitfinex,Phemex are now supported
Api Key
All api require permission validation.you need to add "coinglassSecret" in http request header.
import requests
url = "http://open-api.coinglass.com/api/pro/v1/futures/openInterest?interval={interval}&symbol={symbol}"
params = {}
headers = {
'coinglassSecret': 'apiKey'
}
response = requests.request("GET", url, headers=headers, data = params)
print(response.text.encode('utf8'))
curl --location --request GET 'http://open-api.coinglass.com/' \
--header 'coinglassSecret: apiKey'
FUTURES
Exchange Open Interest
curl --location --request GET 'https://open-api.coinglass.com/api/pro/v1/futures/openInterest?symbol=BTC&interval=0' \
--header 'coinglassSecret: fabe11b61f5a4963a4227f4ac2cbcf2f'
GET https://open-api.coinglass.com/api/pro/v1/futures/openInterest
Query Parameters
Parameter | Default | Description |
---|---|---|
interval | int | (0=ALL, 2=1H ,1=4H 4=12H) |
symbol | string | Symbol |
Exchange Open Interest Chart
curl --location --request GET 'https://open-api.coinglass.com/api/pro/v1/futures/openInterest/chart?symbol=BTC&interval=0' \
--header 'coinglassSecret: fabe11b61f5a4963a4227f4ac2cbcf2f'
GET https://open-api.coinglass.com/api/pro/v1/futures/openInterest/chart
Query Parameters
Parameter | Default | Description |
---|---|---|
interval | int | (0=ALL, 2=1H ,1=4H 4=12H) |
symbol | string | Symbol |
Liquidation
curl --location --request GET 'https://open-api.coinglass.com/api/pro/v1/futures/liquidation_chart?symbol=BTC&exName=Binance' \
--header 'coinglassSecret: fabe11b61f5a4963a4227f4ac2cbcf2f'
GET https://open-api.coinglass.com/api/pro/v1/futures/liquidation_chart
Query Parameters
Parameter | Default | Description |
---|---|---|
exName | string | Exchange Name |
symbol | string | Symbol |
Liquidation Chart
curl --location --request GET 'https://open-api.coinglass.com/api/pro/v1/futures/liquidation/detail/chart?symbol=BTC&timeType=9' \
--header 'coinglassSecret: fabe11b61f5a4963a4227f4ac2cbcf2f'
GET https://open-api.coinglass.com/api/pro/v1/futures/liquidation/detail/chart
Query Parameters
Parameter | Default | Description |
---|---|---|
timeType | int | (1m=9, 5m=3, 15m=10, 30=11, 4h=1, 12h=4, 90d =18) |
symbol | string | Symbol |
Long/Short Chart
curl --location --request GET 'https://open-api.coinglass.com/api/pro/v1/futures/longShort_chart?symbol=BTC&interval=2' \
--header 'coinglassSecret: fabe11b61f5a4963a4227f4ac2cbcf2f'
GET https://open-api.coinglass.com/api/pro/v1/futures/longShort_chart
Query Parameters
Parameter | Default | Description |
---|---|---|
interval | int | (1h=2, 4h=1, 12h=4, 24h=5) |
symbol | string | Symbol |
Funding Rates Chart
curl --location --request GET 'https://open-api.coinglass.com/api/pro/v1/futures/funding_rates_chart?symbol=BTC&type=C' \
--header 'coinglassSecret: fabe11b61f5a4963a4227f4ac2cbcf2f'
GET https://open-api.coinglass.com/api/pro/v1/futures/funding_rates_chart
Query Parameters
Parameter | Default | Description |
---|---|---|
type | string | default C (Token Margined=C, USDT or USD Margined=U) |
symbol | string | Symbol |
Exchange Vol
curl --location --request GET 'https://open-api.coinglass.com/api/pro/v1/futures/vol/chart?symbol=BTC' \
--header 'coinglassSecret: fabe11b61f5a4963a4227f4ac2cbcf2f'
GET https://open-api.coinglass.com/api/pro/v1/futures/vol/chart
Query Parameters
Parameter | Default | Description |
---|---|---|
symbol | string | Symbol |
OPTIONS
Options Open Interest
curl --location --request GET 'https://open-api.coinglass.com/api/pro/v1/option/openInterest?symbol=BTC' \
--header 'coinglassSecret: fabe11b61f5a4963a4227f4ac2cbcf2f'
GET https://open-api.coinglass.com/api/pro/v1/option/openInterest
Query Parameters
Parameter | Default | Description |
---|---|---|
symbol | string | Symbol |
Options Open Interest Chart
curl --location --request GET 'https://open-api.coinglass.com/api/pro/v1/option/openInterest/history/chart?symbol=BTC&interval=0' \
--header 'coinglassSecret: fabe11b61f5a4963a4227f4ac2cbcf2f'
GET https://open-api.coinglass.com/api/pro/v1/option/openInterest/history/chart
Query Parameters
Parameter | Default | Description |
---|---|---|
interval | int | (ALL=0, 1H=2, 4H=1, 12H=4, 24H=5) |
symbol | string | BTC or ETH |
Exchange Vol
curl --location --request GET 'https://open-api.coinglass.com/api/pro/v1/option/vol/history/chart?symbol=BTC' \
--header 'coinglassSecret: fabe11b61f5a4963a4227f4ac2cbcf2f'
GET https://open-api.coinglass.com/api/pro/v1/option/vol/history/chart
Query Parameters
Parameter | Default | Description |
---|---|---|
symbol | string | BTC or ETH |