Console Account API

Console account management API: SIWE wallet login, identities, API keys, plans, balance, charges, topups, usage and reset chances.

These are console account management APIs. Product APIs (JSON-RPC, Data API and WebSocket) do not depend on them. Authenticate account-specific requests with the session token returned by SIWE login.

Download OpenAPI spec

Endpoint index

Auth

MethodPathSummary
POST/auth/siwe/challengeGet SIWE message
POST/auth/siwe/loginSIWE login (first login creates account)
POST/auth/logoutLog out current session

Me

MethodPathSummary
GET/meCurrent username, identity list, and current session
PATCH/meUpdate username
POST/me/identities/siweLink wallet
POST/me/identities/oauthLink GitHub or Google identity using login code
DELETE/me/identities/{identity_id}Unlink identity

Keys

MethodPathSummary
GET/keysList API keys
POST/keysCreate key (secret displayed only once)
GET/keys/{key_id}Single key
PATCH/keys/{key_id}Rename key
POST/keys/{key_id}/rotateRotate key (new secret displayed only once)
POST/keys/{key_id}/revokeRevoke key (idempotent)

Billing

MethodPathSummary
GET/plansPlan policies and pricing parameters
GET/balanceBalance and settlement cutoff timestamp
GET/chargesCharge records (paginated)
GET/topupsTop-up records (paginated)
GET/usageCalls and CU usage grouped by UTC date, API key, chain, and method
GET/resetsReset chances
POST/resets/useUse one reset chance

Last updated:

On this page