Bullish Deprecated Features and APIs

A separately published OpenAPI document carrying the 15 operations Bullish has deprecated or decommissioned — the v1 order create/cancel/get surface, v1 AMM instructions, v1 spot account reads and the v1 asset-transfer command — tagged "deprecated - q3 2024", "deprecated" and "decommissioned" so integrators can see exactly what is on the way out.

OpenAPI Specification

bullish-deprecated-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  description: "# Overview\n\nWelcome to the _Bullish Deprecated Features & APIs_ documentation!\n\nThis documentation provides a list of Features and APIs that have been marked as deprecated, and will be decommissioned soon.\nYou will still be able to use these Features or APIs till the stated decommission date. \n\n## Additional Links\n\n- API documentations - [Trading API Documentation](/rest/introduction)\n\n## Deprecated Features\nList of Features that are marked for deprecation.\n\n## Bullish Key\n`Decommissioned`: *Creation of Bullish API key has been suspended as of `29 March, 2024`*\n\n`Deprecated`: *Existing Bullish API key will no longer be usable as of `28 June, 2024`*\n- A Bullish API key is a public/private key pair used for ECDSA based signing of trading and custody API requests\n- From here on the:\n  - public key will be referred to as `PUBLIC_KEY`\n  - private key will be referred to as `PRIVATE_KEY`\n- For information about the format of keys please review EOS Wallet Specification\n- Always store your private keys in a secure medium as they are used to sign your requests. Do not share your private keys in any publicly accessible areas such as code repositories, client side code, or other vulnerable areas and make sure the keys are not shipped with your mobile or web apps.\n\nA Bullish API key additionally has a `metadata` string associated with it which is displayed along side the key.\nYou must base64 decode the `metadata` to extract your `userId` (example follows). You will need the `userId` in the next step.\nPlease note that the `accountId` field is deprecated, and will be removed along with `v1/users/login` API towards the end of Q4 2023. Clients should reference the `userId` field instead.\nOld `metadata` strings generated before the March 2023 upgrade will not contain the `userId` field; clients are advised to get the `metadata` from the Settings page on the UI again.\n\n```shell\necho eyJwdWJsaWNLZXkiOiJQVUJfUjFfNWNpVW52TW5rVThMOVBCWnZaa1BGcjhqdkRnUHpzcHhWNGlqOThIN1JqM1FSNzJyMkEiLCJhY2NvdW50SWQiOjIyMjAwMDAwMDAwMDAwNCwiY3JlZGVudGlhbElkIjoiMTAifQ== | base64 --decode\n{\"publicKey\":\"PUB_R1_5ciUnvMnkU8L9PBZvZkPFr8jvDgPzspxV4ij98H7Rj3QR72r2A\",\"userId\":\"12345\",\"accountId\":\"12345\",\"credentialId\":\"10\"}\n```\n\n## Signing Format (Old)\n\n`Deprecated`: *Please use the new [Signing Format](/rest/authentication#signing-format)*\n\nBefore signing the `<COMMAND>` string remove any spaces and newline characters.\n\nThe resulting value is also referred to as the request signature. Each component of the signature is detailed below:\n  - `<TIMESTAMP>`: number of milliseconds since EPOCH\n  - `<NONCE>`: client side incremented 64-bit unsigned integer\n  - `<AUTHORIZER>`: JWT authorizer you obtain along with the [JWT token](/rest/authentication#add-authenticated-request-header)\n  - `<COMMAND>`: the command which is sent in the request payload, JSON encoded\n\n### How To Sign - Bullish API Key\n\nTo obtain the signature:\n\n1. Encode the request JSON payload, also referred to as body, with the SHA-256 hash function and take the hexdigest\n2. Sign the hexdigest from step 1 with ECDSA P-256 using your `<PRIVATE_KEY>`\n3. Various signing examples can be found on [GitHub](https://github.com/bullish-exchange)\n\n### How To Sign - HMAC API Key\n\nTo obtain the signature:\n\n1. Encode the request JSON payload, also referred to as body, with the SHA-256 hash function and take the hexdigest\n2. Sign the hexdigest from step 1 with your HMAC Secret Key.\n\nSee sign a request with HMAC for a sample Python script.\n\n## Hybrid Order Book WebSocket (unauthenticated)\n`Deprecated`: *Please use the [unauthenticated multi-order book WebSocket](/websocket/public/market-data/orderbook).*\n\n**Route**\n- `/markets/{symbol}/orderbook/hybrid`\n- `/v2/market-data/orderbook/hybrid/{symbol}?depth={depth}&aggregationFactor={aggregationFactor}`\n\n**Additional notes**: \n- Allowable depths - `[ 10, 50, 100, 200 ]`.\n- Allowable aggregation factors - `[ 1, 5, 10 ]`.\n- This endpoint does not require subscriptions.\n\nOn connection, the client receives a snapshot of the current hybrid order book with default depth of 10 (unless specified otherwise).\nSubsequently, if the order book moves, the client then receives a conflated update of the hybrid order book periodically \nat 300ms with standard ingress and at 100ms with Cloudflare bypass. If there is a sequence number mismatch between the \nconflated update and the snapshot, the server disconnects the client with the following error message - \n`4003 (Try Again, sequence number miss-match between snapshot and updates)`.\n\n### l2Snapshot response\n\n| Name                    | Type   | Description                                                                                                                                                                                                              |\n|---------------------    |--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| symbol                  | String | market symbol                                                                                                                                                                                                            |\n| bids                    | Array  | array of size 20 (default unless specified otherwise by the `depth` parameter) where even indices denote price, odd indices denote absolute quantities                                                                   |\n| asks                    | Array  | array of size 20 (default unless specified otherwise by the `depth` parameter) where even indices denote price, odd indices denote absolute quantities                                                                   |\n| sequenceNumberRange     | Array  | array of size 2 where first element denotes lower bound, second element denotes upper bound of sequence numbers <br /> lower and upper bound are equal for initial snapshot; this may differ for subsequent snapshots    |\n| datetime                | String | denotes the time the update was created by the engine, ISO 8601 with millisecond as string                                                                                                                               |\n| timestamp               | String | denotes the time the update was created by the engine                                                                                                                                                                    |\n| publishedAtTimestamp    | String | denotes the time the update was broadcasted to connected WebSockets                                                                                                                                                      |\n\n```json\n{\n  \"type\": \"snapshot\",\n  \"dataType\": \"V1TALevel2\",\n  \"data\": {\n    \"symbol\": \"BTCUSD\",\n    \"bids\": [\n      \"5199.5000\",\n      \"110.92467647\",\n      \"5199.4000\",\n      \"20.92470365\",\n      \"5199.3000\",\n      \"0.92473034\",\n      \"5199.2000\",\n      \"0.92475701\",\n      \"5199.1000\",\n      \"0.92478369\",\n      \"5199.0000\",\n      \"0.92481038\",\n      \"5198.9000\",\n      \"0.92483705\",\n      \"5198.8000\",\n      \"0.92486375\",\n      \"5198.7000\",\n      \"0.92489042\",\n      \"5198.6000\",\n      \"0.92491712\"\n    ],\n    \"asks\": [\n      \"5199.6000\",\n      \"96.37848193\",\n      \"5199.7000\",\n      \"0.92465082\",\n      \"5199.8000\",\n      \"11.04464563\",\n      \"5199.9000\",\n      \"0.92459696\",\n      \"5200.0000\",\n      \"0.92457029\",\n      \"5200.1000\",\n      \"0.92454362\",\n      \"5200.2000\",\n      \"0.92451695\",\n      \"5200.3000\",\n      \"0.92449028\",\n      \"5200.4000\",\n      \"0.92446361\",\n      \"5200.5000\",\n      \"0.92443695\"\n    ],\n    \"sequenceNumberRange\": [6, 6],\n    \"datetime\": \"2020-05-13T10:23:46.000Z\",\n    \"timestamp\": \"1589365426000\",\n    \"publishedAtTimestamp\": \"1589365426100\"\n  }\n}\n```\n\n\n### l2Update response\n\n| Name                  | Type   | Description                                                                                                                                                |\n|---------------------  |--------|------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| symbol                | String | market symbol                                                                                                                                              |\n| bids                  | Array  | even indices denote price, odd indices denote absolute quantities                                                                                          |\n| asks                  | Array  | even indices denote price, odd indices denote absolute quantities                                                                                          |\n| sequenceNumberRange   | Array  | array of size 2 where first element denotes lower bound, second element denotes upper <br /> bound of sequence numbers represented by the conflated update |\n| datetime              | String | denotes the time the update was created by the engine, ISO 8601 with millisecond as string                                                                 |\n| timestamp             | String | denotes the time the update was created by the engine                                                                                                      |\n| publishedAtTimestamp  | String | denotes the time the update was broadcasted to connected WebSockets                                                                                        |\n\n```json\n{\n  \"type\": \"update\",\n  \"dataType\": \"V1TALevel2\",\n  \"data\": {\n    \"symbol\": \"BTCUSD\",\n    \"bids\": [],\n    \"asks\": [\"5199.7000\", \"101.30313224\"],\n    \"sequenceNumberRange\": [7, 10],\n    \"datetime\": \"2020-06-29T06:28:55.500Z\",\n    \"timestamp\": \"1593412135500\",\n    \"publishedAtTimestamp\": \"1593412135600\"\n  }\n}\n```\n\n### Maintaining Hybrid Order Book\n1. Connect to hybrid order book WebSocket API.\n2. Receive initial snapshot message.\n3. Record sequence number and create order book.\n4. Compare current sequence number with that of new message. If sequence number is out of order, reconnect.\n5. Receive update messages of price levels with new absolute quantity and update order book.\n   If quantity is 0, price level is removed.\n6. Receive a subsequent snapshot message and reset existing order book. Create order book with new price levels.\n\nSee connect to hybrid order book WebSocket for a sample Python script.\n\n## Market Data WebSocket (authenticated)\n`Deprecated`: *Please use the [unauthenticated multi-order book WebSocket](/websocket/public/market-data/orderbook).*\n\nRoute\n- `/v1/market-data`\n| Topic         |  Description                              | Data Type        | Subscription Type           |\n|:--------------|:------------------------------------------|:-----------------|:----------------------------|\n| l1Orderbook   | Provides updates for Level 1 market data  | `V1TABookLevel1` | By `<TOPIC>` and `<SYMBOL>` |\n### l1Orderbook response\n- Level 1 market data updates are realtime.\n- If the `sequenceNumber` of an incoming update is smaller than that of a previously received update, then the\n`sequenceNumber` is out of order. Terminate the WebSocket connection and reconnect.\n| Name           | Type   | Description                                                                          |\n|:---------------|:-------|:-----------------------------------------------------------------                    |\n| sequenceNumber | String | incrementing, unique, unsigned integer that identifies a state of the L1 order book   |\n| symbol         | String | market symbol                                                                        |\n| timestamp      | String | denotes the time the update was created                                              |\n| bid            | Array  | nested array containing price and quantity of highest bid                            |\n| ask            | Array  | nested array containing price and quantity of lowest ask                             |\n```json\n{\n  \"type\": \"update\",\n  \"dataType\": \"V1TABookLevel1\",\n  \"data\": {\n    \"sequenceNumber\": \"1\",\n    \"symbol\": \"BTCUSD\",\n    \"timestamp\": \"1466812800000\",\n    \"bid\": [ [ \"35.0000\", \"2.00000000\" ] ],\n    \"ask\": [ [ \"35.5000\", \"1.00000000\" ] ]\n  }\n}\n```\nSee connect to market data WebSocket for a sample Python script.\n\n## Spot Account\n`Deprecated`: *Spot Account will be replaced by `Asset Account` which provides a more granular view of the assets in your trading account*\n\n- REST Endpoints [(Get Spot Accounts)](/rest/deprecated/user-get-spot-accounts)\n  - REST - `GET /accounts/spot` replaced by REST - [GET /accounts/asset](/rest/api/get-asset-accounts)\n  - REST - `GET /accounts/spot/{symbol}` replaced by REST - [GET `/accounts/asset/{symbol}`](/rest/api/get-asset-account-by-symbol)\n\n- [Private Data WebSocket (Authenticated)](/websocket/private/private-data)\n  - Topic: `spotAccounts` replaced by `assetAccounts`\n  - Response: `V1TASpotAccount` replaced by `V1TAAssetAccount`\n### spotAccounts response\n\nThe *Formula* colummn below shows how the fields in `V1TASpotAccount` are calculated.\n\n| Name                 | Type   | Description                                                                                                                                                                         |  Formula <br /> (expressed in `assetAccounts` response fields)      |\n|:---------------------|:-------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------|\n| accountId            | String | unique spot account ID                                                                                                                                                              |                                                                     |\n| symbol               | String | asset symbol                                                                                                                                                                        |                                                                     |\n| type                 | String | type of account                                                                                                                                                                     |                                                                     |\n| total                | String | total is `free` + `used` assets within the account, see [asset value](/rest/general/price-quantity-precision) format                                             |   =max(0, availableQuantity - borrowedQuantity) + lockedQuantity    |\n| free                 | String | refers to the assets that are available to use on the account excluding borrowed assets, see [asset value](/rest/general/price-quantity-precision) format.       |   =max(0, availableQuantity - borrowedQuantity)                     |\n| used                 | String | refers to the assets that are locked in orders, see [asset value](/rest/general/price-quantity-precision) format                                                 |   =lockedQuantity                                                   |\n| updatedAtDatetime    | String | denotes the time the spot account was updated by the exchange, ISO 8601 with millisecond as string                                                                                  |                                                                     |\n| updatedAtTimestamp   | String | denotes the time the spot account was updated by the exchange                                                                                                                       |                                                                     |\n| publishedAtTimestamp | String | denotes the time the update was broadcasted to connected WebSockets                                                                                                                 |                                                                     |\n\n\n```json\n{\n  \"tradingAccountId\": \"1111\",\n  \"type\": \"snapshot\",\n  \"dataType\": \"V1TASpotAccount\",\n  \"data\": [\n    {\n      \"accountId\": \"1\",\n      \"type\": \"spot\",\n      \"symbol\": \"BTC\",\n      \"total\": \"4.00000000\",\n      \"free\": \"4.00000000\",\n      \"used\": \"0.00000000\",\n      \"updatedAtDatetime\": \"2021-12-30T07:36:35.918Z\",\n      \"updatedAtTimestamp\": \"1640849795918\",\n      \"publishedAtTimestamp\": \"1640849795920\"\n    }\n  ]\n}\n```\n\n## Anonymous Trades WebSocket (unauthenticated)\n**Route**\n- `/v1/market-data/trades/{symbol}`\n\n**Note**: This endpoint does not require subscriptions.\n\nOn connection, the client receives a snapshot of the latest 100 trades, in descending order. Subsequently,\nthe client receives real-time updates of trades that have been executed. If the `tradeId` of an incoming update is \nsmaller than that of a previously received update, then the `tradeId` is out of order. Terminate the\nWebSocket connection and reconnect.\n\n### Trades response\n\n| Name                 | Type      | Description                                                                               |\n|:---------------------|:----------|:------------------------------------------------------------------------------------------|\n| tradeId              | String    | unique trade ID                                                                           |\n| symbol               | String    | market symbol                                                                             |\n| price                | String    | price, see [asset value](/rest/general/price-quantity-precision) format                  |\n| quantity             | String    | quantity, see [asset value](/rest/general/price-quantity-precision) format               |\n| side                 | String    | order side                                                                                |\n| isTaker              | Boolean   | denotes whether this is a taker's trade                                                   |\n| createdAtTimestamp   | String    | denotes the time the order was ACK'd by the exchange                                      |\n| createdAtDatetime    | String    | denotes the time the order was ACK'd by the exchange, ISO 8601 with millisecond as string |\n| publishedAtTimestamp | String    | denotes the time the update was broadcasted to connected WebSockets                       |\n\n```json\n{\n  \"type\": \"update\",\n  \"dataType\": \"V1TAAnonymousTrade\",\n  \"data\": {\n    \"tradeId\": \"100000000000001050\",\n    \"symbol\": \"BTCUSD\",\n    \"price\": \"11528.2203\",\n    \"quantity\": \"1.00000000\",\n    \"side\": \"BUY\",\n    \"isTaker\": true,\n    \"createdAtTimestamp\": \"1662453438774\",\n    \"createdAtDatetime\": \"2022-09-06T08:37:18.774Z\",\n    \"publishedAtTimestamp\": \"1662453438780\"\n  }\n}\n```\n\nSee [connect to trades WebSocket](https://github.com/bullish-exchange/api-examples/blob/master/websocket/trades_web_socket.py) for a sample Python script.\n\n## Decommissioned Features\nList of Features that have been decommissioned and no longer usable.\n\n## Changelog\n### 2025 Changes\n  - May\n    - Deprecated Features:\n      - Anonymous Trades WebSocket (unauthenticated)\n### 2024 Changes\n  - April\n    - Deprecated Features:\n      - Bullish API Key\n      - Signing Format (Old)\n      - Hybrid OrderBook WebSocket (unauthenticated)\n      - Market Data WebSocket (authenticated)\n      - Spot Account\n    - Deprecated APIs for end of Q3 2024:\n      - REST - `GET | POST | DELETE /trading-api/v1/orders`\n      - REST - `GET /v1/orders/{orderId}`\n      - REST - `POST /v1/command?commandType=V1CancelAllOrders`\n      - REST - `POST /v1/command?commandType=V1CancelAllOrdersByMarket`\n      - REST - `POST /v1/command?commandType=V1DelayedCancelAllOrders`\n      - REST - `POST /v1/command?commandType=V1UnsetDelayedCancelAllOrders`\n      - REST - `GET | POST | DELETE /v1/amm-instructions`\n      - REST - `GET /v1/amm-instructions/{liquidityId}`\n    - Deprecated APIs:\n      - REST `GET /accounts/spot`\n      - REST `GET /accounts/spot/asset`\n"
  version: 1.0.0
  title: Bullish Features Deprecated API
servers:
- url: https://api.exchange.bullish.com/trading-api
  description: PRODUCTION
- url: https://registered.api.exchange.bullish.com/trading-api
  description: PRODUCTION
- url: https://prod.access.bullish.com/trading-api
  description: PRODUCTION (Direct Connect)
- url: https://api.bugbounty.bullish.com/trading-api
  description: SECURITY SANDBOX
- url: https://api.simnext.bullish-test.com/trading-api
  description: API SANDBOX
- url: https://registered.api.simnext.bullish-test.com/trading-api
  description: API SANDBOX
- url: https://simnext.access.bullish.com/trading-api
  description: API SANDBOX (Direct Connect)
tags:
- name: deprecated
  description: List of APIs that has been marked to be deprecated. You can still use these APIs till their end of service date.
paths:
  /v1/accounts/spot:
    get:
      tags:
      - deprecated
      deprecated: true
      summary: Get Spot Accounts
      description: '`Deprecated`: Please look at [Asset Account](/rest/api/get-asset-accounts) instead.


        Gets the spot accounts, requires [bearer token](/rest/authentication#add-authenticated-request-header) in authorization header


        **Ratelimited:** `True`

        '
      operationId: user-get-spot-accounts
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - in: query
        name: tradingAccountId
        description: Id of the trading account
        schema:
          $ref: '#/components/schemas/TradingAccountId'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                minItems: 0
                maxItems: 10
                items:
                  $ref: '#/components/schemas/SpotAccount'
        '401':
          description: Not Authenticated
        '403':
          description: Access Forbidden
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
      security:
      - jwtTokenAuth: []
  /v1/accounts/spot/{symbol}:
    get:
      deprecated: true
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - in: path
        name: symbol
        schema:
          $ref: '#/components/schemas/AssetSymbol'
        required: true
      - in: query
        name: tradingAccountId
        description: Id of the trading account
        schema:
          $ref: '#/components/schemas/TradingAccountId'
        required: true
      tags:
      - deprecated
      summary: Get Spot Account by Symbol
      description: '`Deprecated`: Please look at [Asset Account by Symbol](/rest/api/get-asset-account-by-symbol) instead.


        Gets the spot account by symbol, requires [bearer token](/rest/authentication#add-authenticated-request-header) in authorization header


        **Ratelimited:** `True`

        '
      operationId: user-get-spot-account-by-symbol
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SpotAccount'
        '401':
          description: Not Authenticated
        '403':
          description: Access Forbidden
        '404':
          description: Resource Not Found
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
      security:
      - jwtTokenAuth: []
  /v1/command:
    post:
      deprecated: true
      tags:
      - deprecated
      summary: Transfer Asset
      description: 'Send command to transfer asset between two trading accounts.

        '
      operationId: submitAssetTransferCommand
      parameters:
      - $ref: '#/components/parameters/Authorization'
      - $ref: '#/components/parameters/BX-SIGNATURE'
      - $ref: '#/components/parameters/BX-TIMESTAMP'
      - $ref: '#/components/parameters/BX-NONCE'
      - in: query
        name: commandType
        description: The command type, must be 'V1TransferAsset'
        required: true
        schema:
          type: string
          enum:
          - V1TransferAsset
          example: V1TransferAsset
      responses:
        '200':
          description: Status OK. This means the request was successfully acknowledged. It does not necessarily mean the command was successfully executed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TradingAccountTransferResponse'
        '400':
          description: 'Bad Request


            For example, sending a request with the `BX-SIGNATURE` header missing will result in the following response:

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadOrderEntryResponse'
        '401':
          description: Not Authenticated
        '403':
          description: Access Forbidden
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
      requestBody:
        description: Command for action
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TradingAccountTransferRequest'
      security:
      - jwtTokenAuth: []
components:
  schemas:
    AssetValue:
      description: see [asset value](/rest/general/price-quantity-precision) format
      type: string
      example: '1.00000000'
    RequestID:
      type: string
      example: '197735387747975680'
    AssetSymbol:
      type: string
      description: asset symbol as denoted in the world
      example: BTC
    TransferAssetCommand:
      type: object
      required:
      - commandType
      - assetSymbol
      - quantity
      - fromTradingAccountId
      - toTradingAccountId
      properties:
        commandType:
          description: The command type, e.g. 'V1TransferAsset'
          type: string
          example: V1TransferAsset
        assetSymbol:
          description: Symbol of the asset. i.e. currency
          allOf:
          - $ref: '#/components/schemas/AssetSymbol'
        quantity:
          description: Quantity of the asset.
          type: string
          example: '100'
        fromTradingAccountId:
          description: Source of the asset transfer
          allOf:
          - $ref: '#/components/schemas/TradingAccountId'
        toTradingAccountId:
          description: Destination of the asset transfer
          allOf:
          - $ref: '#/components/schemas/TradingAccountId'
    TradingAccountTransferResponse:
      type: object
      required:
      - message
      - requestId
      properties:
        message:
          description: message
          type: string
        requestId:
          description: unique request ID
          allOf:
          - $ref: '#/components/schemas/RequestID'
      example:
        message: Command acknowledged - TransferAsset
        requestId: '633909659774222336'
    Authorizer:
      type: string
      format: string
      example: 03E02367E8C900000500000000000000
      description: JWT authorizer you obtain along with the [JWT token](/rest/authentication#generate-a-jwt-token)
    TimeStampAsString:
      type: string
      format: string
      example: '1621490985000'
      description: unsigned 64 bit integer value which is the number of milliseconds since EPOCH expressed as string
    SpotAccount:
      type: object
      required:
      - accountId
      - type
      - symbol
      - total
      - free
      - used
      - updatedAtDatetime
      - updatedAtTimestamp
      properties:
        accountId:
          description: unique spot account ID
          allOf:
          - $ref: '#/components/schemas/SpotAccountID'
        type:
          description: Spot Account
          allOf:
          - type: string
            description: Type of Account
            example: spot
        symbol:
          description: asset symbol
          allOf:
          - $ref: '#/components/schemas/AssetSymbol'
        total:
          description: total is `free` + `used` assets within the account, see [asset value](/rest/general/price-quantity-precision) format
          allOf:
          - $ref: '#/components/schemas/AssetValue'
        free:
          description: refers to the assets that are available to use on the account excluding borrowed assets, see [asset value](/rest/general/price-quantity-precision) format
          allOf:
          - $ref: '#/components/schemas/AssetValue'
        used:
          description: refers to the assets that are locked in orders ,loans and AMM instructions, see [asset value](/rest/general/price-quantity-precision) format
          allOf:
          - $ref: '#/components/schemas/AssetValue'
        updatedAtDatetime:
          description: denotes the time the AMM instruction was updated by the exchange, ISO 8601 with millisecond as string
          allOf:
          - $ref: '#/components/schemas/DateTime'
        updatedAtTimestamp:
          description: denotes the time the AMM instruction was updated by the exchange
          allOf:
          - $ref: '#/components/schemas/TimeStampAsString'
    DateTime:
      type: string
      format: date-time
      example: '2021-05-20T01:01:01.000Z'
      description: ISO 8601 with millisecond as string
    TradingAccountId:
      description: unique trading account ID
      type: string
      example: '111000000000001'
    BadOrderEntryResponse:
      type: object
      required:
      - message
      - errorCode
      - errorCodeName
      properties:
        message:
          description: message
          type: string
          example: Missing signature header
        errorCode:
          description: unique error code
          type: integer
          example: 6029
        errorCodeName:
          description: unique error code name
          type: string
          example: MISSING_SIGNATURE_HEADER
    NonceAsString:
      type: string
      format: string
      example: '123456789'
      description: the nonce is a client side incremented unsigned 64 bit integer expressed as string
    SpotAccountID:
      type: string
      example: '1'
    TradingAccountTransferRequest:
      type: object
      required:
      - timestamp
      - nonce
      - authorizer
      - command
      properties:
        timestamp:
          allOf:
          - $ref: '#/components/schemas/TimeStampAsString'
        nonce:
          allOf:
          - $ref: '#/components/schemas/NonceAsString'
        authorizer:
          description: JWT authorizer you obtain along with the [JWT token](/rest/authentication#generate-a-jwt-token)
          allOf:
          - $ref: '#/components/schemas/Authorizer'
        command:
          description: the command to be executed which is sent in the request payload
          allOf:
          - $ref: '#/components/schemas/TransferAssetCommand'
  parameters:
    BX-TIMESTAMP:
      in: header
      name: BX-TIMESTAMP
      description: timestamp is the number of milliseconds since EPOCH
      required: true
      schema:
        type: string
    BX-NONCE:
      in: header
      name: BX-NONCE
      description: nonce is a client side incremented unsigned 64 bit integer
      required: true
      schema:
        type: string
    Authorization:
      in: header
      name: Authorization
      description: authorization header, its value must be 'Bearer ' + [token](/rest/authentication#generate-a-jwt-token)
      required: true
      schema:
        type: string
    BX-SIGNATUR

# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bullish/refs/heads/main/openapi/bullish-deprecated-api-openapi.yml