Skip to main content
GET
Rank traders

Authorizations

x-api-key
string
header
default:<api-key>
required

API key issued by Centaur.

Query Parameters

metric
enum<string>

Ranking metric. Activity metrics: event_count (default) and position_count. Performance metrics: win_rate, avg_return, median_return, and sharpe_ratio.

Available options:
event_count,
position_count,
win_rate,
avg_return,
median_return,
sharpe_ratio
assetIds

Restrict the ranking to traders active in these assets. Positive integer asset IDs only. REST accepts comma-separated values or repeated parameters. MCP accepts an array. Numeric strings become IDs. Maximum 200 non-empty supplied entries per field, including duplicates. Use assetRefs for slugs, tickers, or legacy symbols. Do not supply assetIds and assetRefs together, even if one is empty.

Example:

"1,34"

assetRefs

Restrict the ranking to traders active in these assets. Asset slugs, tickers, or legacy symbols as strings only. REST accepts comma-separated values or repeated parameters. MCP accepts a string array, e.g. ["AAPL", "crypto-btc", "700"]. Values are trimmed and matched case-insensitively, in order: slug, ticker, then legacy symbol. Numeric text such as "700" is a literal reference, never an ID. Maximum 200 non-empty supplied entries per field, including duplicates. Do not supply assetIds and assetRefs together, even if one is empty. Unknown references match nothing. Retry ambiguous references with a returned numeric ID in assetIds, omitting assetRefs. Find names with asset discovery search.

Example:

"AAPL,crypto-btc,700"

direction
enum<string>

Filter to a single direction: long or short.

Available options:
long,
short
timeBasedPerformanceWindow
enum<string>

Time-based performance evaluation window for performance metrics. Defaults to 30D. Ignored for activity metrics. Invalid sample and evaluation combinations return HTTP 422 with valid retry alternatives.

Available options:
1D,
7D,
30D
minPositions
integer | null

Minimum evaluated positions required for performance-metric rankings. Defaults to 3; pass 0 to include all traders. Ignored for activity metrics.

Required range: x >= 0
startTime
string<date-time>

Inclusive ISO-8601 lower time bound on position open time. Defaults to January 1 at 00:00:00 UTC in the applied endTime year.

endTime
string<date-time>

Inclusive ISO-8601 upper time bound. Defaults to the current server time.

limit
integer

Maximum number of ranked traders to return. Defaults to 10, maximum 50.

Required range: 1 <= x <= 50

Response

Bounded trader ranking for the applied metric and time window

success
enum<boolean>
required
Available options:
true
data
object
required
requestId
string
required
Example:

"c8e2c6e4-80dd-4ffc-9d66-4e31bf64c6b8"