GET https://api.sonorancms.com/v2/community/erlc/players/online
Rate limit: 27 requests per minute
Authenticated v2 endpoints are rate limited per credential rather than per IP address.Retrieve the online ER:LC players.
Query Parameters
| Name | Type | Required | Description | | --- | --- | --- | --- | |robloxJoinCode | string | Yes | See example request for the shape. |
Example Request
- Sonoran.lua
- Sonoran.js
- Sonoran.py
- Sonoran.Net
- OpenAPI
- cURL
local Sonoran = require("sonoran")
local sonoran = Sonoran.createClient({
product = Sonoran.productEnums.CMS,
apiKey = "YOUR_API_KEY",
communityId = "YOUR_COMMUNITY_ID",
defaultServerId = 1,
timeoutMs = 30000,
})
local query = {
["robloxJoinCode"] = "ABC123"
}
local response = sonoran.cms:getOnlinePlayersV2(query)
if response.success then
print(response.data)
else
print(response.reason)
end
const Sonoran = require("sonoran.js");
const instance = Sonoran.instance({
apiKey: "YOUR_API_KEY",
communityId: "YOUR_COMMUNITY_ID",
product: Sonoran.productEnums.CMS,
serverId: 1,
});
async function main() {
const query = {
"robloxJoinCode": "ABC123"
};
const response = await instance.cms.getOnlinePlayersV2(query);
if (response.success) {
console.log(response.data);
} else {
console.error(response.reason);
}
}
main().catch((error) => {
console.error(error);
});
from sonoran import Instance, productEnums
instance = Instance(
apiKey="YOUR_API_KEY",
communityId="YOUR_COMMUNITY_ID",
product=productEnums.CMS,
serverId=1,
)
query = {
"robloxJoinCode": "ABC123"
}
response = instance.cms.getOnlinePlayersV2(query)
if response.success:
print(response.data)
else:
print(response.reason)
using Sonoran;
using System.Text.Json;
using var sonoran = new SonoranClient(new SonoranClientOptions
{
product = SonoranProduct.CMS,
apiKey = "YOUR_API_KEY",
communityId = "YOUR_COMMUNITY_ID",
defaultServerId = 1
});
var query = new {
robloxJoinCode = "ABC123"
};
var response = await sonoran.Cms.getOnlinePlayersV2(query);
if (response.success)
{
Console.WriteLine(JsonSerializer.Serialize(response.data));
}
else
{
Console.WriteLine(response.reason);
}
openapi: "3.0.3"
info:
title: "Sonoran CMS v2 - Get Online Players"
version: "1.0.0"
description: "Retrieve the online ER:LC players."
servers:
-
url: "https://api.sonorancms.com"
paths:
/v2/community/erlc/players/online:
get:
summary: "Get Online Players"
operationId: "getOnlinePlayers"
parameters:
-
description: "Target Roblox join code."
name: "robloxJoinCode"
in: "query"
schema:
type: "string"
required: false
security:
-
bearerAuth: []
responses:
"200":
description: "Successful response"
content:
application/json:
schema:
type: "object"
example:
success: true
data:
-
Player: "ExamplePlayer:123456789"
Permission: "Normal"
Callsign: ""
Team: "Civilian"
Actioned: null
Location:
LocationX: 0
LocationY: 0
LocationZ: 0
meta:
timestamp: "2026-04-15T00:00:00.000Z"
path: "/v2/community/erlc/players/online"
components:
securitySchemes:
bearerAuth:
type: "http"
scheme: "bearer"
bearerFormat: "JWT"
curl --request GET \
--url "https://api.sonorancms.com/v2/community/erlc/players/online?robloxJoinCode=ABC123" \
--header "Authorization: Bearer YOUR_API_KEY" \
--header "Accept: application/json"
Response
Thedata array contains the ERLC player projection rows returned by the hub cache. Each item follows the panel player shape.
{
"success": true,
"data": [
{
"Player": "ExamplePlayer:123456789",
"Permission": "Normal",
"Callsign": "",
"Team": "Civilian",
"Actioned": null,
"Location": {
"LocationX": 0,
"LocationY": 0,
"LocationZ": 0
}
}
],
"meta": {
"timestamp": "2026-04-15T00:00:00.000Z",
"path": "/v2/community/erlc/players/online"
}
}

