BigONE Trades API

openapi: 3.2.0
info:
  title: Bigone Trades API
  version: 1.0.0
  contact:
    email: developer@big.one
  description: 'Operations tagged Trades across 2 of this provider''s published API definitions: convert_rest.yml, bigone-convert-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.big.one/sapi/v1/convert
tags:
- name: Trades
  description: Execute and manage trades
paths:
  /viewer/trade:
    post:
      tags:
      - Trades
      summary: Create Convert Trade
      description: Execute a conversion trade using a previously obtained quote. The quote must not have expired.
      operationId: createConvertTrade
      security:
      - bearerAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTradeRequest'
      responses:
        '200':
          description: Trade created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConvertTrade'
        '400':
          description: Invalid parameters or convert error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                parameter_error:
                  value:
                    code: 10007
                    message: Parameter error
                asset_not_supported:
                  value:
                    code: 54046
                    message: Convert asset not supported
                price_expired:
                  value:
                    code: 54047
                    message: Convert price expired
                param_inconsistent:
                  value:
                    code: 54048
                    message: Convert parameter inconsistent
                amount_too_small:
                  value:
                    code: 54050
                    message: Convert amount too small
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Permission denied or system busy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                permission_denied:
                  value:
                    code: 10403
                    message: Permission denied
                system_busy:
                  value:
                    code: 54053
                    message: Convert system busy
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalError'
    get:
      tags:
      - Trades
      summary: Get Convert Trade Detail
      description: Get details of a specific conversion trade by ID or quote ID. Either id or quote_id is required.
      operationId: getConvertTradeDetail
      security:
      - bearerAuth: []
      parameters:
      - in: query
        name: id
        schema:
          type: integer
        description: Trade ID (Either id or quote_id is required)
      - in: query
        name: quote_id
        schema:
          type: string
        description: Quote ID (Either id or quote_id is required)
      responses:
        '200':
          description: Trade details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConvertTrade'
    servers:
    - url: https://api.big.one/sapi/v1/convert
  /viewer/trades:
    get:
      tags:
      - Trades
      summary: Get Convert Trades
      description: Get the authenticated user's conversion trade history, ordered by creation time (newest first).
      operationId: getConvertTrades
      security:
      - bearerAuth: []
      parameters:
      - in: query
        name: page_token
        schema:
          type: string
        description: Pagination token obtained from the previous response. Use to retrieve the next page.
      - in: query
        name: limit
        schema:
          type: integer
          default: 20
          minimum: 1
          maximum: 200
        description: The maximum number of trades to return per page.
      responses:
        '200':
          description: List of trades
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ConvertTrade'
    servers:
    - url: https://api.big.one/sapi/v1/convert
components:
  responses:
    TooManyRequests:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: 10429
            message: Too many requests
    Unauthorized:
      description: Authentication failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: 40004
            message: Unauthorized
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: 10005
            message: Internal error
  schemas:
    CreateTradeRequest:
      type: object
      required:
      - quote_id
      description: Request to execute a conversion trade using a previously obtained quote.
      properties:
        quote_id:
          type: string
          description: The quote ID from the Get Convert Quote endpoint. The quote must not have expired.
          example: 97611740-1ae5-4989-812d-2cb1566fd0f3
        account_type:
          type: string
          description: The account type to use for the conversion. Default is FUND.
          enum:
          - FUND
          - SPOT
          - ALL
          example: FUND
    ConvertTrade:
      type: object
      description: A completed or pending conversion trade.
      properties:
        id:
          type: integer
          description: The unique trade ID.
          format: int64
          example: 12345
        quote_id:
          type: string
          description: The quote ID used for this trade.
          example: 97611740-1ae5-4989-812d-2cb1566fd0f3
        from_asset:
          type: string
          description: The source asset symbol.
          example: USDT
        to_asset:
          type: string
          description: The destination asset symbol.
          example: BTC
        from_sz:
          type: string
          description: The amount converted from.
          example: '333'
        to_sz:
          type: string
          description: The amount received.
          example: '0.00320533'
        px:
          type: string
          description: The execution price.
          example: '0.00000962'
        ts:
          type: integer
          format: int64
          description: The timestamp when the trade was executed (Unix milliseconds).
          example: 1705312800000
        state:
          type: string
          description: The current state of the conversion trade.
          enum:
          - PENDING
          - PROCESSING
          - SUCCEEDED
          - FAILED
          example: SUCCEEDED
        acct_typ:
          type: string
          enum:
          - FUND
          - SPOT
          description: The account type used for the trade.
          example: FUND
    Error:
      type: object
      properties:
        code:
          type: integer
          description: Error code
          example: 10007
        message:
          type: string
          description: Error message
          example: Parameter error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-refined-from:
- convert_rest.yml
- bigone-convert-openapi.yml