openapi: 3.0.3
info:
  title: Synthetix escrowed-balance stats API
  description: Synthetix API documentation
  version: 1.0.0
servers:
- url: https://api.synthetix.io
  description: Production
tags:
- name: stats
paths:
  /stats/perps-volume:
    get:
      tags:
      - stats
      description: Returns total volume figures across all perps deployments.
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  timestamp:
                    type: string
                    format: date-time
                    example: '2024-05-23T14:00:00.000Z'
                  volume_7d:
                    type: number
                    example: 123456789.12345679
                  volume_24h:
                    type: number
                    example: 12345678.12345679
        '401':
          description: Unauthorized.
        '403':
          description: You have been banned by WAF.
        '429':
          description: Too many requests, you're being rate-limited.
        5XX:
          description: Service unavailable.
        default:
          description: Unexpected error.