> This page is for API Reference.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://okx-demo.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://okx-demo.ferndocs.com/_mcp/server.

# Get system status

GET https://www.okx.com/api/v5/system/status

Retrieve the scheduled, ongoing, and recently completed maintenance events for OKX systems, including upgrade windows and the services they affect. This endpoint can be used without authentication.

Reference: https://okx-demo.ferndocs.com/api/api-reference/status/get-status

## Request

### Query parameters

- `state` (enum, optional) — System maintenance status. If not filled, ongoing, pre_open, and scheduled events are returned by default.
  - Allowed values: `scheduled`, `ongoing`, `pre_open`, `completed`, `canceled`

## Response

### 200

Successful response

- `code` (string, optional) — Result code. `0` means success; any other value is an error code.
- `msg` (string, optional) — Error message. Empty on success.
- `data` (list of ApiV5SystemStatusGetResponsesContentApplicationJsonSchemaDataItems, optional)

## Types

### ApiV5SystemStatusGetResponsesContentApplicationJsonSchemaDataItems

- `title` (string, optional) — The title of the maintenance event.
- `state` (string, optional) — System maintenance status.
- `begin` (string, optional) — Begin time of the maintenance, Unix timestamp in milliseconds.
- `end` (string, optional) — End time of the maintenance, Unix timestamp in milliseconds.
- `preOpenBegin` (string, optional) — The time that the pre-open state begins, Unix timestamp in milliseconds. Applicable when the maintenance involves a matching engine upgrade.
- `href` (string, optional) — Link to the announcement page with detailed information about the maintenance.
- `serviceType` (string, optional) — Service type affected by the maintenance.
- `system` (string, optional) — Trading account mode affected. 1: Classic account; 2: Unified account.
- `scheDesc` (string, optional) — Description of the scheduled maintenance.
- `maintType` (string, optional) — Maintenance type. 1: Planned maintenance; 2: Temporary maintenance; 3: Emergency maintenance.
- `env` (string, optional) — Environment. 1: Production; 2: Demo trading.

## Examples

**Response**

```json
{
  "code": "0",
  "msg": "",
  "data": [
    {
      "title": "Trading account system upgrade (in batches of accounts)",
      "state": "completed",
      "begin": "1672823400000",
      "end": "1672823520000",
      "preOpenBegin": "",
      "href": "",
      "serviceType": "8",
      "system": "unified",
      "scheDesc": "",
      "maintType": "1",
      "env": "1"
    }
  ]
}
```

**SDK Code**

```python status_getStatus_example
import requests

url = "https://www.okx.com/api/v5/system/status"

response = requests.get(url)

print(response.json())
```

```javascript status_getStatus_example
const url = 'https://www.okx.com/api/v5/system/status';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go status_getStatus_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://www.okx.com/api/v5/system/status"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby status_getStatus_example
require 'uri'
require 'net/http'

url = URI("https://www.okx.com/api/v5/system/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
```

```java status_getStatus_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://www.okx.com/api/v5/system/status")
  .asString();
```

```php status_getStatus_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://www.okx.com/api/v5/system/status');

echo $response->getBody();
```

```csharp status_getStatus_example
using RestSharp;

var client = new RestClient("https://www.okx.com/api/v5/system/status");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
```

```swift status_getStatus_example
import Foundation

let request = NSMutableURLRequest(url: NSURL(string: "https://www.okx.com/api/v5/system/status")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```