> ## 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 aggregated trading statistics for broker users (max 30-day period)



## OpenAPI

````yaml https://vooi-api-app.fly.dev/swagger/json get /broker/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/stats:
    get:
      tags:
        - Broker
      summary: Get aggregated trading statistics for broker users (max 30-day period)
      operationId: BrokerController_getStats
      parameters:
        - name: X-Broker-Key
          in: header
          description: Broker API key
          required: true
          schema:
            type: string
        - name: from
          required: true
          in: query
          schema:
            type: integer
            exclusiveMinimum: 0
            maximum: 9007199254740991
          description: Start of the period (Unix milliseconds, inclusive)
        - name: to
          required: true
          in: query
          schema:
            type: integer
            exclusiveMinimum: 0
            maximum: 9007199254740991
          description: End of the period (Unix milliseconds, exclusive)
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BrokerStatsDto'
components:
  schemas:
    BrokerStatsDto:
      type: object
      properties:
        aster:
          $ref: '#/components/schemas/BrokerStatsExchangeBreakdownDto'
        binance:
          $ref: '#/components/schemas/BrokerStatsExchangeBreakdownDto'
        bybit:
          $ref: '#/components/schemas/BrokerStatsExchangeBreakdownDto'
        extended:
          $ref: '#/components/schemas/BrokerStatsExchangeBreakdownDto'
        gate:
          $ref: '#/components/schemas/BrokerStatsExchangeBreakdownDto'
        hyperliquid:
          $ref: '#/components/schemas/BrokerStatsExchangeBreakdownDto'
        lighter:
          $ref: '#/components/schemas/BrokerStatsExchangeBreakdownDto'
        mexc:
          $ref: '#/components/schemas/BrokerStatsExchangeBreakdownDto'
        ondo:
          $ref: '#/components/schemas/BrokerStatsExchangeBreakdownDto'
        robinhood:
          $ref: '#/components/schemas/BrokerStatsExchangeBreakdownDto'
      required:
        - aster
        - binance
        - bybit
        - extended
        - gate
        - hyperliquid
        - lighter
        - mexc
        - ondo
        - robinhood
      title: BrokerStats
    BrokerStatsExchangeBreakdownDto:
      type: object
      properties:
        orderCount:
          type: integer
          minimum: 0
          maximum: 9007199254740991
          description: >-
            Distinct orders (trade.orderId) with at least one trade in the
            period on this exchange.
        uniqueTraders:
          type: integer
          minimum: 0
          maximum: 9007199254740991
          description: >-
            Distinct users with at least one trade in the period on this
            exchange.
        volumeUsd:
          type: string
          pattern: \d+(\.\d+)?
          description: >-
            Trade volume in USD on this exchange (sum of trade.size *
            trade.price across all trades in the period).
          example: '0.001'
      required:
        - orderCount
        - uniqueTraders
        - volumeUsd
      title: BrokerStatsExchangeBreakdown

````

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