Reference

Scopes

Reference for operator API key scopes.

Scopes

Current scope list comes from operator API key creation source.

Supported scopes

launch:write
users:read
markets:read
markets:write
trades:read
redemptions:read
balance_operations:read
wallet_adapter:read
wallet_adapter:write
api_keys:read
api_keys:write
webhooks:read
webhooks:write
simulator:read
simulator:write
staffs:read staff-session only
staffs:write staff-session only
*

* means full API-key access for API keys and full dashboard access for staff sessions.

API keys cannot be created with staffs:read or staffs:write. Those scopes are assignable only to dashboard staff memberships.

Endpoint mapping

Scope	Endpoints
`launch:write`	`POST /api/operator/launch`, `POST /api/operator/users/portfolio-view`
`users:read`	`GET /api/operator/users`, `GET /api/operator/users/portfolio`, `GET /api/operator/users/portfolio-view`, `POST /api/operator/users/portfolio-view`
`markets:read`	`GET /api/operator/markets`, `GET /api/operator/markets/trending`
`markets:write`	`POST /api/operator/markets/{id}/visibility`
`trades:read`	`GET /api/operator/trades`, `GET /api/operator/trades/{tradeId}`, `GET /api/operator/trades/{tradeId}/view`, `GET /api/operator/trades/{marketId}/{externalUserId}`
`redemptions:read`	`GET /api/operator/resolutions`, `GET /api/operator/redemptions`
`balance_operations:read`	`GET /api/operator/balance-operations`
`wallet_adapter:read`	`GET /api/operator/wallet-adapter`
`wallet_adapter:write`	`PUT /api/operator/wallet-adapter`, `POST /api/operator/wallet-adapter/test`
`api_keys:read`	`GET /api/operator/api-keys`
`api_keys:write`	`POST /api/operator/api-keys`, `POST /api/operator/api-keys/{id}/revoke`
`webhooks:read`	`GET /api/operator/webhooks/endpoints`, `GET /api/operator/webhooks/deliveries`
`webhooks:write`	`POST /api/operator/webhooks/endpoints`, `PATCH /api/operator/webhooks/endpoints/{id}`, `DELETE /api/operator/webhooks/endpoints/{id}`, `POST /api/operator/webhooks/endpoints/{id}/delete`, `POST /api/operator/webhooks/deliveries/{id}/replay`
`simulator:read`	`GET /api/operator/simulator/users`, `GET /api/operator/simulator/users/{id}`, `GET /api/operator/simulator/wallets/{externalUserId}`
`simulator:write`	`POST /api/operator/simulator/users`, `PATCH /api/operator/simulator/users/{id}`, `POST /api/operator/simulator/users/{id}/operations`, `PUT /api/operator/simulator/wallets/{externalUserId}`, `POST /api/operator/simulator/operations`
`staffs:read`	`GET /api/operator/staff` with staff-session auth only
`staffs:write`	`POST /api/operator/staff`, `PATCH /api/operator/staff/{id}`, `POST /api/operator/staff/{id}/reset-password` with staff-session auth only

Recommended key split

server-side launch key: launch:write
reporting key: read scopes only
webhook admin key: webhooks:read, webhooks:write
wallet adapter admin key: wallet_adapter:read, wallet_adapter:write
simulator key for staging only: simulator:read, simulator:write
staff access stays in staff sessions, not API keys

Rotation rule

Do not reuse one broad key everywhere. Split by workload and rotate independently.

Edit this pageorReport an issue

Statuses

Reference for order, payout, webhook, and operator statuses.

Units and money

Reference for IDR, credits-equivalent, shares, FX, and basis points.