HitBTC Symbols API

openapi: 3.2.0
info:
  title: Hitbtc Symbols API
  version: ''
  description: 'Operations tagged Symbols across 2 of this provider''s published API definitions: hitbtc-api-v3-spec.yaml, hitbtc-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/3
- url: https://api.hitbtc.com/api/3
  description: Production; the served spec declares the relative server /api/3 and the docs at api.hitbtc.com name this host
- url: https://api.demo.hitbtc.com/api/3
  description: Demo Environment (Sandbox), per api.hitbtc.com docs
tags:
- name: Symbols
paths:
  /public/symbol:
    get:
      tags:
      - Symbols
      summary: Get symbols
      parameters:
      - $ref: '#/components/parameters/marketData_Symbols'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/marketData_SpotSymbolMap'
                - $ref: '#/components/schemas/marketData_FuturesSymbolMap'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/marketData_InstrumentNotFound'
        '404':
          $ref: '#/components/responses/marketData_404'
      security: []
      description: '**Permission**: None


        **IP limit**: 30/50'
      operationId: getPublicSymbol
      x-operation-id-source: derived
    servers:
    - url: /api/3
  /public/symbol/{symbol}:
    get:
      tags:
      - Symbols
      summary: Get a symbol
      parameters:
      - $ref: '#/components/parameters/marketData_SymbolPath'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/marketData_SpotSymbol'
                - $ref: '#/components/schemas/marketData_FuturesSymbol'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/marketData_InstrumentNotFound'
        '404':
          $ref: '#/components/responses/marketData_404'
      security: []
      description: '**Permission**: None


        **IP limit**: 30/50'
      operationId: getPublicSymbolBySymbol
      x-operation-id-source: derived
    servers:
    - url: /api/3
components:
  responses:
    marketData_404:
      description: Not Found
      content:
        application/json:
          schema:
            type: object
            required:
            - timestamp
            - path
            - status
            - error
            - message
            - requestId
            properties:
              timestamp:
                type: string
                format: date-time
                description: Request timestamp.
                example: '2024-03-22T15:04:05.590Z'
              path:
                type: string
                description: Request path.
                example: /api/3/public/PATH
              status:
                type: integer
                description: Error status.
                example: 404
              error:
                type: string
                description: Error description.
                example: Not Found
              message:
                type: string
                nullable: true
                enum:
                - null
                description: Error message.
              requestId:
                type: string
                description: Request identifier.
                example: 0cdf39b4-28499640
  schemas:
    marketData_CashSettledFuturesSymbol:
      title: Cash settled
      allOf:
      - $ref: '#/components/schemas/marketData_FuturesSymbolBase'
      - type: object
        required:
        - expiry
        properties:
          expiry:
            type: string
            format: date-time
            nullable: true
            description: Futures expiration date.
            example: '2024-03-22T14:00:00.000Z'
    marketData_SymbolMarginFields:
      title: Margin symbol
      type: object
      properties:
        margin_trading:
          type: boolean
          description: Flag indicating whether the margin trading is available.
        max_initial_leverage:
          type: string
          description: 'The maximum leverage available to the user for margin trading.


            Conditions: `margin_trading` is `true`

            '
          example: '12.00'
    marketData_SymbolCommon:
      title: Symbol
      type: string
      description: Symbol code.
    marketData_SymbolBase:
      title: Symbol
      allOf:
      - $ref: '#/components/schemas/marketData_SymbolMarginFields'
      - type: object
        required:
        - type
        - quote_currency
        - status
        - quantity_increment
        - tick_size
        - fee_currency
        - make_rate
        - take_rate
        properties:
          type:
            allOf:
            - $ref: '#/components/schemas/marketData_SymbolTypeEnum'
            - $ref: '#/components/schemas/marketData_FuturesSymbolTypeEnum'
            description: Symbol type.
          quote_currency:
            type: string
            description: Quote currency.
            example: USDT
          status:
            allOf:
            - $ref: '#/components/schemas/marketData_SymbolStatus'
            - $ref: '#/components/schemas/marketData_FuturesSymbolStatus'
          quantity_increment:
            type: string
            description: Symbol quantity should be divided by this value with no remainder.
            example: '0.00001'
          tick_size:
            type: string
            description: Symbol price should be divided by this value with no remainder.
            example: '0.01'
          fee_currency:
            type: string
            description: Currency in which fees are denominated.
            example: USDT
          make_rate:
            type: string
            description: Maker fee rate.
            example: '0.001'
          take_rate:
            type: string
            description: Taker fee rate.
            example: '0.002'
    marketData_FuturesSymbolBase:
      title: Futures symbol
      allOf:
      - $ref: '#/components/schemas/marketData_SymbolBase'
      - type: object
        required:
        - contract_type
        - underlying
        properties:
          contract_type:
            type: string
            enum:
            - perpetual
            - cash_settled
            description: Contract type.
          underlying:
            type: string
            nullable: true
            description: Futures contract underlying asset.
            example: BTC
      - example:
          max_initial_leverage: '100.00'
    marketData_SpotSymbolMap:
      title: Spot symbols
      type: object
      additionalProperties:
        x-additionalPropertiesName: symbol
        $ref: '#/components/schemas/marketData_SpotSymbol'
      example:
        BTCUSDT:
          type: spot
          base_currency: BTC
          quote_currency: USDT
          status: working
          quantity_increment: '0.00001'
          tick_size: '0.01'
          take_rate: '0.0025'
          make_rate: '0.001'
          fee_currency: USDT
    marketData_SymbolStatus:
      title: Symbol status
      type: string
      enum:
      - working
      - suspended
      description: Exchange status.
    marketData_FuturesSymbolMap:
      title: Futures symbols
      type: object
      additionalProperties:
        x-additionalPropertiesName: symbol
        $ref: '#/components/schemas/marketData_FuturesSymbol'
      example:
        BTCUSDT_PERP:
          type: futures
          contract_type: perpetual
          expiry: null
          underlying: BTC
          base_currency: null
          quote_currency: USDT
          status: working
          quantity_increment: '0.00001'
          tick_size: '0.01'
          take_rate: '0.002'
          make_rate: '0.001'
          fee_currency: USDT
          margin_trading: true
          max_initial_leverage: '100.00'
    marketData_Error:
      type: object
      required:
      - timestamp
      - error
      - path
      - requestId
      properties:
        timestamp:
          type: string
          format: date-time
          description: Request timestamp.
        error:
          type: object
          required:
          - description
          - code
          - message
          properties:
            description:
              type: string
              description: Error description.
            code:
              type: integer
              format: int
              description: Error code.
            message:
              type: string
              description: Error description.
        path:
          type: string
          description: Request path.
        requestId:
          type: string
          description: Request identifier.
    marketData_FuturesSymbol:
      allOf:
      - type: object
      - title: Futures symbol
        discriminator:
          propertyName: contract_type
          mapping:
            perpetual: '#/components/schemas/marketData_PerpetualFuturesSymbol'
            cash_settled: '#/components/schemas/marketData_CashSettledFuturesSymbol'
        oneOf:
        - $ref: '#/components/schemas/marketData_PerpetualFuturesSymbol'
        - $ref: '#/components/schemas/marketData_CashSettledFuturesSymbol'
    marketData_SpotSymbol:
      title: Spot symbol
      allOf:
      - $ref: '#/components/schemas/marketData_SymbolBase'
      - type: object
        required:
        - base_currency
        properties:
          base_currency:
            type: string
            description: Base currency.
            example: BTC
    marketData_FuturesSymbolStatus:
      title: Futures symbol status
      type: string
      enum:
      - clearing
    marketData_InstrumentNotFound:
      title: Instrument not found
      $ref: '#/components/schemas/marketData_Error'
      type: object
      description: Provided currency or symbol not found.
      example:
        timestamp: '2024-03-22T15:04:05.590Z'
        error:
          description: Try get /public/INSTRUMENT, to get list of all available INSTRUMENT.
          code: 2002
          message: 'No such INSTRUMENT: PARAMETER'
        path: /api/3/public/PATH
        requestId: 0cdf39b4-28499640
    marketData_PerpetualFuturesSymbol:
      title: Perpetual
      allOf:
      - $ref: '#/components/schemas/marketData_FuturesSymbolBase'
      - type: object
        required:
        - expiry
        properties:
          expiry:
            type: string
            format: date-time
            nullable: true
            enum:
            - null
            description: Futures expiration date.
    marketData_SymbolTypeEnum:
      title: Symbol types
      type: string
      enum:
      - spot
    marketData_FuturesSymbolTypeEnum:
      title: Futures symbol types
      type: string
      enum:
      - futures
  parameters:
    marketData_Symbols:
      name: symbols
      in: query
      style: form
      explode: false
      schema:
        type: array
        items:
          $ref: '#/components/schemas/marketData_SymbolCommon'
      description: A comma-separated list of symbol codes.
    marketData_SymbolPath:
      name: symbol
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/marketData_SymbolCommon'
  securitySchemes:
    wallet_BasicAuth:
      type: http
      description: Provide a public key as the username and a secret key as the password.
      scheme: basic
    wallet_BearerAuth:
      type: http
      description: Provide a bearer token obtained from the authentication service.
      scheme: bearer
      bearerFormat: JWT
    trading_BasicAuth:
      type: http
      description: Provide a public key as the username and a secret key as the password.
      scheme: basic
    trading_BearerAuth:
      type: http
      description: Provide a bearer token obtained from the authentication service.
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- hitbtc-api-v3-spec.yaml
- hitbtc-openapi.yml