Skip to main content
Fetch this endpoint once on app launch to configure your game client before the player sees any UI. The settings control whether the app is in maintenance mode, which app versions are supported, how frequently ads are shown, and the rules governing withdrawal requests.

Endpoint

No authentication is required.

Example request

Response

200 OK

The response data field is an array containing a single settings object.
string
The current app version string (e.g. "2.1.0").
boolean
If true, the app is in maintenance mode. Show a maintenance screen and prevent the player from proceeding.
string
The iOS App Store identifier for the application.
number
The minimum required version code. Force-update any client running a version code below this value before allowing access.
boolean
Whether ads are globally enabled across the platform. When false, suppress all ad requests regardless of per-game settings.
number
Show a post-game interstitial ad after every N games completed. A value of 1 means after every game. Per-game overrides take precedence when available.
number
The minimum USD amount a player must request in a single withdrawal. Reject withdrawal attempts below this threshold on the client before submitting.
number
The number of hours a player must wait between consecutive withdrawal requests. Enforce this on the client to avoid unnecessary 422 errors.
number
How often (in minutes) the server-side coin-to-USD conversion job runs. Use this to set a polling interval if you display a live balance.
string
The time of day when the first daily conversion runs (e.g. "12:00"). Use together with conversion_interval_minutes to predict upcoming conversion windows.
number
Number of seconds to wait after the app resumes from the background before refreshing the player’s profile data. Use this to throttle unnecessary refetch calls.
number
Number of seconds to wait after a coin conversion event before refreshing the player’s profile. Allows the server time to settle the new balance before your client reads it.