hyperlane

List hyperlane transfers info

Changed on

Returns a paginated list of Hyperlane cross-chain token transfers. Supports filtering by sender/receiver address, relayer, mailbox, token, transfer type (send/receive), domain, and transaction hash.

get/hyperlane/transfer

Request

  • Base URL
    api-mainnet.celenium.io (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header apikey

Query parameters

limitinteger

Count of requested entities

offsetinteger

Offset

sort'asc' | 'desc'

Sort order. Default: desc

addressstring

Celestia address

relayerstring

Celestia address of relayer

mailboxstring

Mailbox hexademical identity

tokenstring

Token hexademical identity

typestring[]

Comma-separated string of transfer type

domaininteger

Domain of counterparty chain

hashstring

Transaction hash in hexadecimal

Response

OK

bodystring string
denomstring string
heightinteger
idinteger
mailboxstring hex
message_idstring hex
metadatastring string
nonceinteger
receivedstring string
timestring date-time
token_idstring hex
tx_hashstring hex
typestring string
versioninteger

Example response

[
  {
    "address": {
      "celestials": {
        "image_url": "https://ipfs.io/ipfs/QmUi269vE25fagqhyMCCTNSoiW6x4LHCwwQb3keSrEXAmC",
        "name": "name",
        "primary": true,
        "status": "VERIFIED"
      },
      "hash": "celestia1jc92qdnty48pafummfr8ava2tjtuhfdw774w60"
    },
    "body": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAs2bWWU6FOB0=",
    "counterparty": {
      "chain_metadata": {
        "block_explorers": [
          {
            "api_url": "https://api.scan.url.io",
            "family": "etherscan",
            "name": "Block explorer",
            "url": "https://scan.url.io"
          }
        ],
        "name": "name",
        "native_token": {
          "decimals": 18,
          "name": "Ether",
          "symbol": "ETH"
        }
      },
      "domain": 100,
      "hash": "652452A670018D629CC116E510BA88C1CABE061336661B1F3D206D248BD558AF"
    },
    "denom": "utia",
    "gas_payment": {
      "amount": "12345",
      "gas_amount": "123",
      "igp_id": "652452A670018D629CC116E510BA88C1CABE061336661B1F3D206D248BD558AF"
    },
    "height": 100,
    "id": 321,
    "mailbox": "652452A670018D629CC116E510BA88C1CABE061336661B1F3D206D248BD558AF",
    "message_id": "652452a670018d629cc116e510ba88c1cabe061336661b1f3d206d248bd558af",
    "metadata": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAs2bWWU6FOB0=",
    "nonce": 10,
    "received": "123445",
    "relayer": {
      "celestials": {
        "image_url": "https://ipfs.io/ipfs/QmUi269vE25fagqhyMCCTNSoiW6x4LHCwwQb3keSrEXAmC",
        "name": "name",
        "primary": true,
        "status": "VERIFIED"
      },
      "hash": "celestia1jc92qdnty48pafummfr8ava2tjtuhfdw774w60"
    },
    "time": "2023-07-04T03:10:57+00:00",
    "token_id": "652452A670018D629CC116E510BA88C1CABE061336661B1F3D206D248BD558AF",
    "tx_hash": "652452A670018D629CC116E510BA88C1CABE061336661B1F3D206D248BD558AF",
    "type": "collateral",
    "version": 1
  }
]

Changes