> ## Documentation Index > Fetch the complete documentation index at: https://docs.adipredictstreet.com/llms.txt > Use this file to discover all available pages before exploring further. # Get platform status > Whether the platform-wide freeze is engaged, plus the ids of the notices currently in effect, in one call. Poll it to detect a freeze. While `frozen` is `true`, order placement (`POST /api/orders/place`, `POST /api/orders/place-batch`), `POST /api/orders/cancel-all`, gasless deposits, and withdrawal requests and cancellations are refused with `503 platform_frozen`. `POST /api/orders/cancel` and `POST /api/orders/cancel-batch` keep working so you can pull resting orders, and read endpoints stay available. A freeze of withdrawals alone does not set `frozen`, which stays specific to the platform-wide freeze: the withdrawal endpoints answer `503 withdrawals_frozen`, and when the `maintenance` object is present it shows as `maintenance.withdrawals.status` = `maintenance` with a null `windowId`. The `maintenance` object reports per-surface state, including a `degraded` reading taken from the same order-placement alert our own on-call acts on — see the Maintenance Notifications guide. Requires a partner API key in `X-Api-Key` (this endpoint used to be public); no scope and no `X-User-Wallet` header are needed. A self-service key minted from a retail account is refused with `403 partner_key_required`, and a signed-in user session (`Authorization: Bearer`) with `403 api_key_required_not_jwt`. It never answers `404`: where the maintenance feature is not switched on, the `maintenance` object is simply left out. Rate limit: 600 requests per minute per partner for this endpoint (all of your keys share it; it scales with your rate tier), plus 600 per minute per IP in one bucket that `status` and `notices` share. Cacheable for 5 seconds, privately: never in a shared cache, because the response is authenticated. `GET /api/platform/contracts` and `/fee-config` remain public and share a separate IP bucket. ## OpenAPI ````yaml /api-reference/openapi.json get /api/platform/status openapi: 3.1.0 info: title: PredictStreet API description: >- Client-facing HTTP API for the PredictStreet prediction-market platform. **Partner kinds.** Every authenticated endpoint except the partner-level platform reads (`/api/platform/status`, `/notices`, `/maintenance`) resolves a request's *effective wallet* from the partner row. `single_wallet` partners bind to one `associatedWallet` set at creation. `multi_wallet` partners declare the actor on every request via an `X-User-Wallet: 0x<40-hex>` header. See the [Partner kinds](/auth/api-keys#partner-kinds) doc for the full contract. version: '2026-06-16' contact: name: PredictStreet partners email: partners@predictstreet.com servers: - url: https://core-api.adipredictstreet.com description: Production — replace with the API host issued at partner onboarding. security: [] tags: - name: Deposits description: >- Gasless USDC deposit relay - submit a signed EIP-2612 permit and the platform broadcasts the on-chain deposit for you (no gas). - name: Events description: >- Polymarket-style event grouping with football metadata (group, stage, teams, tags). - name: Tags description: Curated tag taxonomy used to filter events. - name: Markets description: 'Public market data: list, detail, orderbook, trades, OHLC.' - name: Crypto description: >- Crypto price markets: the underlying-asset price curve and Up/Down series navigation. The markets themselves are ordinary binary markets — list them through /api/markets and /api/events. - name: Orders description: >- Signed-order place / cancel / read. Requires `X-Api-Key` with `orders:read` / `orders:write` scope; every write additionally requires an EIP-712 signature over the order. - name: Portfolio description: >- Balances, positions, trades, fees, vault info for the key's `associatedWallet`. Requires `X-Api-Key` with `portfolio:read` scope. - name: Matches description: >- A match groups several events into one fixture/card (1X2 + first-scorer + over-under under one matchup). - name: Vault description: >- Backend co-signatures for ERC-1155 split / merge, and recovery for off-chain locks when the corresponding chain tx never confirmed. Requires `X-Api-Key` with `vault:write` scope plus an EIP-712 signature over the operation. - name: Leaderboard description: Public ranked leaderboard across PnL / volume buckets. - name: Search description: Global search across users, events, and matches. - name: Withdrawal Security description: >- Self-service withdrawal 2FA (TOTP) and withdrawal-address whitelist. Same endpoints serve the web app (user sessions) and API-key integrators. Mutations need `vault:write`, reads `portfolio:read`. Both are opt-in per wallet and only gate withdrawals once the platform enables withdrawal-security enforcement. - name: Platform description: >- Platform reference data and state. The contract registry and the fee configuration are public and need no key. The freeze flag (`/status`), active notices (`/notices`) and maintenance windows (`/maintenance`) need a partner API key in `X-Api-Key`. paths: /api/platform/status: get: tags: - Platform summary: Get platform status description: >- Whether the platform-wide freeze is engaged, plus the ids of the notices currently in effect, in one call. Poll it to detect a freeze. While `frozen` is `true`, order placement (`POST /api/orders/place`, `POST /api/orders/place-batch`), `POST /api/orders/cancel-all`, gasless deposits, and withdrawal requests and cancellations are refused with `503 platform_frozen`. `POST /api/orders/cancel` and `POST /api/orders/cancel-batch` keep working so you can pull resting orders, and read endpoints stay available. A freeze of withdrawals alone does not set `frozen`, which stays specific to the platform-wide freeze: the withdrawal endpoints answer `503 withdrawals_frozen`, and when the `maintenance` object is present it shows as `maintenance.withdrawals.status` = `maintenance` with a null `windowId`. The `maintenance` object reports per-surface state, including a `degraded` reading taken from the same order-placement alert our own on-call acts on — see the Maintenance Notifications guide. Requires a partner API key in `X-Api-Key` (this endpoint used to be public); no scope and no `X-User-Wallet` header are needed. A self-service key minted from a retail account is refused with `403 partner_key_required`, and a signed-in user session (`Authorization: Bearer`) with `403 api_key_required_not_jwt`. It never answers `404`: where the maintenance feature is not switched on, the `maintenance` object is simply left out. Rate limit: 600 requests per minute per partner for this endpoint (all of your keys share it; it scales with your rate tier), plus 600 per minute per IP in one bucket that `status` and `notices` share. Cacheable for 5 seconds, privately: never in a shared cache, because the response is authenticated. `GET /api/platform/contracts` and `/fee-config` remain public and share a separate IP bucket. operationId: PlatformController_status parameters: [] responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PlatformStatusDto' '401': description: >- `auth_required`: no credentials. `api_key_*`: the key is malformed, unknown, revoked, expired, or called from outside its IP allowlist. content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: >- `partner_key_required`: authenticated with a self-service key minted from a retail account, not an onboarded partner key. `api_key_required_not_jwt`: authenticated with a user session (`Authorization: Bearer`) instead of `X-Api-Key`. content: application/json: schema: $ref: '#/components/schemas/Error' '429': $ref: '#/components/responses/RateLimited' security: - ApiKey: [] components: schemas: PlatformStatusDto: type: object properties: frozen: type: boolean description: >- `true` while the platform-wide freeze is engaged. See `GET /api/platform/status` for which calls it blocks. reason: type: string nullable: true description: Reason given for the freeze. `null` when not frozen. since: type: string format: date-time nullable: true description: ISO-8601 — when the freeze began. `null` when not frozen. activeNotices: type: array items: type: string description: >- Ids of the notices currently in effect — the same notices `GET /api/platform/notices` returns. maintenance: $ref: '#/components/schemas/MaintenanceStateDto' description: >- Absent in an environment where the maintenance feature is switched off — treat a missing object as "no information", never as "everything is fine". required: - frozen - reason - since - activeNotices Error: type: object description: >- Error body returned by every API error (same shape as `ErrorEnvelope`). Branch on `error.code`, not on `message`. required: - status - error properties: status: type: integer description: HTTP status, repeated in the body. example: 404 error: type: object required: - code - message properties: code: type: string description: >- Machine-readable code (e.g. `market_not_found`, `event_not_found`, `invalid_limit`). message: type: string trace_id: type: string description: Request trace id; quote it to support. May be absent. retryAfterSec: type: integer description: >- Seconds to wait before retrying, when the server says so (also sent as the `Retry-After` header). retryable: type: boolean description: >- Whether the same request may be sent again as it is. Absent when the server does not say. details: type: object additionalProperties: true description: >- Extra structured context thrown with the error, e.g. `slug`, `allowed`, `auditId`. MaintenanceStateDto: type: object description: >- Per-surface state. Only `trading` is ever reported as `degraded` — it is the surface we measure; `withdrawals` is `operational` unless a window or a kill switch covers it. properties: trading: $ref: '#/components/schemas/MaintenanceSurfaceStateDto' withdrawals: $ref: '#/components/schemas/MaintenanceSurfaceStateDto' required: - trading - withdrawals MaintenanceSurfaceStateDto: type: object properties: status: type: string enum: - operational - degraded - maintenance description: >- `operational` — nothing declared and order placement is within normal limits. `degraded` — order placement is failing more than usual; nobody switched anything off and no end time has been promised, so `windowId` is null. `maintenance` — deliberately unavailable: a declared window is running, or a kill switch is on. Treat this as an OPEN enum: branch on "is it operational" rather than matching the full set. windowId: type: string nullable: true description: >- The maintenance window explaining a `maintenance` status — look it up in `GET /api/platform/maintenance` for the copy and the expected end. Null when no window explains it: always under `operational` and `degraded`, and under `maintenance` when a kill switch caused it (the platform-wide freeze, or a withdrawals-only freeze). A null id under `maintenance` means the surface is still down, just unannounced, with no promised end to wait for. required: - status - windowId responses: RateLimited: description: >- Rate limit exceeded. `Retry-After` and `X-RateLimit-Reset` headers are set. headers: Retry-After: schema: type: integer X-RateLimit-Limit: schema: type: integer X-RateLimit-Remaining: schema: type: integer X-RateLimit-Reset: schema: type: integer content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: ApiKey: type: apiKey in: header name: X-Api-Key description: >- Partner / integrator key — format `ps_live__`. 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](/auth/api-keys) for scope taxonomy, partner kinds, rate limits, and rotation procedure. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.