Binance General API

openapi: 3.2.0
info:
  title: Binance Spot Trading General API
  description: The Binance Spot Trading REST API provides programmatic access to the Binance spot exchange, the world's largest cryptocurrency trading platform by volume. Developers can place and manage orders, query account balances, retrieve real-time and historical market data, and manage trading pairs. The API supports limit, market, stop-loss, and other order types, along with account and trade history endpoints. Authentication uses HMAC SHA256 signed requests with API key and secret key credentials.
  version: '3'
  contact:
    name: Binance Support
    url: https://www.binance.com/en/support
  termsOfService: https://www.binance.com/en/terms
servers:
- url: https://api.binance.com
  description: Production Server
- url: https://api1.binance.com
  description: Production Server (Backup 1)
- url: https://api2.binance.com
  description: Production Server (Backup 2)
- url: https://api3.binance.com
  description: Production Server (Backup 3)
- url: https://api4.binance.com
  description: Production Server (Backup 4)
- url: https://testnet.binance.vision
  description: Testnet Server
security:
- apiKey: []
tags:
- name: General
  description: General endpoints for connectivity testing and exchange information.
paths:
  /api/v3/ping:
    get:
      operationId: testConnectivity
      summary: Test connectivity
      description: Test connectivity to the REST API. Returns an empty object on success.
      tags:
      - General
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
      security: []
  /api/v3/time:
    get:
      operationId: getServerTime
      summary: Check server time
      description: Test connectivity to the REST API and get the current server time as a Unix timestamp in milliseconds.
      tags:
      - General
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  serverTime:
                    type: integer
                    format: int64
                    description: Current server time in milliseconds since Unix epoch.
      security: []
  /api/v3/exchangeInfo:
    get:
      operationId: getExchangeInfo
      summary: Exchange information
      description: Get current exchange trading rules and symbol information, including available trading pairs, price filters, lot size filters, and order type constraints.
      tags:
      - General
      parameters:
      - $ref: '#/components/parameters/symbol'
      - name: symbols
        in: query
        description: JSON array of trading pair symbols to query. Cannot be used with the symbol parameter.
        schema:
          type: string
        example: '["BTCUSDT","ETHUSDT"]'
      - name: permissions
        in: query
        description: Filter by account permissions such as SPOT or MARGIN.
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExchangeInfo'
      security: []
components:
  schemas:
    RateLimit:
      type: object
      properties:
        rateLimitType:
          type: string
          enum:
          - REQUEST_WEIGHT
          - ORDERS
          - RAW_REQUESTS
          description: The type of rate limit.
        interval:
          type: string
          enum:
          - SECOND
          - MINUTE
          - DAY
          description: The interval unit.
        intervalNum:
          type: integer
          description: The interval number.
        limit:
          type: integer
          description: The maximum count within the interval.
    SymbolInfo:
      type: object
      properties:
        symbol:
          type: string
          description: Trading pair symbol.
        status:
          type: string
          description: Trading status of the symbol.
        baseAsset:
          type: string
          description: Base asset of the trading pair.
        baseAssetPrecision:
          type: integer
          description: Precision of the base asset.
        quoteAsset:
          type: string
          description: Quote asset of the trading pair.
        quotePrecision:
          type: integer
          description: Precision of the quote asset.
        orderTypes:
          type: array
          items:
            type: string
          description: Allowed order types for this symbol.
        icebergAllowed:
          type: boolean
          description: Whether iceberg orders are allowed.
        ocoAllowed:
          type: boolean
          description: Whether OCO orders are allowed.
        isSpotTradingAllowed:
          type: boolean
          description: Whether spot trading is allowed.
        isMarginTradingAllowed:
          type: boolean
          description: Whether margin trading is allowed.
        filters:
          type: array
          items:
            type: object
          description: Symbol-specific filters such as price filter, lot size, etc.
        permissions:
          type: array
          items:
            type: string
          description: Account permissions required to trade this symbol.
    ExchangeInfo:
      type: object
      properties:
        timezone:
          type: string
          description: Server timezone, always UTC.
        serverTime:
          type: integer
          format: int64
          description: Current server time in milliseconds.
        rateLimits:
          type: array
          items:
            $ref: '#/components/schemas/RateLimit'
          description: Rate limit rules for the exchange.
        exchangeFilters:
          type: array
          items:
            type: object
          description: Exchange-level filters.
        symbols:
          type: array
          items:
            $ref: '#/components/schemas/SymbolInfo'
          description: List of trading pair symbols and their rules.
  parameters:
    symbol:
      name: symbol
      in: query
      description: Trading pair symbol, e.g. BTCUSDT.
      schema:
        type: string
      example: BTCUSDT
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-MBX-APIKEY
      description: Binance API key passed in the X-MBX-APIKEY header.
    hmacSignature:
      type: apiKey
      in: query
      name: signature
      description: HMAC SHA256 signature of the query string using the API secret key. Required for SIGNED endpoints.
externalDocs:
  description: Binance Spot API Documentation
  url: https://developers.binance.com/docs/binance-spot-api-docs/rest-api