Leaderboard

Paginated subaccount leaderboard ranked by PnL. Realized + unrealized (mark-to-market). Timeframe required: today, 7d, 30d, all. Default limit 10, max 100.

get/api/v1/user/leaderboard

Request

Query parameters

offsetinteger nullable

Pagination offset (default 0).

limitinteger nullable

Max number of entries to return (default 10, max 100).

timeframe'today' | '7d' | '30d' | 'all' required

Leaderboard ranking window: today, last 7 days, last 30 days, or all time.

Ranking window.

Response

Leaderboard

Changes

    • info

      added the required property // to the response with the status

    • breaking

      the query request parameter timeframe was restricted to a list of enum values

    • breaking

      removed the required property // from the response with the status

    • info

      api tag Leaderboard added

    • info

      api tag User removed

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

      added the new enum value 30d to the query request parameter timeframe

    • info

      added the new enum value 7d to the query request parameter timeframe

    • info

      added the new enum value all to the query request parameter timeframe

    • info

      added the new enum value today to the query request parameter timeframe

    • info

      for the query request parameter timeframe, the type was generalized from no type to string

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status