> ## 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 executed notional volume



## OpenAPI

````yaml https://vooi-api-app.fly.dev/swagger/json get /broker/users/stats
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/stats:
    get:
      tags:
        - Broker
      summary: Get broker users ranked by executed notional volume
      operationId: BrokerController_getUsersStats
      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: >-
            Opaque pagination cursor returned from the previous page. When
            paginating, from, to, and limit must remain unchanged across
            requests.
        - name: from
          required: true
          in: query
          schema:
            type: integer
            exclusiveMinimum: 0
            maximum: 9007199254740991
          description: Start of time range (Unix milliseconds, inclusive)
        - name: limit
          required: false
          in: query
          schema:
            default: 50
            type: integer
            minimum: 1
            maximum: 50
          description: Number of items to return per page (1-50)
        - name: to
          required: true
          in: query
          schema:
            type: integer
            exclusiveMinimum: 0
            maximum: 9007199254740991
          description: End of time range (Unix milliseconds, exclusive)
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBrokerUsersStatsDTO'
components:
  schemas:
    GetBrokerUsersStatsDTO:
      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/BrokerUserStatsDto'
      required:
        - cursor
        - items
      title: BrokerUsersStats
    BrokerUserStatsDto:
      type: object
      properties:
        tradesCount:
          type: integer
          minimum: 0
          maximum: 9007199254740991
          description: Number of executed trades in the selected period
          example: 42
        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, summed from trades in the
            selected period
          example: '12345.67'
      required:
        - tradesCount
        - userId
        - volume
      title: BrokerUserStats

````

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