API Reference

Get token balances for specified addresses

posthttps://gateway-api-testnet.circle.com/v1/balances

  • Reference
  • Playground

Returns the current available balance of each specified address across different domains

Body parameters
sources
array of objects
Required

List of sources to query balances from

domain
integer
Required

Domain to query balance from

depositor
string
Required

Address of the depositor to query balance for

token
string
Required

Token type to query balances for

Allowed valuesUSDC
Response
RequestChoose a language
C-LibcurlClojure-clj-httpC#-HttpClientC#-RestSharpGo-NewRequestHTTP-HTTP/1.1Java-AsyncHttpJava-java.net.httpJava-OkHttpJava-UnirestJavaScript-AxiosJavaScript-fetchJavaScript-jQueryJavaScript-XMLHttpRequestJSON-Native JSONKotlin-okhttpNode-AxiosNode-FetchNode-HTTPNode-RequestNode-UnirestObjective-C-NSURLSessionOCaml-CoHTTPPHP-cURLPHP-GuzzlePHP-HTTP v1PHP-HTTP v2Powershell-Invoke-RestMethodPowershell-Invoke-WebRequestPython-RequestsR-httrRuby-net::httpShell-cURLShell-HTTPieShell-WgetSwift-URLSession
ResponseChoose an example
200400404
1{
2  "token": "USDC",
3  "balances": [
4    {
5      "domain": 0,
6      "depositor": "",
7      "balance": ""
8    }
9  ]
10}
Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.
Developer TermsService TermsPrivacy PolicyAcceptable UseYour Privacy ChoicesYour Privacy ChoicesCookie Policy