Returns Earn holdings aggregated by currency, including balances and valuations.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Returns the currency-centric Earn view: it combines holdings in all Earn products into one row per currency.
Use it to answer “how much BTC, USDT or another currency is in Earn, how much is available, and how much is invested?” Use Get Earn Product Assets when the user instead needs the individual product, term or yield details that make up a currency total.
Rate limit: 10 requests per minute per API key. This endpoint is not paginated.
API key access
This is a read-only LTP Open API endpoint. READ permission is sufficient; TRADE, TRANSFER and WITHDRAW are not required.
| API key type | Can call | Returned scope |
|---|---|---|
| Main User Level API key | Yes | Earn currency totals in the main user's API-key scope. |
| Sub-user Level API key | Yes | Only Earn currency totals in that Sub-user's scope. An empty result is valid. |
| Portfolio Level API key (a dedicated RapidX Sub Portfolio key) | No | This user-level asset service does not support Portfolio-scoped API keys. |
| Exchange-native API key | No | This endpoint accepts signed LTP Open API keys only. |
An unsupported API key level is rejected before asset data is read, normally with 2003.
Balance convention
For each returned currency row, balance is the total Earn quantity and follows:
balance = available + frozen + holding
holding represents the amount invested in Earn products; it is not an additional balance to add on top of balance. All amount and valuation fields are decimal strings.
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
quoteCurrency | string | No | Currency used to value each currency row. Accepts USD, BTC or USDT; defaults to USD. It does not change the actual Earn quantity. |
hideDust | boolean | No | Defaults to true. When true, currencies valued below 1 USD are hidden. Set false when a reconciliation must include every low-value currency. |
currency | string | No | Optional exact currency-symbol filter. Omit it to return every Earn currency in scope. A non-matching symbol returns a successful empty list. |
Response fields
data contains totalValue, quoteCurrency, exchangeRate, updatedAt and list.
| Field | Type | Description |
|---|---|---|
code | integer | Application result code. 200 means success. |
message | string | Result message. |
data.totalValue | string | Total Earn valuation in data.quoteCurrency. |
data.quoteCurrency | string | Valuation currency used in the response. |
data.exchangeRate | string | USD value of one unit of data.quoteCurrency; "1" for USD. |
data.updatedAt | integer | Asset snapshot time as a Unix timestamp in milliseconds. |
data.list | array | Currency-level Earn totals. An empty array is a normal successful response when no holding matches the filters. |
Field in data.list[] | Type | Description |
|---|---|---|
quoteCurrency | string | Valuation currency for this row. |
totalValue | string | Value of this Earn currency total in quoteCurrency. |
changePctToday | string or null | Daily percentage change when available. "" or null means unavailable, not zero. |
currency | string | LTP currency symbol. |
balance | string | Total Earn quantity for the currency. It equals available + frozen + holding. |
equity | string | Earn equity in units of this currency, not a valuation. |
available | string | Quantity available for operations within the Earn account, in units of this currency. It may differ from the transferable or withdrawable quantity. |
frozen | string | Earn quantity temporarily locked or unavailable. |
holding | string | Earn quantity invested in product holdings. It is already included in balance. |
currencyDetails | object | Currency metadata: id (currency reference ID), iconUrl, currencyName, slug, referenceAssetId (reference currency ID) and multiplier (conversion ratio to the reference currency). |
Choosing the correct Earn view
| Need | Endpoint |
|---|---|
| One row per held Earn product, including term / rates / shares | Get Earn Product Assets |
| One row per currency across all Earn products | This endpoint |
The two endpoints present the same Earn holdings from different dimensions.
Relevant errors
| Code | When it occurs | What to do |
|---|---|---|
404001 | quoteCurrency is not supported. | Use USD, BTC or USDT. |
404006 | Earn asset data is temporarily unavailable. | Retry after a short delay. |
2000 | Signature, API key or nonce verification fails. | Recreate the signed request with the exact query parameters and a seconds-based nonce. |
100429 | The API key exceeds the rate limit. | Back off before retrying. |