Liquidation KPI stats

GET 
/api/v1/liquidation/stats

Aggregate liquidation stats (total, long/short split, count, venue count, biggest single event) over a 1h/4h/24h window. Backs the liquidation page KPI strip for windows the live feed buffer can't cover.

Request

Query Parameters

window string
Possible values: [1h, 4h, 24h]
Rolling window
Default value: 1h
exchange string

Exchange filter

minVolumeUsd number

Minimum VolumeUsd filter

Header Parameters

X-DTMX-APIKEY string

Your DataMaxi+ API key

Responses

200

OK

application/json

Schema

Schema

biggest

object

base string

exchange string

quote string

volumeUsd number
count integer

number of events

generatedAt integer

ms

longRatio integer

round(long/total*100), 0 when empty

longUsd number

sell-side

shortUsd number

buy-side

total number

long + short

venues integer

distinct exchanges

window string

"1h" | "4h" | "24h"

Example (from schema)

{
  "biggest": {
    "base": "string",
    "exchange": "string",
    "quote": "string",
    "volumeUsd": 0
  },
  "count": 0,
  "generatedAt": 0,
  "longRatio": 0,
  "longUsd": 0,
  "shortUsd": 0,
  "total": 0,
  "venues": 0,
  "window": "string"
}

400

Bad Request

application/json

Schema

Schema

error string

error specifies the error message

Example (from schema)

{
  "error": "string"
}

500

Internal Server Error

application/json

Schema

Schema

error string

error specifies the error message

Example (from schema)

{
  "error": "string"
}

Loading...