Public API V4

Maintenance status

The endpoint retrieves the current maintenance status of the WhiteBIT platform. Use the response to detect scheduled downtime and pause trading automation during maintenance windows. The status field returns "system operational" when all platform services are available, or "system maintenance" when the platform is undergoing planned maintenance.

get/api/v4/public/platform/status

Request

Base URL
https://whitebit.com
Auth
API key in header X-TXC-APIKEY and API key in header X-TXC-PAYLOAD and API key in header X-TXC-SIGNATURE
TypeScript
https://skmtc.dev/whitebit/apis/whitebit-private-http-api-v4/docs/api/v4/public/platform/status/get.ts
A function with typed inputs. Its response is checked against the schema.

Response

Successful response

status'system operational' | 'system maintenance' required

Platform operational state. "system operational" indicates all services are available. "system maintenance" indicates the platform is undergoing planned maintenance.

Example response

{
  "status": "system operational"
}

Changes

No recorded changes to this operation across all 1 revision of this API.

Maintenance status

Request

Response 200OK

Example response

Changes

Response