Skip to main content
Use these endpoints for reporting and reconciliation from your backend. Authenticate with x-app-api-key; x-app-id and a user token are not required. The {appId} in the path must match the key’s app. A read key can access every user in that app. A trade key is rejected on these routes: it can trade as a signed-in user, and it cannot list users or orders. First create a server API key. For a signed-in user’s activity screen or the app leaderboard, follow Portfolio. AggAdminClient provides methods for users, orders, analytics, and market-resolution holders. Use admin.request() for the per-user reads below. Manage app members and settings in the admin dashboard.

Users

Full shape on List users.
Full shape on Get user.

Balances, positions, orders

Full shape on Get user balances.
Full shape on Get user positions.
Full shape on Get user orders.
Full shape on List orders across your app. This feed is ordered by last update. Upsert by id.

Deposits and withdrawals

Full shape on Get user deposits. amountRaw is an integer string in the token’s decimals.
Full shape on Get user withdrawals. errorMessage is the reason a failed or partial withdrawal did not fully deliver, so your server can show it without the user’s session. Show it, but do not match on the text, since the wording can change.

Analytics and resolution

Full shape on Get analytics. Cash and position values reflect current holdings; fees are cumulative. usersLast7Days, usersLast30Days, ordersLast7Days, and ordersLast30Days cover the named rolling windows.
Full shape on List users affected by market resolution.