OrderBook Heatmap (Plan4)

GET

https://open-api.coinank.com/api/orderBook/getHeatMap

Returns a heat map of trading pair liquidity by time level and range

Request

Query Params

exchange

string

optional

Binance

Example:

Binance

symbol

string

optional

Example:

BTCUSDT

interval

string

optional

Example:

endTime

string

optional

Example:

1725980875358

size

string

optional

Example:

Header Params

apikey

string

required

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://open-api.coinank.com/api/orderBook/getHeatMap?exchange=Binance&symbol=BTCUSDT&interval=1m&endTime=1725980875358&size=10' \
--header 'apikey;'

Responses

🟢200OK

application/json

Body

success

boolean

required

code

string

required

data

array [object {3}]

required

integer

required

time array

bids

object

required

bids value of the coin

asks

object

required

asks value of the coin

ext

integer

required

step

Example

{
    "success": true,
    "code": "string",
    "data": [
        {
            "ts": 0,
            "bids": {
                "counts": [
                    0
                ],
                "prices": [
                    0
                ]
            },
            "asks": {
                "counts": [
                    0
                ],
                "prices": [
                    0
                ]
            }
        }
    ],
    "ext": 0
}

Modified at 2025-04-23 09:50:49

Exchange Order Book Difference (Plan3)

OrderFlow List (Plan3)