List UTXOs

GET

networks

{network}

blockchains

{blockchainId}

utxos

import { AvaCloudSDK } from "@avalabs/avacloud-sdk";

const avaCloudSDK = new AvaCloudSDK({
  serverURL: "https://api.example.com",
  chainId: "43114",
  network: "mainnet",
});

async function run() {
  const result = await avaCloudSDK.data.primaryNetwork.utxos.getUtxosByAddresses({
    addresses: "avax1h2ccj9f5ay5acl6tyn9mwmw32p8wref8vl8ctg",
    blockchainId: "p-chain",
    network: "mainnet",
    sortOrder: "asc",
  });

  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

{
  "nextPageToken": "<string>",
  "utxos": [
    {
      "addresses": [
        "avax1qm2a25eytsrj235hxg6jc0mwk99tss64eqevsw"
      ],
      "asset": {
        "assetId": "th5aLdWLi32yS9ED6uLGoMMubqHjzMsXhKWwzP6yZTYQKYzof",
        "name": "Avalanche",
        "symbol": "AVAX",
        "denomination": 9,
        "type": "secp256k1",
        "amount": "5001000"
      },
      "consumedOnChainId": "2oYMBNV4eNHyqk2fjjV5nVQLDbtmNJzq5s3qs3Lo6ftnC6FByM",
      "consumingTxHash": "3j9JpF1aGuQtLLbo3YkvvKkWrCZViXZjdeJQWUSEY5hcqUn2c",
      "createdOnChainId": "2oYMBNV4eNHyqk2fjjV5nVQLDbtmNJzq5s3qs3Lo6ftnC6FByM",
      "utxoId": "68vLva9kfKUsX88ZPM8jdbf8qHUZRoZSFH6NdpAVTspkfrXDC",
      "amount": "<string>",
      "assetId": "<string>",
      "blockNumber": "<string>",
      "blockTimestamp": 123,
      "consumingBlockNumber": "<string>",
      "consumingBlockTimestamp": 123,
      "platformLocktime": 123,
      "outputIndex": 123,
      "rewardType": "VALIDATOR",
      "stakeableLocktime": 123,
      "staked": true,
      "threshold": 123,
      "txHash": "<string>",
      "utxoEndTimestamp": 123,
      "utxoStartTimestamp": 123,
      "utxoType": "STAKE"
    }
  ],
  "chainInfo": {
    "chainName": "p-chain",
    "network": "mainnet"
  }
}

Authorizations

x-glacier-api-key

string

header

required

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

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".

pageToken

string

A page token, received from a previous list call. Provide this to retrieve the subsequent page.

pageSize

integer

default:10

The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.

Required range: 1 <= x <= 100

assetId

string

Asset ID for any asset (only applicable X-Chain)

includeSpent

boolean

Boolean filter to include spent UTXOs.

sortOrder

enum<string>

The order by which to sort results. Use "asc" for ascending order, "desc" for descending order. Sorted by timestamp or the sortBy query parameter, if provided.

Available options:

asc,

desc

Response

200

application/json

Successful response

utxos

object[]

required

utxos.addresses

string[]

required

Addresses that are eligible to sign the consumption of this output.

Example:

[
  "avax1qm2a25eytsrj235hxg6jc0mwk99tss64eqevsw"
]

utxos.asset

object

required

utxos.consumedOnChainId

string

required

Blockchain ID on which this output is consumed on.

Example:

"2oYMBNV4eNHyqk2fjjV5nVQLDbtmNJzq5s3qs3Lo6ftnC6FByM"

utxos.createdOnChainId

string

required

Blockchain ID on which this output is created on.

Example:

"2oYMBNV4eNHyqk2fjjV5nVQLDbtmNJzq5s3qs3Lo6ftnC6FByM"

utxos.utxoId

string

required

UTXO ID for this output.

Example:

"68vLva9kfKUsX88ZPM8jdbf8qHUZRoZSFH6NdpAVTspkfrXDC"

utxos.amount

string

requireddeprecated

utxos.assetId

string

requireddeprecated

utxos.blockNumber

string

required

utxos.blockTimestamp

number

required

utxos.outputIndex

number

required

The index of the UTXO in the transaction

utxos.txHash

string

required

The hash of the transaction that created this UTXO

utxos.utxoType

enum<string>

required

Indicates whether the UTXO is staked or transferable

Available options:

STAKE,

TRANSFER

utxos.consumingTxHash

string

Transaction ID that consumed this output.

Example:

"3j9JpF1aGuQtLLbo3YkvvKkWrCZViXZjdeJQWUSEY5hcqUn2c"

utxos.consumingBlockNumber

string

Block height in which the transaction consuming this UTXO was included

utxos.consumingBlockTimestamp

number

Timestamp in seconds at which this UTXO is used in a consuming transaction

utxos.platformLocktime

number

Timestamp in seconds after which this UTXO can be consumed

utxos.rewardType

enum<string>

Available options:

VALIDATOR,

DELEGATOR,

VALIDATOR_FEE

utxos.stakeableLocktime

number

Timestamp in seconds before which a UTXO can only be used for staking transactions. After stakeable locktime, a UTXO can be used for anything

utxos.staked

boolean

utxos.threshold

number

The minimum number of signatures required to spend this UTXO

utxos.utxoEndTimestamp

number

Timestamp in seconds after which the staked UTXO will be unlocked.

utxos.utxoStartTimestamp

number

Timestamp in seconds at which the staked UTXO was locked.

chainInfo

object

required

nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.

Was this page helpful?

Get balances List pending rewards

import { AvaCloudSDK } from "@avalabs/avacloud-sdk";

const avaCloudSDK = new AvaCloudSDK({
  serverURL: "https://api.example.com",
  chainId: "43114",
  network: "mainnet",
});

async function run() {
  const result = await avaCloudSDK.data.primaryNetwork.utxos.getUtxosByAddresses({
    addresses: "avax1h2ccj9f5ay5acl6tyn9mwmw32p8wref8vl8ctg",
    blockchainId: "p-chain",
    network: "mainnet",
    sortOrder: "asc",
  });

  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

{
  "nextPageToken": "<string>",
  "utxos": [
    {
      "addresses": [
        "avax1qm2a25eytsrj235hxg6jc0mwk99tss64eqevsw"
      ],
      "asset": {
        "assetId": "th5aLdWLi32yS9ED6uLGoMMubqHjzMsXhKWwzP6yZTYQKYzof",
        "name": "Avalanche",
        "symbol": "AVAX",
        "denomination": 9,
        "type": "secp256k1",
        "amount": "5001000"
      },
      "consumedOnChainId": "2oYMBNV4eNHyqk2fjjV5nVQLDbtmNJzq5s3qs3Lo6ftnC6FByM",
      "consumingTxHash": "3j9JpF1aGuQtLLbo3YkvvKkWrCZViXZjdeJQWUSEY5hcqUn2c",
      "createdOnChainId": "2oYMBNV4eNHyqk2fjjV5nVQLDbtmNJzq5s3qs3Lo6ftnC6FByM",
      "utxoId": "68vLva9kfKUsX88ZPM8jdbf8qHUZRoZSFH6NdpAVTspkfrXDC",
      "amount": "<string>",
      "assetId": "<string>",
      "blockNumber": "<string>",
      "blockTimestamp": 123,
      "consumingBlockNumber": "<string>",
      "consumingBlockTimestamp": 123,
      "platformLocktime": 123,
      "outputIndex": 123,
      "rewardType": "VALIDATOR",
      "stakeableLocktime": 123,
      "staked": true,
      "threshold": 123,
      "txHash": "<string>",
      "utxoEndTimestamp": 123,
      "utxoStartTimestamp": 123,
      "utxoType": "STAKE"
    }
  ],
  "chainInfo": {
    "chainName": "p-chain",
    "network": "mainnet"
  }
}

Get Started

Learn

Health Check

EVM

Primary Network

ICM Services

Operations

Usage Metrics

Authorizations

Path Parameters

Query Parameters

Response