Retrieve current balance of the specified asset

Returns the current balance of the specified digital asset in your portfolio.

SecurityBearerAuth
Request
path Parameters
asset
required
string
Enum: "BTC" "ETH" "LTC" "BCH" "USD" "USDC" "USDT"
Example: BTC
query Parameters
balanceType
string
Default: "FUNDED"
Enum: Description
FUNDED

The amount of this asset that you deposited into your Liquidity Hub account.

PENDING_SETTLEMENT

The amount of this asset that you must settle with Ripple, or the amount of this asset that Ripple needs to settle with you.

TRADING_POWER_REMAINING

The amount of trading power remaining that you may use to purchase or sell assets during the current trading window. This does not include any available FUNDED balance that you can use for trading.

Example: balanceType=PENDING_SETTLEMENT
Responses
200

OK

400

Bad request

403

Forbidden

404

Not found

500

Internal server error

get/balances/{asset}
Request samples 
Response samples 
application/json
{
  • "asset": "USD",
  • "total": "2345.67",
  • "available": "2000.00",
  • "reserved": "345.67",
  • "balanceType": "FUNDED",
  • "lastUpdated": "2021-01-01T01:00:30.000Z",
  • "endUserGuid": "669ce446-22d0-11ec-9621-0242ac130002"
}