Stats

get

https://api-pub.bitfinex.com/v2/stats1/{key}:{size}:{sym_platform}:{side_pair}/{section}

The Stats endpoint provides various statistics on a specified trading pair or funding currency. Use the available keys to specify which statistic you wish to retrieve.

Path Params

key

string

required

Defaults to pos.size

Available keys: "funding.size", "credits.size", "credits.size.sym", "pos.size", "vol.1d", "vol.7d", "vol.30d", "vwap"

size

string

required

Defaults to 1m

Available values: '1m' (for keys: "pos.size", "funding.size", "credits.size", "credits.size.sym"), "30m" (for keys: vol.1d, vol.7d, vol.30d), "1d" (for keys: vwap)

sym_platform

string

required

Defaults to tBTCUSD

The symbol you want information about. (e.g. tBTCUSD, tETHUSD, fUSD, fBTC) (used for keys: "pos.size", "funding.size", "credits.size", "credits.size.sym", "vwap", "vol1d/7d/30d").

side_pair

string

required

Defaults to long

Used to specify the side for "pos.size" key. Available values: "long", "short". Only for non-funding queries. Used to specify the trading pair on credits.size.sym.

section

string

required

Defaults to hist

Available values: "last", "hist".

Query Params

sort

int32

+1: sort in ascending order | -1: sort in descending order (by MTS field).

start

int64

If start is given, only records with MTS >= start (milliseconds) will be given as response.

end

int64

If end is given, only records with MTS <= end (milliseconds) will be given as response.

limit

int32

Number of records in response (max. 10000).

Response

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200