REST API›Wallet & Transact›Address

GET

Get cross-chain address balances

Gets balance information for a specific address across all enabled EVM keyring chains

For EVM keyring wallets, this endpoint returns the balance of a specific receive address across all derived child wallets on different chains (e.g., ETH, Polygon, BSC). The same address exists on multiple chains due to shared key material.

Path Params

  • walletId string required

    matches ^[0-9a-f]{32}$

  • address string required
    The address to check across chains

Query Params

  • includeAllChains boolean
    Include all chains in the EVM keyring, even if the address doesn't exist on them yet. When true, returns placeholder entries with empty id field and zero balances for chains where the address hasn't been created.

    Defaults to false

Responses

200
OK

Response Body

object

  • addresses array of objects required
    addresses object
    • id string required
      Platform public ID for the address

      matches ^[0-9a-f]{32}$

    • coin string required
      The coin/chain for this address
    • wallet string required
      Wallet ID containing this address

      matches ^[0-9a-f]{32}$

    • address string required
      The address string (same across chains in an EVM keyring)
    • chain number enum required
      Chain index (0 for receive addresses)
      011011202130314041
    • index number required
      Address index within the chain
    • label string
      User-defined label for this address

      up to 250 characters

    • token string
      Token identifier if this is a token address
    • balance object
      Balance information for this address
      balance object
      • balanceString string required
        String representation of the balance. Guaranteed to not lose precision.
      • confirmedBalanceString string required
        The total balance of confirmed transactions for the address (in the chain's base unit). Guaranteed to not lose precision.
      • spendableBalanceString string required
        The total balance of the address (in the chain's base unit) which may be used as inputs for creating new transactions in string representation. Guaranteed to not lose precision.
      • updated string
        The last time a transaction affected the balance of this address
      • balance number
      • lockedBalanceString string
      • reservedBalanceString string
      • totalReceived number
        The total amount received on this address (in the chain's base unit)
      • totalSent number
        The total amount sent from this address (in the chain's base unit)
      • transferCount number
      • tokens map of objects
        tokens object
        • <key> object
      • nfts map of objects
        nfts object
        • <key> object
      • unsupportedNfts map of objects
        unsupportedNfts object
        • <key> object
      • type object
      • metadata object
  • count number required
    Total count of addresses returned
400
Bad Request

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id
404
Not Found

Response Body

object

  • name string
    Error code
  • context map of objects required
    Properties that apply to a specific error name
    context object
    • <key> object
  • error string required
    Human-readable error message
  • requestId string required
    Client request id