Get token balances on a remote domain
curl --request GET \
--url https://xreserve-api-testnet.circle.com/v1/balances/{remoteDomain}import requests
url = "https://xreserve-api-testnet.circle.com/v1/balances/{remoteDomain}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://xreserve-api-testnet.circle.com/v1/balances/{remoteDomain}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://xreserve-api-testnet.circle.com/v1/balances/{remoteDomain}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://xreserve-api-testnet.circle.com/v1/balances/{remoteDomain}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://xreserve-api-testnet.circle.com/v1/balances/{remoteDomain}")
.asString();require 'uri'
require 'net/http'
url = URI("https://xreserve-api-testnet.circle.com/v1/balances/{remoteDomain}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"balances": [
{
"token": "USDC",
"balance": "1000000"
}
]
}{
"success": false,
"message": "Error message"
}{
"success": false,
"message": "Error message"
}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 --request GET \
--url https://xreserve-api-testnet.circle.com/v1/balances/{remoteDomain}import requests
url = "https://xreserve-api-testnet.circle.com/v1/balances/{remoteDomain}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://xreserve-api-testnet.circle.com/v1/balances/{remoteDomain}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://xreserve-api-testnet.circle.com/v1/balances/{remoteDomain}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://xreserve-api-testnet.circle.com/v1/balances/{remoteDomain}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://xreserve-api-testnet.circle.com/v1/balances/{remoteDomain}")
.asString();require 'uri'
require 'net/http'
url = URI("https://xreserve-api-testnet.circle.com/v1/balances/{remoteDomain}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"balances": [
{
"token": "USDC",
"balance": "1000000"
}
]
}{
"success": false,
"message": "Error message"
}{
"success": false,
"message": "Error message"
}Path Parameters
The remote domain ID by which to filter results.
Required range:
x >= 0Query Parameters
The token by which to query balances, such as USDC.
Response
Successfully retrieved balances.
Contains token balances for a remote domain.
List token balance entries.
Show child attributes
Show child attributes
Was this page helpful?
⌘I