List players
curl --request GET \
--url https://controller.platform.simplecloud.app/v0/players \
--header 'X-Network-ID: <x-network-id>' \
--header 'X-Network-Secret: <x-network-secret>'import requests
url = "https://controller.platform.simplecloud.app/v0/players"
headers = {
"X-Network-ID": "<x-network-id>",
"X-Network-Secret": "<x-network-secret>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Network-ID': '<x-network-id>', 'X-Network-Secret': '<x-network-secret>'}
};
fetch('https://controller.platform.simplecloud.app/v0/players', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://controller.platform.simplecloud.app/v0/players",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Network-ID: <x-network-id>",
"X-Network-Secret: <x-network-secret>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://controller.platform.simplecloud.app/v0/players"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Network-ID", "<x-network-id>")
req.Header.Add("X-Network-Secret", "<x-network-secret>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://controller.platform.simplecloud.app/v0/players")
.header("X-Network-ID", "<x-network-id>")
.header("X-Network-Secret", "<x-network-secret>")
.asString();require 'uri'
require 'net/http'
url = URI("https://controller.platform.simplecloud.app/v0/players")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Network-ID"] = '<x-network-id>'
request["X-Network-Secret"] = '<x-network-secret>'
response = http.request(request)
puts response.read_body{
"count": 25,
"players": [
{
"connected_proxy_name": "proxy-1",
"connected_server_name": "lobby-1",
"display_name": "Steve",
"first_seen": "2023-01-01T12:00:00Z",
"id": "069a79f4-44e9-4726-a5be-fca90e38aaf5",
"last_seen": "2023-06-15T18:30:00Z",
"name": "Steve",
"online": true,
"online_time_seconds": 36000,
"playtime_seconds": 36000,
"properties": {},
"session_id": "sess_abc123"
}
],
"total": 1000
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}players
List players
Get a list of players for a network with optional filtering
GET
/
v0
/
players
List players
curl --request GET \
--url https://controller.platform.simplecloud.app/v0/players \
--header 'X-Network-ID: <x-network-id>' \
--header 'X-Network-Secret: <x-network-secret>'import requests
url = "https://controller.platform.simplecloud.app/v0/players"
headers = {
"X-Network-ID": "<x-network-id>",
"X-Network-Secret": "<x-network-secret>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Network-ID': '<x-network-id>', 'X-Network-Secret': '<x-network-secret>'}
};
fetch('https://controller.platform.simplecloud.app/v0/players', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://controller.platform.simplecloud.app/v0/players",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Network-ID: <x-network-id>",
"X-Network-Secret: <x-network-secret>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://controller.platform.simplecloud.app/v0/players"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Network-ID", "<x-network-id>")
req.Header.Add("X-Network-Secret", "<x-network-secret>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://controller.platform.simplecloud.app/v0/players")
.header("X-Network-ID", "<x-network-id>")
.header("X-Network-Secret", "<x-network-secret>")
.asString();require 'uri'
require 'net/http'
url = URI("https://controller.platform.simplecloud.app/v0/players")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Network-ID"] = '<x-network-id>'
request["X-Network-Secret"] = '<x-network-secret>'
response = http.request(request)
puts response.read_body{
"count": 25,
"players": [
{
"connected_proxy_name": "proxy-1",
"connected_server_name": "lobby-1",
"display_name": "Steve",
"first_seen": "2023-01-01T12:00:00Z",
"id": "069a79f4-44e9-4726-a5be-fca90e38aaf5",
"last_seen": "2023-06-15T18:30:00Z",
"name": "Steve",
"online": true,
"online_time_seconds": 36000,
"playtime_seconds": 36000,
"properties": {},
"session_id": "sess_abc123"
}
],
"total": 1000
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Query Parameters
Filter by online status
Filter by connected server
Search by name
Sort by field (name, last_login, online_time, first_login)
Sort order (asc, desc)
Limit results (default 50)
Offset for pagination
Was this page helpful?
⌘I