Partner admin

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. 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.

import { AggAdminClient } from "@agg-build/sdk/server";

const admin = new AggAdminClient({
  baseUrl: "https://api.agg.market",
  apiKey: process.env.AGG_APP_API_KEY!,
});

Users

const users = await admin.listUsers(appId, { limit: 20 });

curl -s -H "x-app-api-key: $AGG_APP_API_KEY" \
  "$API/apps/$APP_ID/users?limit=20"

Full shape on List users.

const user = await admin.getUser(appId, userId);

curl -s -H "x-app-api-key: $AGG_APP_API_KEY" \
  "$API/apps/$APP_ID/users/$USER_ID"

Full shape on Get user.

Balances, positions, orders

const balances = await admin.request(`/apps/${appId}/users/${userId}/balances`);

curl -s -H "x-app-api-key: $AGG_APP_API_KEY" \
  "$API/apps/$APP_ID/users/$USER_ID/balances"

Full shape on Get user balances.

const positions = await admin.request(`/apps/${appId}/users/${userId}/positions`);

curl -s -H "x-app-api-key: $AGG_APP_API_KEY" \
  "$API/apps/$APP_ID/users/$USER_ID/positions"

Full shape on Get user positions.

const orders = await admin.request(`/apps/${appId}/users/${userId}/orders`);

curl -s -H "x-app-api-key: $AGG_APP_API_KEY" \
  "$API/apps/$APP_ID/users/$USER_ID/orders"

Full shape on Get user orders.

const feed = await admin.listOrders(appId, { limit: 50 });

curl -s -H "x-app-api-key: $AGG_APP_API_KEY" \
  "$API/apps/$APP_ID/orders?limit=50"

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

Deposits and withdrawals

const deposits = await admin.request(`/apps/${appId}/users/${userId}/deposits`);

curl -s -H "x-app-api-key: $AGG_APP_API_KEY" \
  "$API/apps/$APP_ID/users/$USER_ID/deposits"

Full shape on Get user deposits. amountRaw is an integer string in the token’s decimals.

const withdrawals = await admin.request(`/apps/${appId}/users/${userId}/withdrawals`);

curl -s -H "x-app-api-key: $AGG_APP_API_KEY" \
  "$API/apps/$APP_ID/users/$USER_ID/withdrawals"

Full shape on Get user withdrawals.

Analytics and resolution

const analytics = await admin.getAnalytics(appId);

curl -s -H "x-app-api-key: $AGG_APP_API_KEY" \
  "$API/apps/$APP_ID/analytics"

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.

const holders = await admin.listMarketResolutionUsers(appId, venueMarketId, {
  includeEmails: true,
});

curl -s -H "x-app-api-key: $AGG_APP_API_KEY" \
  "$API/apps/$APP_ID/market-resolutions/$VENUE_MARKET_ID/users?includeEmails=true"

Full shape on List users affected by market resolution.

Start here

Core concepts

Account

Trading

Venues

Market data

Security

Real-time

Webhooks

Your users

UI Kit

Releases

Users

Balances, positions, orders

Deposits and withdrawals

Analytics and resolution

​Users

​Balances, positions, orders

​Deposits and withdrawals

​Analytics and resolution

Users

Balances, positions, orders

Deposits and withdrawals

Analytics and resolution