Skip to main content
GET
List trader stats

Authorizations

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

API key issued by Centaur.

Query Parameters

traderIds

Traders to fetch stats for. Supply traderIds or traderRefs. Positive integer trader 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 traderRefs for slugs. Do not supply traderIds and traderRefs together, even if one is empty.

Example:

"7,12"

traderRefs

Traders to fetch stats for. Supply traderIds or traderRefs. Trader slugs as strings only. REST accepts comma-separated values or repeated parameters. MCP accepts a string array, e.g. ["alpha-trades", "700"]. Values are trimmed and matched case-insensitively. Numeric text such as "700" is a literal slug, never an ID. Maximum 200 non-empty supplied entries per field, including duplicates. Do not supply traderIds and traderRefs together, even if one is empty. Unknown references match nothing. Retry ambiguous references with a returned numeric ID in traderIds, omitting traderRefs. Find names or handles with trader directory search.

Example:

"alpha-trades"

assetIds

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

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"

sourcePlatforms

Filter to traders whose source platform is TELEGRAM or X.

direction
enum<string>

Filter to a single direction: long or short.

Available options:
long,
short
startTime
string<date-time>

Inclusive ISO-8601 lower time bound.

endTime
string<date-time>

Inclusive ISO-8601 upper time bound.

Response

Trader stats collection for requested trader IDs

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

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