Introduction 👋

Welcome to CHART-IMG exclusive developer REST API documentation.

Recent Changes 🕑

July 11, 2025

Update with retry mechanism for indicator load failure.

July 01, 2025

Updated with the lastest version of coinglass.
Removed retry machanism due to source code change.

Mar 26, 2025

Update with retry mechanism for indicator load failure.
Update with Bitunix exchange support.

Nov 08, 2024

Initial API release with coinglass support.

Base API Endpoint 🔗

https://api.chart-img.com

Authentication 🔒

For authenticated requests, include a personal API key in the x-api-key header for POST requests. For GET requests, the API key can be included either in the request header or as a query parameter named key.

Request Limit ⚠️

All requests follow typical HTTP response status codes for success, failure, and error.

Coinglass Snapshot

Advanced Chart

This endpoint captures coinglass exchange advanced chart image.

Request Example:

{
  "symbol": "BINANCE:BTCUSDT.P",
  "interval": "4h",
  "theme": "dark",
  "watermark": "BTCUSDT",
  "watermarkSize": 64,
  "watermarkOpacity": 0.1,
  "studies": [
    "Aggregated Open Interest (STABLECOIN-margined,Candles)",
    "Aggregated Liquidations (STABLECOIN-margined)",
    "Aggregated Futures Cumulative Volume Delta (CVD)"
  ]
}

curl -X POST https://api.chart-img.com/v3/coinglass/advanced-chart \
  -H "x-api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d "{\"symbol\":\"BINANCE:BTCUSDT.P\",\"interval\":\"4h\",\"theme\":\"dark\",\"watermark\":\"BTCUSDT\",\"watermarkSize\":64,\"watermarkOpacity\":0.1,\"studies\":[\"Aggregated Open Interest (STABLECOIN-margined,Candles)\",\"Aggregated Liquidations (STABLECOIN-margined)\",\"Aggregated Futures Cumulative Volume Delta (CVD)\"]}" \
  -o advanced-01.png

Request Example:

{
  "symbol": "BINANCE:BTCUSDT.P",
  "interval": "1h",
  "theme": "dark",
  "height": 800,
  "watermark": "BTCUSDT",
  "watermarkSize": 64,
  "watermarkOpacity": 0.1,
  "studies": [
    "Volume (Overlay)",
    "Cumulative Volume Delta (CVD Candles)",
    "Funding Rates (Open Interest Weighted,Candles)",
    "Aggregated Futures Bid & Ask Delta"
  ]
}

curl -X POST https://api.chart-img.com/v3/coinglass/advanced-chart \
  -H "x-api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d "{\"symbol\":\"BINANCE:BTCUSDT.P\",\"interval\":\"1h\",\"theme\":\"dark\",\"height\":800,\"watermark\":\"BTCUSDT\",\"watermarkSize\":64,\"watermarkOpacity\":0.1,\"studies\":[\"Volume (Overlay)\",\"Cumulative Volume Delta (CVD Candles)\",\"Funding Rates (Open Interest Weighted,Candles)\",\"Aggregated Futures Bid & Ask Delta\"]}" \
  -o advanced-02.png

Request Example:

{
  "symbol": "BINANCE:ETHUSDT.P",
  "theme": "dark",
  "height": 800,
  "watermark": "ETHUSDT",
  "watermarkSize": 64,
  "watermarkOpacity": 0.1,
  "studies": [
    "Volume (Overlay)",
    "Crypto Fear & Greed Index",
    "Top Trader Long/Short (Positions)",
    "Whale Index 4"
  ]
}

curl -X POST https://api.chart-img.com/v3/coinglass/advanced-chart \
  -H "x-api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d "{\"symbol\":\"BINANCE:ETHUSDT.P\",\"theme\":\"dark\",\"height\":800,\"watermark\":\"ETHUSDT\",\"watermarkSize\":64,\"watermarkOpacity\":0.1,\"studies\":[\"Volume (Overlay)\",\"Crypto Fear & Greed Index\",\"Top Trader Long\/Short (Positions)\",\"Whale Index 4\"]}" \
  -o advanced-03.png

HTTP Request

POST /v3/coinglass/advanced-chart

Request Header

Parameter	Type	Required	Description
x-api-key	String	Yes	authentication API access key

Request Body (Optional)

The default values will be used to generate the chart if no request body is provided.

Content-Type

application/json

Parameter	Type	Default	Description
symbol	String	`BINANCE:BTCUSDT.P`	set chart symbol eg. `BTCUSDT` (spot), `BTCUSDT.P`, `BTCUSDT_241227` (futures)
interval	String	`1D`	set chart interval [`1m`, `5m`, `15m`, `30m`, `1h`, `2h`, `4h`, `6h`, `12h`, `1D`, `1W`]
width	Integer	`800`	set chart image width in pixels (Min: `400`, Max: `2048`)
height	Integer	`600`	set chart image height in pixels (Min: `300`, Max: `1920`)
theme	String	`light`	set chart theme color [`light`, `dark`]
timezone	String	`Etc/UTC`	set chart timezone
format	String	`png`	set chart image format [`png`, `jpeg`]
studies	String[]	`[]`	set chart to include multiple study indicators`*some are SPOT/FUTURES dependent`
watermark	String	-	set custom watermark text
watermarkSize	Integer	`16`	set watermark text size [`16`, `32`, `64`, `128`]
watermarkOpacity	Float	`1.0`	set watermark text opacity (Min: `0.1`, Max: `1.0`)

If default values are the same, there is no need to include them in the request.

HTTP Response

Content-Type

image/png, image/jpeg, application/json

Supported Studies

Study
Aggregated Futures Bid & Ask
Aggregated Futures Bid & Ask Delta
Aggregated Futures Bid & Ask Ratio
Aggregated Futures Cumulative Volume Delta (CVD Candles)
Aggregated Futures Cumulative Volume Delta (CVD)
Aggregated Futures Taker Buy/Sell Volume
Aggregated Futures Volume
Aggregated Futures/Spot Volume Ratio
Aggregated Liquidations
Aggregated Liquidations (Coin-margined)
Aggregated Liquidations (STABLECOIN-margined)
Aggregated Long/Short Ratio (Taker Buy/Sell Ratio)
Aggregated Long/Short Ratio (Taker Buy/Sell Ratio) Synchronize Main
Aggregated Open Interest (COIN-margined,Candles)
Aggregated Open Interest (Candles)
Aggregated Open Interest (STABLECOIN-margined,Candles)
Aggregated Spot Bid & Ask
Aggregated Spot Bid & Ask Delta
Aggregated Spot Bid & Ask Ratio
Aggregated Spot Cumulative Volume Delta (CVD Candles)
Aggregated Spot Cumulative Volume Delta (CVD)
Aggregated Spot Taker Buy/Sell Volume
Aggregated Spot Volume
Bid & Ask
Bid & Ask Delta
Bid & Ask Ratio
Binance USDT Borrow yearly Interest Rate (%)
Borrow Yearly Interest Rate (%)
Bybit USDT Borrow Yearly Interest Rate (%)
CME BTC Futures Open Interest
CME ETH Futures Open Interest
Coinbase BTC Premium Index
Crypto Fear & Greed Index
Cumulative Volume Delta (CVD Candles)
Cumulative Volume Delta (CVD)
Funding Rates
Funding Rates (Candles)
Funding Rates (Open Interest Weighted)
Funding Rates (Open Interest Weighted,Candles)
Grayscale Holdings
Grayscale Premium
Long/Short Ratio (Accounts)
Long/Short Ratio (Accounts,Candles)
Market Cap
Net Delta
Net Longs
Net Shorts
OKX USDT Borrow Yearly Interest Rate (%)
Open Interest
Open Interest (Candles)
Open Interest (Synchronize Main Chart)
Open Interest Delta
Open Interest/Market Cap
Predicted Funding Rates
Premium Index (%)
Price Index
Symbol Liquidations
Taker Buy/Sell Count
Taker Buy/Sell Count (Delta)
Taker Buy/Sell Value
Taker Buy/Sell Value (Delta)
Taker Buy/Sell Volume
Taker Buy/Sell Volume (Delta)
Top Trader Long/Short (Accounts)
Top Trader Long/Short (Accounts,Candles)
Top Trader Long/Short (Positions)
Top Trader Long/Short (Positions,Candles)
Volume
Volume (Overlay)
Whale Index
Whale Index 2
Whale Index 3
Whale Index 4

Additional studies can be added upon request.

Supported Timezone

Timezone	Country	UTC Offset
`Africa/Cairo`	EG	UTC +02:00
`Africa/Johannesburg`	ZA	UTC +02:00
`Africa/Lagos`	NG	UTC +01:00
`America/Argentina/Buenos_Aires`	AR	UTC -03:00
`America/Bogota`	CO	UTC -05:00
`America/Caracas`	VE	UTC -04:00
`America/Chicago`	US	UTC -06:00
`America/El_Salvador`	SV	UTC -06:00
`America/Juneau`	US	UTC -09:00
`America/Lima`	PE	UTC -05:00
`America/Los_Angeles`	US	UTC -08:00
`America/Mexico_City`	MX	UTC -06:00
`America/New_York`	US	UTC -05:00
`America/Phoenix`	US	UTC -07:00
`America/Santiago`	CL	UTC -03:00
`America/Sao_Paulo`	BR	UTC -03:00
`America/Toronto`	CA	UTC -05:00
`America/Vancouver`	CA	UTC -08:00
`Asia/Almaty`	KZ	UTC +06:00
`Asia/Ashkhabad`	TM	UTC +05:00
`Asia/Bahrain`	BH	UTC +03:00
`Asia/Bangkok`	TH	UTC +07:00
`Asia/Chongqing`	CN	UTC +08:00
`Asia/Dubai`	AE	UTC +04:00
`Asia/Hong_Kong`	HK	UTC +08:00
`Asia/Ho_Chi_Minh`	VN	UTC +07:00
`Asia/Jakarta`	ID	UTC +07:00
`Asia/Jerusalem`	IL	UTC +02:00
`Asia/Karachi`	PK	UTC +05:00
`Asia/Kathmandu`	NP	UTC +05:45
`Asia/Kolkata`	IN	UTC +05:30
`Asia/Kuwait`	KW	UTC +03:00
`Asia/Manila`	PH	UTC +08:00
`Asia/Muscat`	OM	UTC +04:00
`Asia/Qatar`	QA	UTC +03:00
`Asia/Riyadh`	SA	UTC +03:00
`Asia/Seoul`	KR	UTC +09:00
`Asia/Shanghai`	CN	UTC +08:00
`Asia/Singapore`	SG	UTC +08:00
`Asia/Taipei`	TW	UTC +08:00
`Asia/Tehran`	IR	UTC +03:30
`Asia/Tokyo`	JP	UTC +09:00
`Atlantic/Reykjavik`	IS	UTC
`Australia/ACT`	AU	UTC +11:00
`Australia/Adelaide`	AU	UTC +10:30
`Australia/Brisbane`	AU	UTC +10:00
`Australia/Perth`	AU	UTC +08:00
`Australia/Sydney`	AU	UTC +11:00
`Europe/Amsterdam`	NL	UTC +01:00
`Europe/Athens`	GR	UTC +02:00
`Europe/Belgrade`	RS	UTC +01:00
`Europe/Berlin`	DE	UTC +01:00
`Europe/Bratislava`	SK	UTC +01:00
`Europe/Brussels`	BE	UTC +01:00
`Europe/Bucharest`	RO	UTC +02:00
`Europe/Budapest`	HU	UTC +01:00
`Europe/Copenhagen`	DK	UTC +01:00
`Europe/Dublin`	IE	UTC
`Europe/Helsinki`	FI	UTC +02:00
`Europe/Istanbul`	TR	UTC +03:00
`Europe/Lisbon`	PT	UTC
`Europe/London`	GB	UTC
`Europe/Luxembourg`	LU	UTC +01:00
`Europe/Madrid`	ES	UTC +01:00
`Europe/Malta`	MT	UTC +01:00
`Europe/Moscow`	RU	UTC +03:00
`Europe/Oslo`	NO	UTC +01:00
`Europe/Paris`	FR	UTC +01:00
`Europe/Riga`	LV	UTC +02:00
`Europe/Rome`	IT	UTC +01:00
`Europe/Stockholm`	SE	UTC +01:00
`Europe/Tallinn`	EE	UTC +02:00
`Europe/Vilnius`	LT	UTC +02:00
`Europe/Warsaw`	PL	UTC +01:00
`Europe/Zurich`	CH	UTC +01:00
`Pacific/Auckland`	NZ	UTC +13:00
`Pacific/Chatham`	NZ	UTC +13:45
`Pacific/Fakaofo`	TK	UTC +13:00
`Pacific/Honolulu`	US	UTC -10:00
`Pacific/Norfolk`	NF	UTC +12:00
`US/Mountain`	US	UTC -06:00

Advanced Chart To Storage

This endpoint captures an advanced chart image from coinglass and saves it to public storage.

Response Example:

{
  "url": "https://r2.chart-img.com/81c4adc2/coinglass/advanced-chart/81c4adc2-35c6-4144-8521-93b8e7f6deea.png",
  "size": 278149,
  "cors": "*",
  "etag": "6f710e8b936c3b3ea0dd893c500569c9",
  "expireAt": "2025-03-07T17:43:11.089Z",
  "createdAt": "2024-11-07T17:43:11.872Z"
}

Request Example:

{
  "symbol": "BINANCE:WAXPUSDT.P",
  "interval": "4h",
  "theme": "dark",
  "watermark": "WAXPUSDT",
  "watermarkSize": 64,
  "watermarkOpacity": 0.1,
  "studies": [
    "Aggregated Open Interest (STABLECOIN-margined,Candles)",
    "Aggregated Liquidations (STABLECOIN-margined)",
    "Aggregated Futures Cumulative Volume Delta (CVD)",
    "Aggregated Spot Cumulative Volume Delta (CVD)"
  ]
}

curl -X POST https://api.chart-img.com/v3/coinglass/advanced-chart/storage \
  -H "x-api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d "{\"symbol\":\"BINANCE:WAXPUSDT.P\",\"interval\":\"4h\",\"theme\":\"dark\",\"watermark\":\"WAXPUSDT\",\"watermarkSize\":64,\"watermarkOpacity\":0.1,\"studies\":[\"Aggregated Open Interest (STABLECOIN-margined,Candles)\",\"Aggregated Liquidations (STABLECOIN-margined)\",\"Aggregated Futures Cumulative Volume Delta (CVD)\",\"Aggregated Spot Cumulative Volume Delta (CVD)\"]}" \
  -o advanced-01.json

HTTP Request

POST /v3/coinglass/advanced-chart/storage

Request Header

Parameter	Type	Required	Description
x-api-key	String	Yes	authentication API access key

Request Body (Optional)

For reference, please read the request body of the Advanced Chart, as it is identical.

Content-Type

application/json

HTTP Response

Content-Type

application/json

Response Body

Parameter	Type	Description
url	String	url of the public chart image
size	Integer	size of the image in byte
cors	String	cors
etag	String	image etag
expireAt	String	when the image will be deleted
createdAt	String	when the image is created

Errors

Response Example (400)

{
  "message": "Invalid Request"
}

Response Example (422)

{
  "message": "Invalid Symbol"
}

{
  "errors": [
    {
      "type": "field",
      "value": "14h",
      "msg": "must be supported",
      "path": "interval",
      "location": "body"
    }
  ]
}

Status	Type	Description
400	Bad Request	Could not process the request due to an error in the content type, usually related to an invalid JSON format in the request body.
403	Forbidden	Could not authenticate the API key provided.
404	Not Found	Could not find the resource or page.
422	Not Acceptable	Could not process the request due to invalid body parameters or semantic errors such as exchange not supporting symbols, intervals and studies.
429	Too Many Request	Exceed the usage limit or the rate limit.
500	Server Error	Could not process the request due to an error, or the server may be temporarily unavailable due to technical issues.
504	Process Timeout	Could not process the request due to timeout error. Try your request again.