BigONE Deposit API

openapi: 3.2.0
info:
  title: Bigone Deposit API
  version: 1.0.0
  contact:
    email: developer@big.one
  description: 'Operations tagged Deposit across 2 of this provider''s published API definitions: wallet_rest.yml, bigone-wallet-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.big.one/api/v3
tags:
- name: Deposit
  description: Wallet Deposits
paths:
  /viewer/deposits:
    get:
      tags:
      - Deposit
      summary: Get User Deposit History
      description: Returns a paginated list of the authenticated user's deposit history, ordered by creation time (newest first).
      operationId: getDeposits
      parameters:
      - in: query
        name: asset_symbol
        description: The asset symbol to filter by (e.g., BTC, EOS). Optional.
        required: false
        schema:
          type: string
        example: BTC
      - in: query
        name: kind
        description: The deposit type to filter by (e.g., "on_chain", "internal", "off_chain"). Optional.
        required: false
        schema:
          type: string
        example: on_chain
      - in: query
        name: txid
        description: The blockchain transaction ID to filter by. Optional.
        required: false
        schema:
          type: string
        example: 513b80e5619155b24fbf0412d59f6256f86b0d69
      - in: query
        name: page_token
        description: Pagination token obtained from the previous response. Use to retrieve the next page.
        required: false
        schema:
          type: string
        example: eyJvZmZzZXQiOjEwMCwia2luZCI6IlRSQU5TRkVSIn0=
      responses:
        '200':
          description: List of deposits
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Deposit'
      security:
      - bearerAuth:
        - view deposit history
    servers:
    - url: https://api.big.one/api/v3
  /viewer/assets/{asset_symbol}/address:
    get:
      tags:
      - Deposit
      summary: Get Deposit Address
      description: Returns the deposit address for a specific asset. Required **wallet:read** scope.
      operationId: getDepositAddress
      parameters:
      - in: path
        name: asset_symbol
        required: true
        description: The symbol of the asset.
        schema:
          type: string
        example: BTC
      responses:
        '200':
          description: Deposit address list
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DepositAddress'
      security:
      - bearerAuth:
        - view deposit address
    servers:
    - url: https://api.big.one/api/v3
components:
  schemas:
    DepositAddress:
      type: object
      description: A deposit address for receiving assets on a specific chain.
      properties:
        id:
          type: integer
          description: The unique address identifier.
          format: int64
          example: 1
        chain:
          type: string
          description: The chain/network name (e.g., BTC, Ethereum, Tron).
          example: BTC
        value:
          type: string
          description: The deposit address value.
          example: 1EVzaFkkNNXq6RJh2oywwJMn8JPiq8ikDi
        memo:
          type:
          - string
          - 'null'
          description: The memo or tag for the deposit address (if required by the asset, e.g., EOS, XRP).
          example: '123456'
    Deposit:
      type: object
      description: Deposit record details.
      properties:
        id:
          type: integer
          description: The unique deposit ID.
          format: int64
          example: 6
        amount:
          type: string
          description: The deposit amount.
          example: '14.0'
        confirms:
          type: integer
          description: The number of blockchain confirmations received.
          format: int64
          example: 100
        txid:
          type:
          - string
          - 'null'
          description: The blockchain transaction ID. Null for internal transfers.
          example: 513b80e5619155b24fbf0412d59f6256f86b0d69
        is_internal:
          type: boolean
          description: Whether this is an internal transfer (from another BigONE user).
          example: false
        inserted_at:
          type: string
          description: The timestamp when the deposit was recorded (ISO 8601).
          format: date-time
          example: '2018-02-14T11:23:54.000Z'
        updated_at:
          type: string
          description: The timestamp when the deposit was last updated (ISO 8601).
          format: date-time
          example: '2018-09-21T08:28:57.000Z'
        kind:
          type: string
          description: The deposit type (e.g., "on_chain", "internal", "off_chain").
          example: on_chain
        memo:
          type:
          - string
          - 'null'
          description: The memo or tag associated with the deposit (if applicable).
          example: '123456'
        state:
          type: string
          description: The current deposit state.
          enum:
          - PENDING
          - WITHHOLD
          - CANCELLED
          - COMPLETED
          example: WITHHOLD
        asset_symbol:
          type: string
          description: The asset symbol (e.g., BTC, EOS).
          example: BTS
        target_account:
          type: string
          enum:
          - SPOT
          - FUND
          description: The account that received the deposit.
          example: FUND
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- wallet_rest.yml
- bigone-wallet-openapi.yml