Skip to main content
GET

Endpoint

Headers

string
required
Your application API key
string
required
Your application secret key

Query Parameters

boolean
Filter wallets by active status.
number
Opt into pagination: return at most 1–1000 wallets. Omit this parameter to keep the existing full-list behavior.
number
default:"0"
Number of matching wallets to skip; must be zero or greater.
Case-insensitive literal substring search across wallet ID, user ID, balance text and currency. Maximum 200 characters; surrounding whitespace is ignored. Search the full matching list, not just the returned page.
string
default:"created_at"
Sort by created_at or balance before slicing the page.
string
default:"desc"
Sort asc or desc. ID ascending breaks ties.
boolean
default:"false"
Return X-Total-Count and X-Active-Count headers, plus X-Balance-By-Currency: a JSON object containing decimal strings, such as {"USD":"150.50","SLE":"25.00"}. Summaries cover all matching wallets after status/search filters, before pagination. Different currencies are never added together.

Pagination compatibility

The body remains an array. Use ?limit=50&offset=0&include_summary=true, then increment offset by 50. An empty or out-of-range page returns []. Records can change between requests; offset pages are not a snapshot or a bulk export. Invalid limits, negative offsets, invalid sort values or searches longer than 200 characters return HTTP 422. Existing requests without the new options keep returning the full list. Deploy the wallet API update before the dashboard update.

Response

An array of wallet objects.
array