Skip to main content
POST
/
v1
/
balances
Get token balances for specified addresses
curl --request POST \
  --url https://gateway-api.circle.com/v1/balances \
  --header 'Content-Type: application/json' \
  --data '{
  "token": "USDC",
  "sources": [
    {
      "domain": 0,
      "depositor": "<string>"
    }
  ]
}'
{
  "token": "USDC",
  "balances": [
    {
      "domain": 0,
      "depositor": "<string>",
      "balance": "<string>"
    }
  ]
}

Body

application/json
​
token
enum<string>
required

Token type to query balances for

Available options:
USDC
​
sources
object[]
required

List of sources to query balances from

Response

Successfully retrieved balances

Response containing token balances for specified sources

​
token
enum<string>
required

Token type that was queried

Available options:
USDC
​
balances
object[]
required

List of balance responses for each source

⌘I