DAON SCP: SL API

https://help.daon.xyz/
Admin
The DAON SCP: SL API provides real-time and historical data, including server lists with extensive...
Tokens:5,404
Snippets:12
Trust Score:4.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example Server List Response

Source: https://help.daon.xyz/index

This is an example JSON response for the 'Get Server List' endpoint. It includes detailed information about a single server, such as its ID, account ID, IP address, player count, and configuration.

```json
[
  {
    "serverId": 87680,
    "accountId": 19126,
    "ip": "207.174.43.245",
    "port": 7783,
    "players": "15/25",
    "distance": 2180,
    "info": "PGNvbG9yPSNGRjhDMDA+V2VsY29tZSB0byB0aGUgU0NQIEZvdW5kYXRpb24hPC9jb2xvcj4=",
    "pastebin": "GmHsVgPG",
    "version": "14.1.0-release-beta-bab40c71",
    "privateBeta": false,
    "friendlyFire": false,
    "modded": false,
    "modFlags": 0,
    "whitelist": false,
    "isoCode": "CA",
    "continentCode": "NA",
    "latitude": 45.499,
    "longitude": -73.585,
    "official": "REGIONAL OFFICIAL",
    "officialCode": 2,
    "displaySection": 1
  }
]
```

--------------------------------

### GET / - Get Server List

Source: https://help.daon.xyz/index

Retrieves a list of available game servers. You can filter and sort the results using query parameters.

```APIDOC
## GET /

### Description
Retrieves a list of available game servers. You can filter and sort the results using query parameters.

### Method
GET

### Endpoint
/

### Parameters
#### Query Parameters
- **fields** (string[]) - Optional - Comma-separated list of server object fields to include in the response. If omitted, all fields are returned.
- **limit** (integer) - Optional - Maximum number of server results to return. Use this parameter to reduce response size and improve performance for large datasets. Required range: `1 <= x <= 1000`
- **sortBy** (enum<string>) - Optional - Field to sort results by. Use `distance` to sort by distance from your location or `players` to sort by current player count (most populated first). Available options: `distance`, `players`
- **minPlayers** (integer) - Optional - Filter servers to show only those with at least this many current players. Required range: `x >= 0`
- **maxPlayers** (integer) - Optional - Filter servers to show only those with at most this many current players. Required range: `x >= 0`
- **isoCode** (string) - Optional - Filter servers by country using ISO 3166-1 alpha-2 code
- **modded** (boolean) - Optional - Filter servers by modded status
- **friendlyFire** (boolean) - Optional - Filter servers by friendly fire setting
- **whitelist** (boolean) - Optional - Filter servers by whitelist status
- **official** (enum<string>) - Optional - Filter servers by official status label. Available options: `REGIONAL OFFICIAL`, `LOCAL OFFICIAL`
- **continentCode** (string) - Optional - Filter servers by continent code
- **privateBeta** (boolean) - Optional - Filter servers by private beta status

### Request Example
```bash
curl --request GET \
  --url https://nwapi.daon.xyz/
```

### Response
#### Success Response (200)
- **serverId** (integer) - Unique identifier for the server.
- **accountId** (integer) - The account ID associated with the server.
- **ip** (string) - The IP address of the server.
- **port** (integer) - The port number the server is running on.
- **players** (string) - Current number of players and the maximum capacity (e.g., "15/25").
- **distance** (number) - The distance to the server from the user's location.
- **info** (string) - Base64 encoded server information string.
- **pastebin** (string) - A pastebin identifier for server details.
- **version** (string) - The version of the game the server is running.
- **privateBeta** (boolean) - Indicates if the server is part of a private beta.
- **friendlyFire** (boolean) - Indicates if friendly fire is enabled.
- **modded** (boolean) - Indicates if the server is running mods.
- **modFlags** (integer) - Flags related to server modifications.
- **whitelist** (boolean) - Indicates if the server has a whitelist enabled.
- **isoCode** (string) - The ISO 3166-1 alpha-2 country code of the server's location.
- **continentCode** (string) - The continent code of the server's location.
- **latitude** (number) - The latitude coordinate of the server's location.
- **longitude** (number) - The longitude coordinate of the server's location.
- **official** (string) - The official status label of the server.
- **officialCode** (integer) - A numerical code representing the official status.
- **displaySection** (integer) - A section identifier for display purposes.

#### Response Example
```json
[
  {
    "serverId": 87680,
    "accountId": 19126,
    "ip": "207.174.43.245",
    "port": 7783,
    "players": "15/25",
    "distance": 2180,
    "info": "PGNvbG9yPSNGRjhDMDA+V2VsY29tZSB0byB0aGUgU0NQIEZvdW5kYXRpb24hPC9jb2xvcj4=",
    "pastebin": "GmHsVgPG",
    "version": "14.1.0-release-beta-bab40c71",
    "privateBeta": false,
    "friendlyFire": false,
    "modded": false,
    "modFlags": 0,
    "whitelist": false,
    "isoCode": "CA",
    "continentCode": "NA",
    "latitude": 45.499,
    "longitude": -73.585,
    "official": "REGIONAL OFFICIAL",
    "officialCode": 2,
    "displaySection": 1
  }
]
```
```

--------------------------------

### Get Server List with cURL

Source: https://help.daon.xyz/index

This snippet demonstrates how to retrieve a list of available servers using the cURL command-line tool. It sends a GET request to the root endpoint of the Daon XYZ API.

```shell
curl --request GET \
  --url https://nwapi.daon.xyz/
```

--------------------------------

### OpenAPI Specification for GET /stats/{serverId}

Source: https://help.daon.xyz/api-reference/historical-data/get-historical-server-metrics

This snippet defines the GET endpoint '/stats/{serverId}' in OpenAPI format. It specifies the server URL, request parameters (path, query), expected response formats for success (200) and errors (400, 404, 500), and includes example responses. The `ServerMetrics` schema is also defined.

```yaml
openapi.json
```

--------------------------------

### GET /websites/help_daon_xyz

Source: https://help.daon.xyz/api-reference/real-time-data/get-server-list

Retrieves a list of SCP:SL game servers matching the specified criteria. Supports filtering by various attributes and sorting by distance from the client.

```APIDOC
## GET /websites/help_daon_xyz

### Description
Retrieves a list of SCP:SL game servers. The response can include filtered fields or be sorted by distance from the client.

### Method
GET

### Endpoint
/websites/help_daon_xyz

### Parameters
#### Query Parameters
- **ip** (string) - Optional - The IP address of the server.
- **port** (integer) - Optional - The port number of the server.
- **players** (string) - Optional - Filter by current and maximum players (e.g., "15/25").
- **isoCode** (string) - Optional - Filter by ISO 3166-1 alpha-2 country code.
- **sortByDistance** (boolean) - Optional - If true, sorts the results by distance from the client.

### Request Example
```json
{
  "example": "Not applicable for GET request, parameters are in query string"
}
```

### Response
#### Success Response (200)
- **ip** (string) - IPv4 address of the server.
- **port** (integer) - Port number to connect to the server.
- **players** (string) - Current players / Max players.
- **isoCode** (string) - ISO 3166-1 alpha-2 country code of server location.
- **_distanceFromClient** (number) - Calculated distance in kilometers from client IP (present only if sorted by distance).

#### Response Example
```json
{
  "example": [
    {
      "ip": "207.174.43.245",
      "port": 7783,
      "players": "15/25",
      "isoCode": "CA",
      "_distanceFromClient": 150.7
    }
  ]
}
```

#### Error Response (500)
- **error** (string) - A summary of the error.
- **details** (string, nullable) - Optional additional details about the error.

#### Error Response Example
```json
{
  "example": {
    "error": "Failed to process request",
    "details": "Invalid parameter value for 'limit'"
  }
}
```
```

--------------------------------

### GET /

Source: https://help.daon.xyz/api-reference/real-time-data/get-server-list

Retrieves a list of available game servers. This endpoint supports filtering, sorting, and field selection to customize the response.

```APIDOC
## GET /

### Description
Retrieves a list of available game servers. This endpoint supports filtering, sorting, and field selection to customize the response.

### Method
GET

### Endpoint
/

### Parameters
#### Query Parameters
- **fields** (array of strings) - Optional - Comma-separated list of server object fields to include in the response. If omitted, all fields are returned. Possible values: `serverId`, `accountId`, `ip`, `port`, `players`, `distance`, `info`, `pastebin`, `version`, `privateBeta`, `friendlyFire`, `modded`, `modFlags`, `whitelist`, `isoCode`, `continentCode`, `latitude`, `longitude`, `official`, `officialCode`, `displaySection`, `_distanceFromClient`, `_currentPlayers`, `_maxPlayers`
- **limit** (integer) - Optional - Maximum number of server results to return. Use this parameter to reduce response size and improve performance for large datasets. Minimum: 1, Maximum: 1000
- **sortBy** (enum<string>) - Optional - Field to sort results by. Use `distance` to sort by distance from your location or `players` to sort by current player count (most populated first). Possible values: `distance`, `players`
- **minPlayers** (integer) - Optional - Filter servers to show only those with at least this many current players. Minimum: 0
- **maxPlayers** (integer) - Optional - Filter servers to show only those with at most this many current players. Minimum: 0
- **isoCode** (string) - Optional - Filter servers by country using ISO 3166-1 alpha-2 code
- **modded** (boolean) - Optional - Filter servers by modded status
- **friendlyFire** (boolean) - Optional - Filter servers by friendly fire setting
- **whitelist** (boolean) - Optional - Filter servers by whitelist status
- **official** (enum<string>) - Optional - Filter servers by official status label. Possible values: `REGIONAL OFFICIAL`, `LOCAL OFFICIAL`
- **continentCode** (string) - Optional - Filter servers by continent code
- **privateBeta** (boolean) - Optional - Filter servers by private beta status

### Request Example
```json
{
  "query": {
    "fields": "serverId,ip,players",
    "limit": 50,
    "sortBy": "players",
    "modded": false
  }
}
```

### Response
#### Success Response (200)
- **serverId** (integer) - Unique identifier for the server.
- **accountId** (integer) - The account ID associated with the server.
- **ip** (string) - The IP address of the server.
- **port** (integer) - The port number the server is running on.
- **players** (string) - Current player count in the format 'current/max'.
- **distance** (number) - Distance to the server from the client's location.
- **info** (string) - Server information, potentially base64 encoded.
- **pastebin** (string) - Pastebin ID for server logs or information.
- **version** (string) - The version of the game running on the server.
- **privateBeta** (boolean) - Indicates if the server is part of a private beta.
- **friendlyFire** (boolean) - Indicates if friendly fire is enabled.
- **modded** (boolean) - Indicates if the server is running mods.
- **modFlags** (integer) - Flags related to server mods.
- **whitelist** (boolean) - Indicates if the server requires a whitelist.
- **isoCode** (string) - ISO 3166-1 alpha-2 country code.
- **continentCode** (string) - Continent code.
- **latitude** (number) - Latitude coordinate of the server's location.
- **longitude** (number) - Longitude coordinate of the server's location.
- **official** (string) - The official status of the server (e.g., "REGIONAL OFFICIAL").

#### Response Example
```json
[
  {
    "serverId": 87680,
    "accountId": 19126,
    "ip": "207.174.43.245",
    "port": 7783,
    "players": "15/25",
    "distance": 2180,
    "info": "PGNvbG9yPSNGRjhDMDA+V2VsY29tZSB0byB0aGUgU0NQIEZvdW5kYXRpb24hPC9jb2xvcj4=",
    "pastebin": "GmHsVgPG",
    "version": "14.1.0-release-beta-bab40c71",
    "privateBeta": false,
    "friendlyFire": false,
    "modded": false,
    "modFlags": 0,
    "whitelist": false,
    "isoCode": "CA",
    "continentCode": "NA",
    "latitude": 45.499,
    "longitude": -73.585,
    "official": "REGIONAL OFFICIAL"
  }
]
```
```

--------------------------------

### GET /

Source: https://help.daon.xyz/index

Retrieves a list of game servers matching the criteria. This endpoint provides detailed information about each server, including its ID, IP address, player count, location, and mod status.

```APIDOC
## GET /

### Description
Retrieves a list of game servers matching the criteria. This endpoint provides detailed information about each server, including its ID, IP address, player count, location, and mod status.

### Method
GET

### Endpoint
/

### Parameters
#### Query Parameters
- **_where** (string) - Optional - A query string to filter servers based on various criteria (e.g., `_where=modded=true`).
- **_sort** (string) - Optional - A field to sort the server list by (e.g., `_sort=distance`).
- **_order** (string) - Optional - The order to sort the list by (`asc` or `desc`).
- **_limit** (integer) - Optional - The maximum number of servers to return.
- **_offset** (integer) - Optional - The number of servers to skip from the beginning of the list.
- **clientInfo** (boolean) - Optional - If true, includes `_distanceFromClient`, `_currentPlayers`, and `_maxPlayers` in the response.

### Request Example
```json
{
  "example": "curl --request GET \n  --url \"https://nwapi.daon.xyz/?_where=modded=true&clientInfo=true\""
}
```

### Response
#### Success Response (200)
- **serverId** (integer) - Unique identifier for the server.
- **accountId** (integer) - Account ID of the server owner.
- **ip** (string) - IPv4 address of the server.
- **port** (integer) - Port number to connect to the server.
- **players** (string) - Current players / Max players.
- **distance** (integer) - Original distance metric from source API.
- **info** (string) - Base64 encoded server name/description with Unity Rich Text.
- **pastebin** (string) - Pastebin ID for server rules or additional information.
- **version** (string) - Game version running on the server.
- **privateBeta** (boolean) - Whether the server is running a private beta version.
- **friendlyFire** (boolean) - Whether friendly fire is enabled on the server.
- **modded** (boolean) - Whether the server is running mods.
- **modFlags** (integer) - Bit flags indicating which mods are running.
- **whitelist** (boolean) - Whether the server requires whitelist to join.
- **isoCode** (string) - ISO 3166-1 alpha-2 country code of server location.
- **continentCode** (string) - Two-letter continent code of server location.
- **latitude** (number) - Geographic latitude of server location.
- **longitude** (number) - Geographic longitude of server location.
- **official** (string) - Official status label of the server.
- **officialCode** (integer) - Numeric code indicating official status level.
- **displaySection** (integer) - Section where server should be displayed in the game UI.
- **_distanceFromClient** (number | null) - Calculated distance in kilometers from client IP (present only if `clientInfo=true` and sorted by distance).
- **_currentPlayers** (integer | null) - Extracted current player count (present only if `clientInfo=true`).
- **_maxPlayers** (integer | null) - Extracted maximum player capacity (present only if `clientInfo=true`).

#### Response Example
```json
{
  "example": "[
  {
    "serverId": 87680,
    "accountId": 19126,
    "ip": \"207.174.43.245\",
    "port": 7783,
    "players": \"15/25\",
    "distance": 2180,
    "info": \"PGNvbG9yPSNGRjhDMDA+V2VsY29tZSB0byB0aGUgU0NQIEZvdW5kYXRpb24hPC9jb2xvcj4=\",
    "pastebin": \"GmHsVgPG\",
    "version": \"14.1.0-release-beta-bab40c71\",
    "privateBeta": false,
    "friendlyFire": false,
    "modded": false,
    "modFlags": 0,
    "whitelist": false,
    "isoCode": \"CA\",
    "continentCode": \"NA\",
    "latitude": 45.499,
    "longitude": -73.585,
    "official": \"REGIONAL OFFICIAL\",
    "officialCode": 2,
    "displaySection": 1
  }
]"
}
```
```

--------------------------------

### GET /timestamp

Source: https://help.daon.xyz/api-reference/real-time-data/get-data-timestamp

Retrieves the Unix millisecond timestamp of the last time the server list data was successfully fetched and stored. This can be used to determine data freshness and cache invalidation strategies.

```APIDOC
## GET /timestamp

### Description
Retrieves the Unix millisecond timestamp of the last time the server list data was successfully fetched and stored. This can be used to determine data freshness and cache invalidation strategies.

### Method
GET

### Endpoint
/timestamp

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "No request body for GET request"
}
```

### Response
#### Success Response (200)
- **timestamp** (integer) - Unix millisecond timestamp when data was last fetched

#### Response Example
```json
{
  "timestamp": 1678886400000
}
```

#### Error Response (404)
- **error** (string) - A summary of the error.
- **details** (string, nullable) - Optional additional details about the error.

#### Error Response Example (404)
```json
{
  "error": "No data available yet."
}
```

#### Error Response (500)
- **error** (string) - A summary of the error.
- **details** (string, nullable) - Optional additional details about the error.

#### Error Response Example (500)
```json
{
  "error": "Failed to fetch timestamp"
}
```
```

--------------------------------

### GET /stats/{serverId}

Source: https://help.daon.xyz/api-reference/historical-data/get-historical-server-metrics

Retrieves historical server metrics for a given server ID. The time intervals for the metrics are automatically determined based on the time range requested.

```APIDOC
## GET /stats/{serverId}

### Description
Retrieves historical server metrics for a given server ID. The time intervals for the metrics are automatically determined based on the time range requested.

### Method
GET

### Endpoint
https://historical-scp.daon.xyz/stats/{serverId}

### Parameters
#### Path Parameters
- **serverId** (integer) - Required - Unique identifier of the server

#### Query Parameters
- **start** (string) - Optional - Start time in RFC3339 format (e.g., 2024-01-01T00:00:00Z). If not specified, defaults to 24 hours before end time.
- **end** (string) - Optional - End time in RFC3339 format. If not specified, defaults to current time.

### Request Example
```json
{
  "example": "No request body for GET request"
}
```

### Response
#### Success Response (200)
- **time** (string) - Start time of the interval
- **players_current** (number) - Average number of players during the interval
- **players_max** (integer) - Maximum player capacity during the interval

#### Response Example
```json
{
  "example": [
    {
      "time": "2024-01-01T00:00:00Z",
      "players_current": 15.5,
      "players_max": 25
    },
    {
      "time": "2024-01-01T00:15:00Z",
      "players_current": 16.2,
      "players_max": 25
    }
  ]
}
```

#### Error Response (400)
- **error** (string) - A summary of the error.
- **details** (string) - Optional additional details about the error.

#### Error Response Example (400)
```json
{
  "example": {
    "error": "Invalid time format",
    "details": "Use RFC3339 format (e.g., 2024-01-01T00:00:00Z)"
  }
}
```

#### Error Response (404)
- **error** (string) - A summary of the error.
- **details** (string) - Optional additional details about the error.

#### Error Response Example (404)
```json
{
  "example": {
    "error": "No data available",
    "details": "No metrics found for server 87680 in the specified time range"
  }
}
```

#### Error Response (500)
- **error** (string) - A summary of the error.
- **details** (string) - Optional additional details about the error.

#### Error Response Example (500)
```json
{
  "example": {
    "error": "Failed to retrieve server stats",
    "details": "Database connection error"
  }
}
```
```

--------------------------------

### Data Timestamp API

Source: https://help.daon.xyz/index

Retrieves the Unix millisecond timestamp of the last time the server list data was successfully fetched and stored. This can be used to determine data freshness and cache invalidation strategies.

```APIDOC
## GET /timestamp

### Description
Retrieves the Unix millisecond timestamp of the last time the server list data was successfully fetched and stored. This can be used to determine data freshness and cache invalidation strategies.

### Method
GET

### Endpoint
/timestamp

### Parameters
None

### Request Example
```json
{
  "example": "curl --request GET \n  --url https://nwapi.daon.xyz/timestamp"
}
```

### Response
#### Success Response (200)
- **timestamp** (integer) - The Unix millisecond timestamp of the last data fetch.

#### Response Example
```json
{
  "example": "{\"timestamp\": 1678886400000}"
}
```
```
Tokens:
Raw