Skip to main content

/accounts/{accountId}/pool-asset-balances REST API Endpoint

Returns information about an account's pool-asset-balances. This is specific to the pool assets pallet for parachains. If no assets query parameter is provided, all pool-asset-balances for the given account will be returned.

Updated on
Sep 02, 2024

Path Parameters

accountId
string
REQUIRED

The SS58 address of the account.

Query Parameters

at
string

The block at which to query pool-asset-balance info for the specified account.

assets
array

An array of AssetId's to be queried. If not supplied, defaults to providing all asset balances associated with the accountId will be returned. The array query param format follows Express 4.x API. ex:?assets[]=1&assets[]=2&assets[]=3.

Returns

at
object

An object containing information about the state.

hash
string

The hash of the block at the specified state.

height
string

The height of the block at the specified state.

poolAssets
array

An array of objects, each representing a pool asset held by the account

assetId
string

The unique identifier of the pool asset.

balance
string

The balance of the pool asset held by the account.

isFrozen
boolean

Whether the asset is frozen for non-admin transfers. Note, that some runtimes may not have support for isFrozen and if so the following will be returned `isFrozen does not exist for this runtime

isSufficient
boolean

Whether a non-zero balance of this asset is a deposit of sufficient value to account for the state bloat associated with its balance storage. If set to true, then non-zero balances may be stored without a consumer reference (and thus an ED in the Balances pallet or whatever else is used to control user-account state growth)

Request
Don't have an account yet?
Create your Quicknode endpoint in seconds and start building
Get started for free