Leaderboards

The leaderboards endpoint allows you to retrieve leaderboard standings for unrealized profit (period delta), unrealized profit (inception), volume, and realized profit.

📘

Leaderboard Competitions

The Configs Endpoint can be used to retrieve a list of all competitions shown on our Leaderboards.

The endpoint can be called like this: https://api-pub.bitfinex.com/v2/conf/pub:list:competitions

KeyAvailable Time FramesAvailable Symbols
"plu_diff" - (Unrealised Profit (Period Delta))"1w", "1M"tGLOBAL:USD
"plu" - (Unrealised Profit (Inception))"3h" - for specific pairs
"1w", "1M" - for tGLOBAL:USD
  • Trading Pairs (e.g. tBTCUSD, tETHUSD)
  • tGLOBAL:USD
"plr" - (Realized Profit)"1w", "1M"tGLOBAL:USD
"vol" - (Volume)"3h", "1w", "1M"
  • Trading Pairs (e.g. tBTCUSD, tETHUSD)
  • tGLOBAL:USD

Response Details

FieldsTypeDescription
MTSintmillisecond timestamp
USERNAMEstringUsername
RANKINGintPlace on leaderboard
VALUEfloatValue of volume, unrealized profit, or realized profit
TWITTER_HANDLEstringShows the user's Twitter handle (if available)

Ratelimit: 90 req/min

Path Params
string
required
Defaults to vol

Allowed values: "plu_diff" for unrealized profit (period delta); "plu" for unrealized profit (inception); "vol" for volume; "plr" for realized profit

string
required
Defaults to 3h

Available values: "3h", "1w", "1M" - see table below for available time frames per key

string
required
Defaults to tBTCUSD

The symbol you want information about. (e.g. tBTCUSD, tETHUSD, tGLOBAL:USD) - see table below for available symbols per key

string
required
Defaults to hist

Available values: "hist"

Query Params
int32
Defaults to -1

if = 1 it sorts results returned with old > new

int64
Defaults to null

Millisecond start time

int64
Defaults to null

Millisecond end time

int32
Defaults to 125

Number of records (Max: 10000)

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json