API Reference

Sub Portfolio Funds in/out History

Description

Query the funds in / out history for the current RapidX sub-portfolio bound to the API key.

This API returns all asset bills of the portfolio, including:

  • Deposits (on-chain transfers into the portfolio)
  • Withdrawals (on-chain transfers out of the portfolio)
  • Internal transfers between different trade accounts / account types within LTP

You can filter records by currency, bill type, status and time range, and paginate through the result set.

Permission

RapidX API key with read-only permission is sufficient. No trading / write permission is required.

Request

FieldTypeNecessaryDescription
currencyStringNFilter by currency symbol (e.g. USDT). If omitted, bills for all currencies are returned.
typeIntegerNFilter by bill type: 0 = deposit, 1 = internal transfer, 2 = withdrawal. If omitted, all types are included.
statusIntegerNFilter by bill status: 0 = pending, 1 = succeeded, 2 = failed. If omitted, all statuses are included.
startTimeLongNStart of the time range (inclusive), as a Unix timestamp in milliseconds.
endTimeLongNEnd of the time range (inclusive), as a Unix timestamp in milliseconds.
pageIntegerNPage number for pagination, starting from 1. Default is 1.
pageSizeIntegerNNumber of records per page. Default is 1000.

Response

FieldTypeDescription
idLongUnique identifier of this bill record.
currencyStringAsset symbol, e.g. USDT.
clientOrderIdStringOptional client-defined ID associated with this bill (if applicable). May be null.
amountNumberRequested transfer amount (nominal amount of this operation), before deducting any network fee.
amountReceivedNumberActual amount credited to the receiving side after fees. For on-chain operations, typically amount - networkFee. For internal transfers, equals amount.
networkFeeNumberNetwork fee charged for on-chain deposit / withdrawal. For pure internal transfers, this value is 0.
networkStringNetwork name, e.g. BSC, TRC20, ERC20. Empty string for internal transfers where no blockchain network is involved.
txIdStringOn-chain transaction hash for deposits / withdrawals. null for internal transfers.
fromTradeAccountIdLongAccount ID that the funds are transferred from. null when the source is an external wallet or non-account source.
toTradeAccountIdLongAccount ID that the funds are transferred to. null when the destination is an external wallet.
fromAccountTypeStringSource account type or venue label, for example Binance, Funding, etc. May be null if the operation originates from an external address.
toAccountTypeStringDestination account type or venue label. For example Binance, Funding, etc. May be null if the destination is an external address.
statusIntegerBill status: 0 = pending, 1 = succeeded, 2 = failed. Only 1 indicates the balance has been finally updated.
typeIntegerBill type: 0 = deposit (funds flow into the portfolio), 1 = internal transfer (between LTP accounts / account types), 2 = withdrawal (funds flow out).
createdAtLongCreation time of this bill record. Unix timestamp in milliseconds.
Language
Credentials
OAuth2