Skip to main content
GET
Get platform status

Authorizations

X-Api-Key
string
header
required

Partner / integrator key — format ps_live_<keyId>_<secret>. Partner keys are issued by PredictStreet; a user can also create keys bound to their own wallet from their account settings in the web app. Never ship to a browser. multi_wallet partners must additionally send X-User-Wallet: 0x<40-hex> on every authenticated request to declare the acting wallet. See the API keys guide for scope taxonomy, partner kinds, rate limits, and rotation procedure.

Response

OK

frozen
boolean
required

true while the platform-wide freeze is engaged. See GET /api/platform/status for which calls it blocks.

reason
string | null
required

Reason given for the freeze. null when not frozen.

since
string<date-time> | null
required

ISO-8601 — when the freeze began. null when not frozen.

activeNotices
string[]
required

Ids of the notices currently in effect — the same notices GET /api/platform/notices returns.

maintenance
object

Absent in an environment where the maintenance feature is switched off — treat a missing object as "no information", never as "everything is fine".