Leaderboard

The /leader/leaderboard endpoint provides ranked data of leaders based on performance metrics over a specified period. It is used to display a leaderboard of top-performing copy trading leaders, supporting filtering and sorting for deeper analytics.

Method

GET /leader/leaderboard

Internal Method For One User

GET /user/leaderboard/<bitmex-id>

Query Parameters

Name	Type	Description
period	int	Timeframe over which ranking is evaluated. Allowed values: 7, 30, 90, 180. Defaults to 30.
sort_by	string	Metric to sort the leaderboard by. Allowed values: roi, pnl, mdd, aum, copiers, sharpe, risk, win_ratio. Defaults to roi.
page	int	Page number for pagination. Defaults to 1.
page_size	int	Number of entries per page. Defaults to 12.
asc	int	Sort ascending if 1; descending otherwise. Defaults to descending.
min_roi	decimal	Optional filter for minimum ROI.
max_roi	decimal	Optional filter for maximum ROI.
min_mdd	decimal	Optional filter for minimum MDD.
max_mdd	decimal	Optional filter for maximum MDD.
min_aum	decimal	Optional filter for minimum AUM.
max_aum	decimal	Optional filter for maximum AUM.
min_copier	int	Optional filter for minimum number of copiers.
max_copier	int	Optional filter for maximum number of copiers.
min_balance	decimal	Optional filter for minimum balance.
max_balance	decimal	Optional filter for maximum balance.
min_pnl	decimal	Optional filter for minimum Pnl. (USD)
max_pnl	decimal	Optional filter for maximum Pnl. (USD)
min_copier_pnl	decimal	Optional filter for minimum copier Pnl. (USD)
max_copier_pnl	decimal	Optional filter for maximum copier Pnl. (USD)
name	string	Optional filter for leader name.
bookmarks	int	1 to filter only bookmarked leaders. Defaults to 0.
copied	int	1 to filter only copied leaders. Defaults to 0.
kind	string	Optional filter for leader kind. Allowed values: normal, hyper.

Note

If name exists in the query, we will ignore all other filters except period, sort_by, asc, page and page_size.

Name is case-insensitive and run using fuzzy search. Meaning if you search for "dunny" it will match "Dunny" and "DunnY" and "BarDunny32".

Response

{
  "status": 200,
  "data": {
    "ranks": [
      {
        "rank": 1,
        "leader_id": "15313220168320001",
        "rank_period": 30,
        "initial_balance": "47.68",
        "final_balance": "46.72",
        "mdd": "2.64",
        "roi": "-2.01",
        "pnl": "-0.96",
        "aum": "0",
        "sharpe": "-0.894",
        "incoming": "0",
        "outgoing": "0",
        "win_positions": 0,
        "total_positions": 0,
        "copier": 0,
        "risk": 3,
        "hold_avg": 0,
        "trade_freq": "0",
        "copier_pnl": "0",
        "updated_at": "2025-04-01T04:08:16.110824Z",
        "name": "baraka",
        "avatar": "avatar",
        "max_copiers": 100,
        "is_bookmark": false,
        "kind": "normal",
        "badges": ["1100003", "2100001", "3100001"],
        "graph": [
          { "day": "2025-05-11T00:00:00Z", "value": "43.28" },
          { "day": "2025-05-12T00:00:00Z", "value": "42.14" },
          { "day": "2025-05-13T00:00:00Z", "value": "42.93" }
        ],
        "is_private": true
      }
    ],
    "total_count": 3,
    "page": 1,
    "page_size": 12,
    "page_count": 1,
    "last_updated_at": "2025-05-07T04:20:57.321096Z"
  }
}

Fields Explained

Leader Entry (ranks)

• rank: Position of the leader in the leaderboard.
• leader_id: Unique identifier of the leader.
• name: Display name of the leader.
• avatar: URL to the leader's avatar image.
• rank_period: Evaluation period in days.
• initial_balance: Account balance at the start of the ranking period (USD).
• final_balance: Account balance at the end of the ranking period (USD).
• roi: Return on investment over the period (%).
• pnl: Profit or loss over the ranking period (USD).
• mdd: Maximum drawdown during the period (%).
• sharpe: Sharpe ratio (risk-adjusted return).
• aum: Assets under management (USD).
• incoming: Total incoming transfers (USD).
• outgoing: Total outgoing transfers (USD).
• copier: Number of copiers during the period.
• max_copiers: Maximum number of copiers the leader allows to copy.
• copier_pnl: Combined profit/loss of all copiers (USD).
• win_positions: Number of profitable positions taken.
• total_positions: Total positions taken.
• updated_at: Timestamp of the last rank update.
• graph_kind: Type of data represented in graph (roi, pnl, aum).
• risk: Risk level of the leader 1 - low, 2 - medium, 3 - high.
• hold_avg: Average time the leader holds a position given in seconds.
• trade_freq: Average number of trades per day.
• is_bookmark: Boolean indicating if the leader is bookmarked by the user.
• kind: Leader type, either normal or hyper.
• badges: Array of badges ids earned by the leader.
• graph: Time series array of performance data.
  • day: ISO 8601 date.
  • value: Metric value (e.g., ROI).
• is_private: Boolean indicating if the leader is private.

Pagination

• total_count: Total leaderboard entries matching the query.
• page: Current page number.
• page_size: Entries per page.
• page_count: Total number of pages.
• last_updated_at: Timestamp of the last rank update.