GET
/
v1
/
icm
/
messages
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.icm.listIcmMessages({
    sourceBlockchainId: "2D8RG4UpSXbPbvPCAWppNJyqTG2i2CAXSkTgmTBBvs7GKNZjsY",
    destinationBlockchainId: "yH8D7ThNJkxmtkuv2jgBa4P1Rn3Qpr4pPr7QYNfcdoS6k6HWp",
    to: "0x664A4Be5Af2cFc824F9C0914CbAc4703396Da2DC",
    from: "0x321eDA69247566D662178feE695C7026c604Cd94",
    network: "mainnet",
  });

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

run();
{
  "nextPageToken": "<string>",
  "messages": [
    {
      "messageId": "<string>",
      "icmContractAddress": "<string>",
      "sourceBlockchainId": "<string>",
      "destinationBlockchainId": "<string>",
      "sourceEvmChainId": "<string>",
      "destinationEvmChainId": "<string>",
      "messageNonce": "<string>",
      "from": "<string>",
      "to": "<string>",
      "data": "<string>",
      "messageExecuted": true,
      "receipts": [
        {
          "receivedMessageNonce": "<string>",
          "relayerRewardAddress": "<string>"
        }
      ],
      "receiptDelivered": true,
      "rewardDetails": {
        "address": "0x71C7656EC7ab88b098defB751B7401B5f6d8976F",
        "name": "Wrapped AVAX",
        "symbol": "WAVAX",
        "decimals": 18,
        "logoUri": "https://images.ctfassets.net/gcj8jwzm6086/5VHupNKwnDYJvqMENeV7iJ/fdd6326b7a82c8388e4ee9d4be7062d4/avalanche-avax-logo.svg",
        "ercType": "ERC-20",
        "price": {
          "currencyCode": "usd",
          "value": "42.42"
        },
        "value": "<string>"
      },
      "sourceTransaction": {
        "txHash": "<string>",
        "timestamp": 123,
        "gasSpent": "<string>"
      },
      "status": "pending"
    }
  ]
}

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

Query Parameters

​
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
​
sourceBlockchainId
string

The base58 encoded blockchain ID or evm chain ID of the source chain that the ICM message was sent from.

​
destinationBlockchainId
string

The base58 encoded blockchain ID or evm chain ID of the destination chain that the ICM message was sent to.

​
blockchainId
string

The base58 encoded blockchain ID of either source or destination chain that one ICM message interacts with.

​
to
string

The address of the recipient of the ICM message.

​
from
string

The address of the sender of the ICM message.

​
network
enum<string>

Either mainnet or testnet/fuji.

Available options:
mainnet,
fuji,
testnet,
devnet

Response

200
application/json
Successful response
​
messages
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 an ICM messageList ICM messages by address