Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Your API key, sent as Bearer hdk_sk_live_v1_….

Query Parameters

sort
enum<string>
default:pnlPerpMonth

Sort field. Defaults to pnlPerpMonth, the 30-day perp PnL, as on Explore traders on hyperdash.com.

Available options:
pnlPerpDay,
pnlPerpWeek,
pnlPerpMonth,
pnlPerpAllTime,
winrate30d,
winrate7d,
winrateLifetime,
totalTrades,
accountValue,
notional,
sharpe30d,
copyScore,
copyScoreV2,
maxDrawdownPerpWeek,
maxDrawdownPerpMonth
order
enum<string>
default:desc

Sort order.

Available options:
desc,
asc
timeframe
enum<string>

Window of rank and of min_pnl. Defaults to the sort's window: 24h for pnlPerpDay, 7d for pnlPerpWeek, 30d for pnlPerpMonth (so 30d for the default sort) and alltime for pnlPerpAllTime. Any other sort defaults to alltime.

Available options:
24h,
7d,
30d,
alltime
min_account_value
enum<string>

Only traders with at least this account value, in USD. This is the equity filter on Explore.

Available options:
1000,
10000,
100000,
1000000,
10000000
min_pnl
enum<string>

Only traders with at least this perp PnL in USD over the timeframe window: pnl_day, pnl_week, pnl_month or pnl_alltime. 0 means profitable.

Available options:
0,
10000,
100000,
1000000
min_copy_score
enum<string>

Only traders with at least this copy score (copy_score_v2). This is the copy-score filter on Explore.

Available options:
50,
70,
90
tag
enum<string>

Only traders with this style tag. This is the trader-type filter on Explore.

Available options:
algo,
scalp,
intraday,
swing,
position
max_account_value
enum<string>

Only traders with at most this account value, in USD.

Available options:
10000,
100000,
1000000,
10000000,
100000000
max_pnl
enum<string>

Only traders with at most this perp PnL in USD over the timeframe window. 0 means unprofitable.

Available options:
0,
-1000,
-10000,
-100000,
-1000000
max_copy_score
enum<string>

Only traders with at most this copy score (copy_score_v2).

Available options:
30,
50,
70,
90
winrate_window
enum<string>

Window of min_winrate and max_winrate: winrate_7d, winrate_30d or the lifetime win rate. Defaults to winrate_30d. The lifetime value covers wallets with at least one completed trade.

Available options:
7d,
30d,
lifetime
min_winrate
enum<string>

Only traders with at least this win rate in winrate_window, from 0 to 1.

Available options:
0.3,
0.4,
0.5,
0.6,
0.7,
0.8,
0.9
max_winrate
enum<string>

Only traders with at most this win rate in winrate_window, from 0 to 1.

Available options:
0.1,
0.2,
0.3,
0.4,
0.5,
0.6
min_sharpe
enum<string>

Only traders with at least this 30-day Sharpe.

Available options:
0,
1,
2,
3,
5
max_sharpe
enum<string>

Only traders with at most this 30-day Sharpe.

Available options:
0,
-1,
-2
drawdown_window
enum<string>

Window of max_drawdown: 7d or 30d. Defaults to 30d.

Available options:
7d,
30d
max_drawdown
enum<string>

Only traders whose max drawdown in drawdown_window is at most this. It is a fraction of peak, from 0 to 1.

Available options:
0.05,
0.1,
0.2,
0.3,
0.5
trades_window
enum<string>

Window of min_trades and max_trades: 7d, 30d or total. Defaults to 30d.

Available options:
7d,
30d,
total
min_trades
enum<string>

Only traders with at least this many trades in trades_window.

Available options:
1,
10,
50,
100,
500,
1000
max_trades
enum<string>

Only traders with at most this many trades in trades_window.

Available options:
10,
50,
100,
500,
1000
verified
enum<string>

Only verified profiles.

Available options:
true
limit
integer
default:100

Rows to return, at most 1,000.

Required range: 1 <= x <= 1000
cursor
string

Opaque cursor from next_cursor.

Response

OK

data
object[]
required

Result rows.

has_more
boolean
required

true when another page follows.

next_cursor
string | null
required

Cursor for the next page, passed as cursor. null on the last page.

meta
object
required

Response metadata. Its keys depend on the endpoint and are described above.