Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

hdk_sk_live_v1_… or hdk_sk_test_v1_…

Headers

X-Max-Credits
integer

Refuse (free) if the request could cost more.

X-Credit-Price-Version
integer

Expected price version; 409 price_changed if it differs.

Query Parameters

sort
enum<string>
default:pnlPerpMonth

Sort field. Default pnlPerpMonth (30-day perp PnL), as hyperdash.com's Explore traders.

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. Default: the sort's window (pnlPerpDay 24h, pnlPerpWeek 7d, pnlPerpMonth 30d, so 30d for the default sort, pnlPerpAllTime alltime), else alltime.

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

Only traders with at least this account value (USD; Explore's equity filter).

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

Only traders with at least this perp PnL (USD) in timeframe's window (pnl_day, pnl_week, pnl_month or pnl_alltime); 0 = profitable.

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

Only traders with at least this copy score (copy_score_v2, Explore's copy-score filter).

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

Only traders with this style tag (Explore's trader-type filter).

Available options:
algo,
scalp,
intraday,
swing,
position
limit
integer
default:100

Rows (≤ 1000).

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

Opaque cursor from next_cursor.

Response

OK

data
object[]
required
has_more
boolean
required
next_cursor
string | null
required
meta
object
required