curl --request GET \
--url https://api.relay.link/balance/{wallet}/eventsconst options = {method: 'GET'};
fetch('https://api.relay.link/balance/{wallet}/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.relay.link/balance/{wallet}/events"
response = requests.get(url)
print(response.text){
"wallet": "<string>",
"events": [
{
"id": "<string>",
"type": "fee-credit",
"requestId": "<string>",
"wallet": "<string>",
"delta": {
"currency": {
"chainId": 123,
"address": "<string>",
"symbol": "<string>",
"name": "<string>",
"decimals": 123,
"metadata": {
"logoURI": "<string>",
"verified": true,
"isNative": true
}
},
"amount": "<string>",
"amountFormatted": "<string>",
"amountUsd": "<string>"
},
"balanceAfter": {
"currency": {
"chainId": 123,
"address": "<string>",
"symbol": "<string>",
"name": "<string>",
"decimals": 123,
"metadata": {
"logoURI": "<string>",
"verified": true,
"isNative": true
}
},
"amount": "<string>",
"amountFormatted": "<string>",
"amountUsd": "<string>"
},
"details": {
"claimId": "<string>",
"fixedRate": "<string>",
"currencyIn": {
"chainId": 123,
"address": "<string>"
},
"currencyOut": {
"chainId": 123,
"address": "<string>"
},
"currencyOutAmount": "<string>",
"marketAmountOut": "<string>",
"requestIds": [
"<string>"
]
},
"createdAt": "<string>"
}
],
"continuation": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Get Balance Events
This API returns the history of balance movements for a wallet, including fee credits, fee sponsorship, fixed-rate settlement, deposits and withdrawals.
curl --request GET \
--url https://api.relay.link/balance/{wallet}/eventsconst options = {method: 'GET'};
fetch('https://api.relay.link/balance/{wallet}/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.relay.link/balance/{wallet}/events"
response = requests.get(url)
print(response.text){
"wallet": "<string>",
"events": [
{
"id": "<string>",
"type": "fee-credit",
"requestId": "<string>",
"wallet": "<string>",
"delta": {
"currency": {
"chainId": 123,
"address": "<string>",
"symbol": "<string>",
"name": "<string>",
"decimals": 123,
"metadata": {
"logoURI": "<string>",
"verified": true,
"isNative": true
}
},
"amount": "<string>",
"amountFormatted": "<string>",
"amountUsd": "<string>"
},
"balanceAfter": {
"currency": {
"chainId": 123,
"address": "<string>",
"symbol": "<string>",
"name": "<string>",
"decimals": 123,
"metadata": {
"logoURI": "<string>",
"verified": true,
"isNative": true
}
},
"amount": "<string>",
"amountFormatted": "<string>",
"amountUsd": "<string>"
},
"details": {
"claimId": "<string>",
"fixedRate": "<string>",
"currencyIn": {
"chainId": 123,
"address": "<string>"
},
"currencyOut": {
"chainId": 123,
"address": "<string>"
},
"currencyOutAmount": "<string>",
"marketAmountOut": "<string>",
"requestIds": [
"<string>"
]
},
"createdAt": "<string>"
}
],
"continuation": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}balanceAfter; any other wallet returns the events your integrator caused on it, plus deposits and settled withdrawals — a narrower result, not an error. For current balances rather than history, use Get App Fee Balances.Headers
API key. Required.
Path Parameters
Wallet address. A wallet linked to your integrator returns its full ledger; any other returns the events your integrator caused on it, plus deposits and settled withdrawals, which are public on-chain.
Query Parameters
Return only events belonging to this request.
Comma-separated request ids, at most 20 per call. Use a type and time range instead for a reconciliation sweep.
Comma-separated event types to filter by. Events matching any of the given types are returned. Omit for all. Supported values: fee-credit, fee-sponsorship-payment, fee-sponsorship-refund, gasless-refund, balance-withdraw, balance-deposit, gas-sponsorship-payment, fixed-rate-credit, fixed-rate-debit, fixed-bps-pnl, fast-fill-hold, fast-fill-release, admin-manual-adjustment.
Restrict to one chain.
Restrict to one currency. Pair with chainId for non-EVM currencies.
Only events created at or after this unix timestamp, in seconds.
Only events created at or before this unix timestamp, in seconds.
Maximum number of events to return per page.
1 <= x <= 50Pagination cursor returned by a previous response. Pass it back to fetch the next page.
Was this page helpful?