API

Get Script Details

GET /api/v1/public/scripts/{script-name}

Returns detailed public information about a specific script.

---

Headers

Name	Value
Content-Type	application/json

---

Path Parameters

Name	Type	Description
script-name	string	Unique identifier of the script

Rules

• Max length: 50

• Allowed characters: a-z A-Z 0-9 - _

---

Query Parameters

Name	Type	Description
getServerIds	boolean	Include server IDs using this script

---

Response

200

{
  "scriptName": "tgiann-inventory",
  "displayName": "TGIANN Inventory",
  "version": "2.4.1",
  "totalServers": 1243,
  "currentRank": 3,
  "previousRank": 4,
  "serverIds": [
    "abc123",
    "def456"
  ]
}

400

404

500

---

Get Server Details

GET /api/v1/public/servers/{id}

Returns public details of a single server.

---

Headers

Name	Value
Content-Type	application/json

---

Path Parameters

Name	Type	Description
id	string	Unique server identifier

Rules

• Max length: 10

• Allowed characters: a-z A-Z 0-9 - _

---

Response

200

{
  "id": "abcd1234",
  "name": "EDV Roleplay",
  "players": 42,
  "maxPlayers": 64,
  "locale": "en",
  "private": false,
  "connectEndpoints": [
    "cfx.re/join/abcd1234"
  ],
  "lastSeenAt": "2025-01-01T12:34:56.000Z"
}

400

404

500

---

Get Server Player History

GET /api/v1/public/servers/{id}/history

Returns player count history for the last 7 days.

---

Headers

Name	Value
Content-Type	application/json

---

Path Parameters

Name	Type	Description
id	string	Unique server identifier

Rules

• Max length: 100

• Allowed characters: a-z A-Z 0-9 - _

---

Response

200

[
  {
    "playerCount": 32,
    "recordedAt": "2025-01-01T12:00:00.000Z"
  },
  {
    "playerCount": 41,
    "recordedAt": "2025-01-01T13:00:00.000Z"
  }
]

400

500

---

Caching

All endpoints are cached with:

Cache-Control: public, s-maxage=300, stale-while-revalidate=600