v1

latestOpenAPI 3.1.02026-07-24690345.5 KB

Leaderboards

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

get/rankings/{Key}:{Time_Frame}:{Symbol}/{Section}

Path parameters

Keystring required

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

Time_Framestring required

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

Symbolstring required

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

Sectionstring required

Available values: "hist"

Query parameters

sortinteger

if = 1 it sorts results returned with old > new

startinteger

Millisecond start time

endinteger

Millisecond end time

limitinteger

Number of records (Max: 10000)

Response

200