Skip to main content
GET
Explore agents

Authorizations

Authorization
string
header
required

User JWT access token issued by POST /api/auth/verify or POST /api/auth/social/verify. Routes that accept both auth modes declare api-key and bearer-jwt security schemes.

Headers

x-signature
string
required

Required for API-key authenticated requests. HMAC-SHA256(secretKey, timestamp + METHOD + path + body) as lowercase hex. Omit only for JWT/OAuth session tokens or public routes.

x-timestamp
string
required

Required with x-signature. Epoch milliseconds; rejected if drift exceeds 5 minutes. Omit only for JWT/OAuth session tokens or public routes.

Query Parameters

limit
any
offset
any
order
enum<string>
Available options:
ASC,
DESC
orderBy
enum<string>
Available options:
name,
createdAt,
updatedAt
sortBy
enum<string>
Available options:
NAME,
CREATED_AT,
UPDATED_AT,
PERFORMANCE,
TOP_PERFORMING,
SUBSCRIBER_COUNT,
RECENTLY_SUBSCRIBED,
HIGHEST_WIN_RATE,
MOST_ACTIVE,
RISING_STARS,
HIGHEST_ALLOCATION,
HIGHEST_PROFIT,
FOLLOWER_COUNT,
BIGGEST_WIN,
VOLUME,
OPEN_PNL
sortDirection
enum<string>
Available options:
ASC,
DESC
performanceTimeframe
enum<string>

Window for the ranking and the directory metrics (DAY=24H, WEEK=7D, MONTH=30D, THREE_MONTHS=90D, ALL; default MONTH, MOST_ACTIVE default WEEK). OPEN_PNL is live. YEAR is deprecated.

Available options:
DAY,
WEEK,
MONTH,
THREE_MONTHS,
YEAR,
ALL
filter
object

Nested filter (bracket query: filter[field]=...). Public explore omits agents with no closed FINALIZED trade unless myAgentsScope is set.

Response

Paginated explore agents.

success
boolean
required
Example:

true

data
object
required

Endpoint-specific payload