> ## Documentation Index
> Fetch the complete documentation index at: https://perps-api.vooi.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get broker users ranked by API-created order volume in USD, with pagination



## OpenAPI

````yaml https://vooi-api-app.fly.dev/swagger/json get /broker/users/top-volume
openapi: 3.1.0
info:
  title: VOOI API
  description: Unified perps API
  version: '1.0'
  contact: {}
servers:
  - url: https://perps-api.vooi.io
security: []
tags: []
paths:
  /broker/users/top-volume:
    get:
      tags:
        - Broker
      summary: >-
        Get broker users ranked by API-created order volume in USD, with
        pagination
      operationId: BrokerController_getTopVolumeUsers
      parameters:
        - name: X-Broker-Key
          in: header
          description: Broker API key
          required: true
          schema:
            type: string
        - name: cursor
          required: false
          in: query
          schema:
            type: string
          description: >-
            Pagination cursor returned from the previous page. Keep dateFrom,
            dateTo, exchanges, and limit unchanged across requests.
        - name: dateFrom
          required: false
          in: query
          schema:
            type: string
            format: date
            pattern: >-
              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          description: >-
            Start of the period as ISO date (e.g. "2026-01-01", inclusive).
            Defaults to 30 days before now. The range must not exceed 180 days.
        - name: dateTo
          required: false
          in: query
          schema:
            type: string
            format: date
            pattern: >-
              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
          description: >-
            End of the period as ISO date (e.g. "2026-01-31", inclusive).
            Defaults to today.
        - name: exchanges
          required: false
          in: query
          schema:
            anyOf:
              - type: string
                enum:
                  - aster
                  - binance
                  - bybit
                  - extended
                  - gate
                  - hyperliquid
                  - lighter
                  - mexc
                  - ondo
                  - robinhood
                description: Supported perpetual exchange
              - type: array
                items:
                  type: string
                  enum:
                    - aster
                    - binance
                    - bybit
                    - extended
                    - gate
                    - hyperliquid
                    - lighter
                    - mexc
                    - ondo
                    - robinhood
                  description: Supported perpetual exchange
          description: >-
            Filter by these exchanges (repeat the query param to pass several).
            When omitted, all supported exchanges are included.
        - name: limit
          required: false
          in: query
          schema:
            default: 100
            type: integer
            minimum: 1
            maximum: 1000
          description: Number of items to return per page (1-1000).
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrokerTopVolumeUsersDto'
components:
  schemas:
    BrokerTopVolumeUsersDto:
      type: object
      properties:
        cursor:
          description: >-
            Pass as cursor to fetch the next page. Null when no more pages
            exist.
          type:
            - string
            - 'null'
        items:
          type: array
          items:
            $ref: '#/components/schemas/BrokerTopVolumeUserDto'
      required:
        - cursor
        - items
      title: BrokerTopVolumeUsers
    BrokerTopVolumeUserDto:
      type: object
      properties:
        userId:
          type: string
          format: uuid
          pattern: >-
            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
          description: User id
        volume:
          type: string
          description: >-
            Total executed notional in quote currency from API-created orders in
            the selected period.
          example: '12345.67'
      required:
        - userId
        - volume
      title: BrokerTopVolumeUser

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.