v1
latestOpenAPI 3.0.02026-07-26117342409.6 KBReward Addresses
List reward addresses
Returns a paginated list of reward addresses
get/rewards/addresses
Query parameters
limitinteger
customer_idstring
Optional for public API - extracted from auth context if not provided.
ledger'PAXOS' | 'ETHEREUM' | 'SOLANA' | 'INK' | 'XLAYER' | 'ARBITRUM_ONE' | 'ROBINHOOD'
addressstring
order'DESC' | 'ASC'
Optional, sort order for results based on created_at. The default sort order is DESC.
page_cursorstring
Optional, cursor token for fetching the next page.
idstring
Optional, address id.
payout_group_idstring
Optional, filter by payout group. Pass the zero UUID (00000000-0000-0000-0000-000000000000) to return only addresses with no payout group assigned.
include_balanceboolean
When true, fetch and include balance for each address
balance_timestampstring date-time
Point-in-time for balance query (optional, defaults to now)
asset_typestring
When set, only addresses belonging to payout groups with this asset type are returned.
onchain_statusesstring[]
Optional, filter by one or more onchain registration statuses.
Response
A successful response.