📚API Reference

Base URL: https://api.policeroleplay.community/v1

All requests should be sent with authentication headers:

Header Name	Description	Required
Server-Key	Server-Key, obtained in-game from private server settings	On all /server/ requests
Authorization	Global API key. You will only have a global API key if your application has been approved for increased rate limits!	Not required

• All requests must start with the base URL.

• Listed code examples in this section are not up to date due to issues with our documentation site, please only use this as a reference. If you do not know how to code without examples, the API is not for you - use a pre-made bot.

Fetches server status

GET/server

Authorization

ApiKeyAuthServerKeyAuth

Response

200403

Server status data

Body

application/json

Namestring

Example: "API Test"

OwnerIdinteger

CoOwnerIdsarray of integer

CurrentPlayersinteger

MaxPlayersinteger

JoinKeystring

Example: "APIServer"

AccVerifiedReqstring

Example: "Disabled / Email / Phone/ID"

TeamBalanceboolean

Request

JavaScriptCurlPython

const response = await fetch('/server', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "Name": "API Test",
  "OwnerId": 0,
  "CoOwnerIds": [
    0
  ],
  "CurrentPlayers": 0,
  "MaxPlayers": 0,
  "JoinKey": "APIServer",
  "AccVerifiedReq": "Disabled / Email / Phone/ID",
  "TeamBalance": false
}

Fetches players in server

GET/server/players

Authorization

ApiKeyAuthServerKeyAuth

Response

200403

Players in server

Body

application/json

Playerstring

Example: "PlayerName:Id"

Permissionstring

Example: "Normal / Server Administrator / Server Owner / Server Moderator"

Callsignstringnull

Example: "The player's callsign - only available if the player is on a non-civilian team"

Teamstring

Example: "The player's team "

Request

JavaScriptCurlPython

const response = await fetch('/server/players', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "Player": "PlayerName:Id",
    "Permission": "Normal / Server Administrator / Server Owner / Server Moderator",
    "Callsign": "The player's callsign - only available if the player is on a non-civilian team",
    "Team": "The player's team "
  }
]

Fetches join logs

GET/server/joinlogs

Authorization

ApiKeyAuthServerKeyAuth

Response

200403

Join logs data

Body

application/json

Joinboolean

Example: true

Timestampinteger

Example: 1704614400

Playerstring

Example: "PlayerName:Id"

Request

JavaScriptCurlPython

const response = await fetch('/server/joinlogs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "Join": true,
    "Timestamp": 1704614400,
    "Player": "PlayerName:Id"
  }
]

Fetches players in queue

GET/server/queue

Authorization

ApiKeyAuthServerKeyAuth

Response

200403

Players in queue (by Roblox id)

Body

application/json

itemsinteger

Request

JavaScriptCurlPython

const response = await fetch('/server/queue', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  0
]

Fetches kill logs

GET/server/killlogs

Authorization

ApiKeyAuthServerKeyAuth

Response

200403

Kill logs data

Body

application/json

Killedstring

Example: "PlayerName:Id"

Timestampinteger

Example: 1704614400

Killerstring

Example: "PlayerName:Id"

Request

JavaScriptCurlPython

const response = await fetch('/server/killlogs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "Killed": "PlayerName:Id",
    "Timestamp": 1704614400,
    "Killer": "PlayerName:Id"
  }
]

Fetches command logs

GET/server/commandlogs

Authorization

ApiKeyAuthServerKeyAuth

Response

200403

Command logs data

Body

application/json

Playerstring

Example: "PlayerName:Id"

Timestampinteger

Example: 1704614400

Commandstring

Example: ":h"

Request

JavaScriptCurlPython

const response = await fetch('/server/commandlogs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "Player": "PlayerName:Id",
    "Timestamp": 1704614400,
    "Command": ":h"
  }
]

Fetches moderator call logs

GET/server/modcalls

Authorization

ApiKeyAuthServerKeyAuth

Response

200403

Moderator call logs data. 'Moderator' is only sent if a mod has responded to the call.

Body

application/json

Callerstring

Example: "PlayerName:Id"

Moderatorstringnull

Example: "PlayerName:Id"

Timestampinteger

Example: 1704614400

Request

JavaScriptCurlPython

const response = await fetch('/server/modcalls', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "Caller": "PlayerName:Id",
    "Moderator": "PlayerName:Id",
    "Timestamp": 1704614400
  }
]

Fetches bans

GET/server/bans

Authorization

ApiKeyAuthServerKeyAuth

Response

200403

Bans data

Body

application/json

PlayerIdstring

Example: "PlayerName"

Request

JavaScriptCurlPython

const response = await fetch('/server/bans', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "PlayerId": "PlayerName"
}

Fetches a list of spawned vehicles in the server

GET/server/vehicles

Authorization

ApiKeyAuthServerKeyAuth

Response

200403

Vehicles in the server

Body

application/json

Texturestringnull

Example: "Standard"

Namestring

Example: "2019 Falcon Interceptor Utility"

Ownerstring

Example: "flat_bird"

Request

JavaScriptCurlPython

const response = await fetch('/server/vehicles', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

[
  {
    "Texture": "Standard",
    "Name": "2019 Falcon Interceptor Utility",
    "Owner": "flat_bird"
  }
]

Please be aware of higher rate-limits on all POST routes. Respect the rate limit headers!

Run a command as a player named "virtual server management"

POST/server/command

Authorization

ApiKeyAuthServerKeyAuth

Body

application/json

Command to be executed

commandstring

The command to be executed

Example: ":h Hey everyone!"

Response

200400403422500

Command executed successfully

Request

JavaScriptCurlPython

const response = await fetch('/server/command', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();