cURL
curl --request GET \
--url https://api.relay.link/withdrawals/balancesconst options = {method: 'GET'};
fetch('https://api.relay.link/withdrawals/balances', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.relay.link/withdrawals/balances"
response = requests.get(url)
print(response.text){
"balances": [
{
"hubTokenId": "<string>",
"currency": {
"chainId": 123,
"address": "<string>",
"name": "<string>",
"symbol": "<string>",
"decimals": 123
},
"amount": "<string>",
"amountFormatted": "<string>",
"amountUsd": "<string>"
}
],
"continuation": "<string>"
}{
"message": "<string>",
"errorCode": "<string>"
}{
"message": "<string>",
"errorCode": "<string>"
}Withdrawals
Get Recovery Balances
List credited hub balances for a recovery owner
GET
/
withdrawals
/
balances
cURL
curl --request GET \
--url https://api.relay.link/withdrawals/balancesconst options = {method: 'GET'};
fetch('https://api.relay.link/withdrawals/balances', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.relay.link/withdrawals/balances"
response = requests.get(url)
print(response.text){
"balances": [
{
"hubTokenId": "<string>",
"currency": {
"chainId": 123,
"address": "<string>",
"name": "<string>",
"symbol": "<string>",
"decimals": 123
},
"amount": "<string>",
"amountFormatted": "<string>",
"amountUsd": "<string>"
}
],
"continuation": "<string>"
}{
"message": "<string>",
"errorCode": "<string>"
}{
"message": "<string>",
"errorCode": "<string>"
}How do programmatic withdrawals work?
Lists balances already credited to the recovery owner’s account on the hub. Deposits awaiting attestation or recovery are excluded — see Attest Deposit to credit eligible deposits. Discovery is eventually consistent.
ownerChainId is the numeric Relay chain id of the recovery owner’s account; Request Withdrawal takes protocol chain slugs. A returned balance does not guarantee withdrawal eligibility; the withdrawal flow checks eligibility and the executable amount.Headers
Optional API key for higher rate limits.
Query Parameters
Required string length:
1 - 256Required range:
1 <= x <= 9007199254740991Must be a multiple of 1Required range:
1 <= x <= 50Must be a multiple of 1Required string length:
1 - 512Was this page helpful?