/accounts/{accountId}/balance-info REST API Endpoint

Path Parameters

accountId

string

REQUIRED

The SS58 address of the account.

Query Parameters

at

string

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

token

string

The token to query the balance of. If not specified it will query the chains native token (e.g. DOT for Polkadot). Note: this is only relevant for chains that support multiple tokens through the ORML tokens pallet.

denominated

boolean

When set to `true` it will denominate any balance's given atomic value using the chains given decimal value.

Returns

at

object

An Object containing information about the blockchain state which contains the following fields:

hash

string

The hash of the block at the specified state

height

string

The height of the block at the specified state

nonce

string

The current nonce of the account

tokenSymbol

string

The symbol of the token for which the balance information is provided.

free

string

The amount of free (spendable) balance.

reserved

string

The amount of balance reserved for various purposes.

miscFrozen

string

The amount of balance that is frozen for miscellaneous reasons.

feeFrozen

string

The amount of balance that is frozen for fees.

frozen

string

The total amount of frozen balance.

locks

array

An array of objects representing any locks on the balance.

id

string

The identifier of the lock.

amount

string

The amount of balance that is locked.

reasons

string

The reasons for the lock, such as fees or other restrictions

Request

1
curl 'https://docs-demo.dot-mainnet.quiknode.pro/accounts/5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty/balance-info'
2

Don't have an account yet?

Create your QuickNode endpoint in seconds and start building

Get started for free