Balances

Balance movements for one wallet: fee sponsorship, fixed-rate settlement, fee credits, deposits and withdrawals. A wallet linked to your integrator returns its full ledger with running balances; any other wallet returns the events your integrator caused on it, plus deposits and settled withdrawals, which are public on-chain. For current balances rather than history, use /app-fees/:wallet/balances.

get/balance/{wallet}/events

Request

  • Base URL: https://api.relay.link
  • URL: https://api.relay.link/balance/{wallet}/events
  • Auth: none declared

Path parameters

walletstring required

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

requestIdstring

Return only events belonging to this request.

requestIdsstring

Comma-separated request ids, at most 20 per call. Use a type and time range instead for a reconciliation sweep.

typestring

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.

chainIdnumber nullable

Restrict to one chain.

currencystring nullable

Restrict to one currency. Pair with chainId for non-EVM currencies.

startTimestampnumber nullable

Only events created at or after this unix timestamp, in seconds.

endTimestampnumber nullable

Only events created at or before this unix timestamp, in seconds.

limitnumber nullable

Maximum number of events to return per page.

continuationstring nullable

Pagination cursor returned by a previous response. Pass it back to fetch the next page.

Headers

x-api-keystring

API key. Required.

Response

Default Response

walletstring
continuationstring nullable

Changes