---
title: "Get user volume leaderboard"
method: GET
path: "/v1/stats/user-volume/leaderboard"
tags: ["Stats"]
---

# Get user volume leaderboard

`GET /v1/stats/user-volume/leaderboard`

## Request

- Base URL: `https://api.testnet.rise.trade`
- URL: `https://api.testnet.rise.trade/v1/stats/user-volume/leaderboard`
- Auth: none required
- TypeScript: <https://skmtc.dev/rise/apis/risex-rest-api/docs/v1/stats/user-volume/leaderboard/get.ts> (a function with typed inputs; its response is checked against the schema)

Get top users ranked by volume category within a time range

## Query parameters

- `category` 'USER_VOLUME_CATEGORY_TRADED' | 'USER_VOLUME_CATEGORY_LIQUIDATION' | 'USER_VOLUME_CATEGORY_TOTAL_FEE'
- `window` string
- `limit` integer

## Response `200`

A successful response.

- ApiGetUserVolumeLeaderboardResponse
  - `entries` ApiUserVolumeEntry[]
    - `rank` integer
    - `address` string
    - `traded_volume` string
    - `liquidation_volume` string
    - `total_volume` string
    - `total_fee` string
    - `trade_count` integer
  - `category` 'USER_VOLUME_CATEGORY_TRADED' | 'USER_VOLUME_CATEGORY_LIQUIDATION' | 'USER_VOLUME_CATEGORY_TOTAL_FEE': - USER_VOLUME_CATEGORY_TRADED: Rank by regular trading volume (default; includes TPSL fills, excludes liquidations) - USER_VOLUME_CATEGORY_LIQUIDATION: Rank by liquidation volume - USER_VOLUME_CATEGORY_TOTAL_FEE: Rank by total fees paid (maker + taker + liquidation fees)
  - `window` string
  - `start_time` string, int64
  - `end_time` string, int64

## Other responses

- `default`: An unexpected error response.

---

[API](https://skmtc.dev/rise/apis/risex-rest-api.md) - [All operations](https://skmtc.dev/rise/apis/risex-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/rise/apis/risex-rest-api/revisions/98eabcd6a6ad?raw)
