Get balances

Gets primary network balances for one of the Primary Network chains for the supplied addresses.

C-Chain balances returned are only the shared atomic memory balance. For EVM balance, use the /v1/chains/:chainId/addresses/:addressId/balances:getNative endpoint.

Authorizations

x-glacier-api-key

string

headerrequired

Api keys provide higher access to rate limits. To obtain an api key, sign up for an account at https://avacloud.io/.

Path Parameters

blockchainId

enum<string>

required

A primary network blockchain id or alias.

Available options:

11111111111111111111111111111111LpoYY,

2oYMBNV4eNHyqk2fjjV5nVQLDbtmNJzq5s3qs3Lo6ftnC6FByM,

2JVSBoinj9C2J33VntvzYtVJNZdN2NKiwwKjcumHUWEb5DbBrm,

2piQ2AVHCjnduiWXsSY15DtbVuwHE2cwMHYnEXHsLL73BBkdbV,

2q9e4r6Mu3U68nU1fYjgbR6JvwrRx36CohpAX5UQxse55x1Q5,

yH8D7ThNJkxmtkuv2jgBa4P1Rn3Qpr4pPr7QYNfcdoS6k6HWp,

vV3cui1DsEPC3nLCGH9rorwo8s6BYxM2Hz4QFE5gEYjwTqAu,

p-chain,

x-chain,

c-chain

network

enum<string>

required

Either mainnet or testnet/fuji.

Available options:

mainnet,

fuji,

testnet,

devnet

Query Parameters

blockTimestamp

integer

An epoch timestamp in seconds. Balance will be calculated at this timestamp.

addresses

string

A comma separated list of X-Chain or P-Chain wallet addresses, starting with "avax"/"fuji", "P-avax"/"P-fuji" or "X-avax"/"X-fuji".

Response

200 - application/json

• Option 1
• Option 2
• Option 3

balances

object

required

Show child attributes

balances.unlockedUnstaked

object[]

required

A list of objects containing P-chain Asset basic info, amount, and utxo count of that Asset ID. Denotes the amount of unstaked Avax that is consumable by any transaction.

Show child attributes

balances.unlockedUnstaked.assetId

string

required

Unique ID for an asset.

balances.unlockedUnstaked.name

string

required

Name of this asset.

balances.unlockedUnstaked.symbol

string

required

Symbol for this asset (max 4 characters).

balances.unlockedUnstaked.denomination

number

required

Denomination of this asset to represent fungibility.

balances.unlockedUnstaked.type

enum<string>

required

Type of asset like SECP256K1 or NFT.

Available options:

secp256k1,

nft

balances.unlockedUnstaked.amount

string

required

Amount of the asset.

balances.unlockedUnstaked.utxoCount

number

required

balances.unlockedStaked

object[]

required

A list of objects containing P-chain Asset basic info, amount, and utxo count of that Asset ID. Denotes the amount of staked Avax that is consumable by any transaction when the staking period ends.

Show child attributes

balances.unlockedStaked.assetId

string

required

Unique ID for an asset.

balances.unlockedStaked.name

string

required

Name of this asset.

balances.unlockedStaked.symbol

string

required

Symbol for this asset (max 4 characters).

balances.unlockedStaked.denomination

number

required

Denomination of this asset to represent fungibility.

balances.unlockedStaked.type

enum<string>

required

Type of asset like SECP256K1 or NFT.

Available options:

secp256k1,

nft

balances.unlockedStaked.amount

string

required

Amount of the asset.

balances.unlockedStaked.utxoCount

number

required

balances.lockedPlatform

object[]

required

A list of objects containing P-chain Asset basic info, amount, and utxo count of that Asset ID. Denotes the amount of unstaked Avax that is locked at the platform level and not consumable by any transaction at the current time.

Show child attributes

balances.lockedPlatform.assetId

string

required

Unique ID for an asset.

balances.lockedPlatform.name

string

required

Name of this asset.

balances.lockedPlatform.symbol

string

required

Symbol for this asset (max 4 characters).

balances.lockedPlatform.denomination

number

required

Denomination of this asset to represent fungibility.

balances.lockedPlatform.type

enum<string>

required

Type of asset like SECP256K1 or NFT.

Available options:

secp256k1,

nft

balances.lockedPlatform.amount

string

required

Amount of the asset.

balances.lockedPlatform.utxoCount

number

required

balances.lockedStakeable

object[]

required

A list of objects containing P-chain Asset basic info, amount, and utxo count of that Asset ID. Denotes the amount of unstaked Avax that is locked at the platform level and only consumeable for staking transactions.

Show child attributes

balances.lockedStakeable.assetId

string

required

Unique ID for an asset.

balances.lockedStakeable.name

string

required

Name of this asset.

balances.lockedStakeable.symbol

string

required

Symbol for this asset (max 4 characters).

balances.lockedStakeable.denomination

number

required

Denomination of this asset to represent fungibility.

balances.lockedStakeable.type

enum<string>

required

Type of asset like SECP256K1 or NFT.

Available options:

secp256k1,

nft

balances.lockedStakeable.amount

string

required

Amount of the asset.

balances.lockedStakeable.utxoCount

number

required

balances.lockedStaked

object[]

required

A list of objects containing P-chain Asset basic info, amount, and utxo count of that Asset ID. Denotes the amount of staked Avax that will be locked when the staking period ends.

Show child attributes

balances.lockedStaked.assetId

string

required

Unique ID for an asset.

balances.lockedStaked.name

string

required

Name of this asset.

balances.lockedStaked.symbol

string

required

Symbol for this asset (max 4 characters).

balances.lockedStaked.denomination

number

required

Denomination of this asset to represent fungibility.

balances.lockedStaked.type

enum<string>

required

Type of asset like SECP256K1 or NFT.

Available options:

secp256k1,

nft

balances.lockedStaked.amount

string

required

Amount of the asset.

balances.lockedStaked.utxoCount

number

required

balances.pendingStaked

object[]

required

A list of objects containing P-chain Asset basic info, amount, and utxo count of that Asset ID. Denotes the amount of staked Avax whose staking period has not yet started.

Show child attributes

balances.pendingStaked.assetId

string

required

Unique ID for an asset.

balances.pendingStaked.name

string

required

Name of this asset.

balances.pendingStaked.symbol

string

required

Symbol for this asset (max 4 characters).

balances.pendingStaked.denomination

number

required

Denomination of this asset to represent fungibility.

balances.pendingStaked.type

enum<string>

required

Type of asset like SECP256K1 or NFT.

Available options:

secp256k1,

nft

balances.pendingStaked.amount

string

required

Amount of the asset.

balances.pendingStaked.utxoCount

number

required

balances.atomicMemoryUnlocked

object[]

required

A list of objects containing P-chain Asset basic info, amount and utxo count of that Asset ID. Denotes the amount of unlocked Avax in the atomic memory between P-Chain and other chain.

Show child attributes

balances.atomicMemoryUnlocked.assetId

string

required

Unique ID for an asset.

balances.atomicMemoryUnlocked.name

string

required

Name of this asset.

balances.atomicMemoryUnlocked.symbol

string

required

Symbol for this asset (max 4 characters).

balances.atomicMemoryUnlocked.denomination

number

required

Denomination of this asset to represent fungibility.

balances.atomicMemoryUnlocked.type

enum<string>

required

Type of asset like SECP256K1 or NFT.

Available options:

secp256k1,

nft

balances.atomicMemoryUnlocked.amount

string

required

Amount of the asset.

balances.atomicMemoryUnlocked.utxoCount

number

required

balances.atomicMemoryUnlocked.sharedWithChainId

string

required

balances.atomicMemoryUnlocked.status

string

required

balances.atomicMemoryLocked

object[]

required

A list of objects containing P-chain Asset basic info, amount and utxo count of that Asset ID. Denotes the amount of locked Avax in the atomic memory between P-Chain and other chain.

Show child attributes

balances.atomicMemoryLocked.assetId

string

required

Unique ID for an asset.

balances.atomicMemoryLocked.name

string

required

Name of this asset.

balances.atomicMemoryLocked.symbol

string

required

Symbol for this asset (max 4 characters).

balances.atomicMemoryLocked.denomination

number

required

Denomination of this asset to represent fungibility.

balances.atomicMemoryLocked.type

enum<string>

required

Type of asset like SECP256K1 or NFT.

Available options:

secp256k1,

nft

balances.atomicMemoryLocked.amount

string

required

Amount of the asset.

balances.atomicMemoryLocked.utxoCount

number

required

balances.atomicMemoryLocked.sharedWithChainId

string

required

balances.atomicMemoryLocked.status

string

required

chainInfo

object

required

Show child attributes

chainInfo.chainName

enum<string>

required

Available options:

p-chain,

x-chain,

c-chain

chainInfo.network

enum<string>

required

Available options:

mainnet,

fuji,

testnet,

devnet