BUbullish
transfer

Transfer Asset Command

Submits a command to the trading engine. A successful response indicates that the command entry was acknowledged but does not indicate that the command was executed. This endpoint uses the signing format which does not require strict field ordering and addition of null fields in the request body. Quantities and prices does not require strict precision. E.g. for asset precision of 4 - 100, 100.0, 100.00, 100.000 and 100.0000 are all accepted.

Requires

  • bearer token in authorization header

Ratelimited: True. Higher tiers of rate limits available by providing the BX-RATELIMIT-TOKEN request header.

post/v2/command#transferAsset

Request

Headers

BX-SIGNATUREstring required

signature obtained using the signing format

BX-TIMESTAMPstring required

timestamp is the number of milliseconds since EPOCH

BX-NONCEstring required

nonce is a client side incremented unsigned 64 bit integer

BX-NONCE-WINDOW-ENABLED'false' | 'true'

string representation of a boolean value, enables out-of-order order requests to be processed

Request body

commandType'V2TransferAsset' required

The command type, e.g. 'V2TransferAsset'

assetSymbolstring required

asset symbol as denoted in the world

quantitystring required

Quantity of the asset. Can be representated with any number of trailing zeroes up to asset precision (eg 100.1, 100.10, 100.100, 100.1000 are valid for asset precision 4)

fromTradingAccountIdstring required

unique trading account ID

toTradingAccountIdstring required

unique trading account ID

Example request

{
  "commandType": "V2TransferAsset",
  "assetSymbol": {
    "$ref": "#/components/schemas/AssetSymbol/example"
  },
  "quantity": "100.1",
  "fromTradingAccountId": {
    "$ref": "#/components/schemas/TradingAccountId/example"
  },
  "toTradingAccountId": "111000000000002"
}

Response

Status OK. This means a command was successfully acknowledged.

commandType'V2TransferAsset' required

The command type

messagestring required

message

requestIdstring required

Example response

{
  "commandType": "V2TransferAsset",
  "message": "Command acknowledged - TransferAsset",
  "requestId": "633909659774222336"
}

Changes

No recorded changes to this operation across all 1 revision of this API.