What the API provides
- User authentication — register and log in players with email and password; receive short-lived access tokens and long-lived refresh tokens
- Coin economy — track each player’s
coins_balance, award or deduct coins based on game events, and convert coin balances to USD money balances - PayPal withdrawals — let players request real-money payouts; the API manages payout status (
pending,paid,failed) - Game configuration — fetch active game records including store URLs, game mode, ad settings, and version requirements
- Event tracking — ingest batches of named analytics events (such as
LevelCompleted,AdImpression, orIAPPurchase) with arbitrary custom data
Base URL
All endpoints are grouped under three path prefixes:| Prefix | Purpose |
|---|---|
/auth/* | Registration and login |
/v1/* | Game config, coin economy, withdrawals, app settings |
/ingest/* | Analytics event ingestion |
Response format
Every response uses a consistent envelope. Successful responses wrap the payload in adata key:
error object with a machine-readable code and a human-readable message:
Where to go next
Quickstart
Register a player, get a token, and make your first API call in under five minutes.
Authentication
Understand how JWT bearer tokens work and how to handle token expiry.
Coin economy
Learn how coin balances, USD conversion, and withdrawals fit together.
Event tracking
See the full list of event types and how to batch-ingest analytics events.
