HitBTC Amount Locks API

openapi: 3.2.0
info:
  title: Hitbtc Amount Locks API
  version: ''
  description: 'Operations tagged Amount Locks 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: Amount Locks
paths:
  /wallet/amount-locks:
    get:
      tags:
      - Amount Locks
      summary: Get amount locks
      description: '⚠️ Balance that can be withdrawn depends on the sum of amounts locks across all currencies.


        ℹ️ Locked amount is not visible as a fraction of reserved balance.


        **Permission**: Withdraw cryptocurrencies


        **IP limit**: 10/10


        **Account limit**: 20/30'
      parameters:
      - $ref: '#/components/parameters/wallet_Currency'
      - name: active
        in: query
        schema:
          type: boolean
        description: Flag indicating whether returned locks are active.
      - name: limit
        in: query
        required: true
        schema:
          maximum: 1000
          minimum: 1
          type: integer
          format: int
          default: 100
        description: The number of items to return.
      - name: offset
        in: query
        schema:
          type: integer
          default: 0
          minimum: 0
        description: The number of items to skip before starting to collect the result set.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/wallet_AmountLock'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/wallet_Validation'
        '401':
          $ref: '#/components/responses/wallet_401'
        '403':
          $ref: '#/components/responses/wallet_403'
        '408':
          $ref: '#/components/responses/wallet_408'
        '429':
          $ref: '#/components/responses/wallet_429'
        '500':
          $ref: '#/components/responses/wallet_500'
        '502':
          $ref: '#/components/responses/wallet_502'
        default:
          $ref: '#/components/responses/wallet_Error'
      security:
      - wallet_BearerAuth: []
      - wallet_BasicAuth: []
      operationId: getWalletAmountLocks
      x-operation-id-source: derived
    servers:
    - url: /api/3
components:
  schemas:
    wallet_NotEnoughPermissions:
      title: Not enough permissions
      schema:
        $ref: '#/components/schemas/wallet_Error'
      type: object
      description: Current permission scope in the authentication service is insufficient.
      example:
        error:
          code: 1007
          message: Not enough permissions
    wallet_ShouldUpgradePermission:
      title: Should upgrade permission
      schema:
        $ref: '#/components/schemas/wallet_Error'
      type: object
      description: Current permission scope in the authentication service is insufficient.
      example:
        error:
          code: 1006
          message: Action unavailable, please upgrade scopes
    wallet_BadFormatHS256:
      title: Bad format (HS256)
      schema:
        $ref: '#/components/schemas/wallet_Error'
      type: object
      description: "Any of:\n  * missing required parameters;\n  * the maximum of the time window is exceeded.\n"
      example:
        error:
          code: 1004
          message: Unsupported authorization method
    wallet_AuthInvalid:
      title: Invalid authorization
      schema:
        $ref: '#/components/schemas/wallet_Error'
      type: object
      description: Invalid JWT.
      example:
        error:
          code: 1005
          message: Invalid authorization
    wallet_TooManyRequests:
      title: Too Many Requests
      schema:
        $ref: '#/components/schemas/wallet_Error'
      type: object
      description: Rate limits are exceeded.
      example:
        error:
          code: 429
          message: Too many requests
    wallet_AmountLock:
      title: Amount lock
      allOf:
      - $ref: '#/components/schemas/wallet_Currency'
      - $ref: '#/components/schemas/wallet_CreatedAt'
      - type: object
        required:
        - id
        - currency
        - amount
        - date_end
        - description
        - canceled
        - canceled_at
        - cancel_description
        - created_at
        properties:
          id:
            type: integer
            format: uint64
            description: Amount lock identifier.
            example: 1
          amount:
            type: string
            description: Locked amount in USD.
            example: '2.37'
          date_end:
            type: string
            description: The date and time of the lock expiration.
            example: ''
          description:
            type: string
            description: Text description.
            example: Lorem ipsum dolor sit amet consectetur adipiscing elit...
          canceled:
            type: boolean
            description: Flag indicating whether the amount lock was canceled.
            example: false
          canceled_at:
            type: string
            nullable: true
            format: date-time
            description: Date and time of the lock cancellation.
            example: null
          cancel_description:
            type: string
            nullable: true
            description: Text description on cancellation.
            example: null
    wallet_Validation:
      title: Validation
      schema:
        $ref: '#/components/schemas/wallet_Error'
      type: object
      description: "Any of:\n  * invalid JSON payload;\n  * invalid form payload;\n  * invalid payload format;\n  * invalid parameter value;\n  * invalid parameter format;\n  * specified parameters are mutually exclusive;\n  * a required parameter is missing;\n  * the value of a parameter is invalid;\n  * provided value is not unique;\n  * in an update request, no parameters provided.\n"
      example:
        error:
          code: 10001
          message: Validation error
    wallet_UnauthorizedBasic:
      title: Unauthorized (Basic)
      schema:
        $ref: '#/components/schemas/wallet_Error'
      type: object
      description: "Any of:\n  * invalid API key;\n  * user is not allowed to perform the requested operation.\n"
      example:
        error:
          code: 1002
          message: Authorization is required or has been failed
    wallet_Currency:
      title: Currency
      properties:
        currency:
          $ref: '#/components/schemas/wallet_CurrencyCommon'
    wallet_RequestTimeout:
      title: Request Timeout
      schema:
        $ref: '#/components/schemas/wallet_Error'
      type: object
      description: The request has been canceled.
      example:
        error:
          code: 408
          message: Request timeout
    wallet_BadGateway:
      title: Bad Gateway
      schema:
        $ref: '#/components/schemas/wallet_Error'
      type: object
      description: Unclassified error while connecting the authentication service.
      example:
        error:
          code: 502
          message: Bad gateway
    wallet_Forbidden:
      title: Forbidden
      schema:
        $ref: '#/components/schemas/wallet_Error'
      type: object
      description: "Any of:\n  * currency settings forbid the requested operation;\n  * the user has insufficient permissions for the operation;\n  * requested operation is forbidden for the user;\n  * insufficient API key permissions;\n  * provided IP address is not in the white list;\n  * the user is not eligible for the given currency by the configuration;\n  * provided operation parameters are forbidden by the configuration;\n  * a withdrawal operation failed to pass pre-AML checks.\n"
      example:
        error:
          code: 1003
          message: Action is forbidden for this API key
    wallet_CurrencyCommon:
      title: Cryptocurrency
      type: string
      description: Cryptocurrency code.
      example: USDT
    wallet_CreatedAt:
      title: Created at
      type: object
      properties:
        created_at:
          type: string
          format: date-time
          description: Date and time of the creation.
          example: 2024-03-22 15:04:05Z07:00
    wallet_Error:
      title: Error
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: integer
              format: int
              description: Custom error code.
            message:
              type: string
              description: Error message.
            description:
              type: string
              description: Error description.
    wallet_BadFormat:
      title: Bad Format
      schema:
        $ref: '#/components/schemas/wallet_Error'
      type: object
      description: Provided parameters do not meet any supported authentication scheme.
      example:
        error:
          code: 1004
          message: Unsupported authorization method
    wallet_Internal:
      title: Internal Server Error
      schema:
        $ref: '#/components/schemas/wallet_Error'
      type: object
      description: "Internal error.\n\nAny of:\n  * unclassified internal error;\n  * user bank account is blocked;\n  * transaction(s) for the requested operation have not been created;\n  * transaction(s) for the requested operation have been rolled back.\n"
      example:
        error:
          code: 500
          message: Internal Server Error
    wallet_UnauthorizedHS256:
      title: Unauthorized (HS256)
      schema:
        $ref: '#/components/schemas/wallet_Error'
      type: object
      description: "Any of:\n  * invalid API key;\n  * invalid time window value;\n  * invalid HMAC signature format.\n"
      example:
        error:
          code: 1002
          message: Authorization is required or has been failed
  responses:
    wallet_Error:
      description: ''
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/wallet_Error'
    wallet_408:
      description: Request Timeout
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/wallet_RequestTimeout'
    wallet_429:
      description: Too Many Requests
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/wallet_TooManyRequests'
    wallet_500:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/wallet_Internal'
    wallet_502:
      description: Bad Gateway
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/wallet_BadGateway'
    wallet_403:
      description: Forbidden
      content:
        application/json:
          schema:
            oneOf:
            - $ref: '#/components/schemas/wallet_Forbidden'
            - $ref: '#/components/schemas/wallet_ShouldUpgradePermission'
            - $ref: '#/components/schemas/wallet_NotEnoughPermissions'
    wallet_401:
      description: Unauthorized
      content:
        application/json:
          schema:
            oneOf:
            - $ref: '#/components/schemas/wallet_UnauthorizedBasic'
            - $ref: '#/components/schemas/wallet_UnauthorizedHS256'
            - $ref: '#/components/schemas/wallet_BadFormatHS256'
            - $ref: '#/components/schemas/wallet_AuthInvalid'
            - $ref: '#/components/schemas/wallet_BadFormat'
  parameters:
    wallet_Currency:
      name: currency
      in: query
      required: true
      schema:
        $ref: '#/components/schemas/wallet_CurrencyCommon'
  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