history

Get Historical Account Transfer

Get historical transfers.

  • supports pagination
  • filtering on createdAtDatetime and createdAtTimestamp requires additional keywords, see filtering support
  • On a single query request you can retrieve data over a 7 day window, with the data available for the last 90 days
get/v1/history/transfer

Request

Query parameters

tradingAccountIdstring

unique trading account ID

Example:111000000000001

Id of the trading account. tradingAccountId is mandatory in the query for users with multiple trading accounts. For users with a single trading account, it can be automatically retrieved from the login.

statusstring
Example:CLOSED

Status of the transfer request. Defaults to CLOSED

requestIdstring
Example:561287547935260672

Unique identifier of the transfer request

assetSymbolstring

asset symbol as denoted in the world

Example:BTC

Asset symbol of the transfer request

createdAtDatetime[gte]string date-time required

ISO 8601 with millisecond as string

Example:2025-05-20T01:01:01.000Z

start datetime of window, ISO 8601 with millisecond as string

createdAtDatetime[lte]string date-time required

ISO 8601 with millisecond as string

Example:2025-05-20T01:01:01.000Z

end datetime of window, ISO 8601 with millisecond as string

Response

OK

requestIdstring

unique identifier of the transfer request

toTradingAccountIdstring

unique trading account ID

fromTradingAccountIdstring

sender's trading account

assetSymbolstring

asset symbol as denoted in the world

quantitystring

see asset value format

statusstring

transfer status [CLOSED/OPEN/REJECTED]

statusReasonCodestring

status reason code

statusReasonstring

readable status reason

createdAtTimestampstring string

unsigned 64 bit integer value which is the number of milliseconds since EPOCH expressed as string

createdAtDatetimestring date-time

ISO 8601 with millisecond as string

Example response

[
  {
    "requestId": "1",
    "toTradingAccountId": "111000000000001",
    "fromTradingAccountId": "121000000000001",
    "assetSymbol": "BTC",
    "quantity": "1.00000000",
    "status": "CLOSED",
    "statusReasonCode": "6002",
    "statusReason": "Executed",
    "createdAtTimestamp": "1621490985000",
    "createdAtDatetime": "2025-05-20T01:01:01.000Z"
  }
]

Changes

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