Get token balances on a remote domain

Returns the expected token balances for a specified remote domain based on the deposit amounts made into xReserve.

GET /v1/balances/{remoteDomain}

Get token balances on a remote domain

cURL

curl --request GET \
  --url https://xreserve-api-testnet.circle.com/v1/balances/{remoteDomain}

200

{
  "balances": [
    {
      "token": "USDC",
      "balance": "1000000"
    }
  ]
}

Path Parameters

remoteDomain · integer · required

The remote domain ID by which to filter results.

Required range: x >= 0

Query Parameters

token · string

The token by which to query balances, such as USDC.

Response

200

application/json

Successfully retrieved balances.

Contains token balances for a remote domain.

balances · object[] · required

List token balance entries.

Show child attributes