🚀v2 API Reference

API Authentication

All requests to the API must have a valid Server-Key header provided.

Not sure where to find your server key?

Join your private server, open the settings, and search for "API key" under the ER:LC API header.

What's new in API v2?

PRC API v2 is intended to provide a more consistent and simpler request model for developers. In addition, it provides highly requested data, such as player locations and vehicle colours!

API v1 will continue to operate, without major changes, until further notice.

Endpoint Information

Fetch server information

get

Returns server status data. Additional fields can be included by setting query parameters to 'true'. All query parameters are optional.

Authorizations

ServerKeyAuth

server-keystringRequired

REQUIRED ON ALL REQUESTS.

Query parameters

PlayersbooleanOptional

Include player list in response

Example: true

StaffbooleanOptional

Include staff list (Admins, Mods, Helpers) in response

Example: true

JoinLogsbooleanOptional

Include join logs in response

Example: true

QueuebooleanOptional

Include queue data in response

Example: true

KillLogsbooleanOptional

Include kill logs in response

Example: true

CommandLogsbooleanOptional

Include command logs in response

Example: true

ModCallsbooleanOptional

Include moderator call logs in response

Example: true

EmergencyCallsbooleanOptional

Include emergency call logs in response

Example: true

VehiclesbooleanOptional

Include vehicle list in response

Example: true

Responses

200

Requested data. Optional fields only included when query=true.

application/json

NamestringRequiredExample: API Test

OwnerIdintegerRequired

CoOwnerIdsinteger[]Required

CurrentPlayersintegerRequired

MaxPlayersintegerRequired

JoinKeystringRequiredExample: APIServer

AccVerifiedReqstringRequiredExample: Disabled / Email / Phone/ID

TeamBalancebooleanRequired

Queueinteger[]Optional

Only included when Queue=true query parameter is provided

403

Unauthorized

500

Error communicating with Roblox

application/json

get

/v2/server

HTTPcURLJavaScriptPython

GET /v2/server HTTP/1.1
Host: api.policeroleplay.community
server-key: YOUR_API_KEY
Accept: */*

{
  "Name": "API Test",
  "OwnerId": 1,
  "CoOwnerIds": [
    1
  ],
  "CurrentPlayers": 1,
  "MaxPlayers": 1,
  "JoinKey": "APIServer",
  "AccVerifiedReq": "Disabled / Email / Phone/ID",
  "TeamBalance": true,
  "Players": [
    {
      "Team": "Sheriff",
      "Player": "PlayerName:Id",
      "Callsign": "5D-550",
      "Location": {
        "LocationX": 1084.965,
        "LocationZ": 2302.28,
        "PostalCode": "218",
        "StreetName": "Park Street",
        "BuildingNumber": "2083"
      },
      "Permission": "Normal / Server Administrator / Server Owner / Server Moderator",
      "WantedStars": 0
    }
  ],
  "Staff": {
    "Admins": {
      "54249787": "Black_Hallow",
      "77573259": "sli_ckk"
    },
    "Mods": {
      "2": "JohnDoe",
      "3": "JaneDoe"
    },
    "Helpers": {
      "168691872": "Flat_bird"
    }
  },
  "JoinLogs": [
    {
      "Join": true,
      "Timestamp": 1704614400,
      "Player": "PlayerName:Id"
    }
  ],
  "Queue": [
    1
  ],
  "KillLogs": [
    {
      "Killed": "PlayerName:Id",
      "Timestamp": 1704614400,
      "Killer": "PlayerName:Id"
    }
  ],
  "CommandLogs": [
    {
      "Player": "PlayerName:Id",
      "Timestamp": 1704614400,
      "Command": ":h"
    }
  ],
  "ModCalls": [
    {
      "Caller": "PlayerName:Id",
      "Moderator": "PlayerName:Id",
      "Timestamp": 1704614400
    }
  ],
  "EmergencyCalls": [
    {
      "Team": "Police",
      "Caller": 168691872,
      "Players": [],
      "Position": [
        -654.6,
        666.5
      ],
      "StartedAt": 1774216563,
      "CallNumber": 400,
      "Description": "stg",
      "PositionDescriptor": "sdfsdfsdf"
    }
  ],
  "Vehicles": [
    {
      "Name": "Redline Fire Engine",
      "Owner": "Shawnyg",
      "Plate": "ABC-123",
      "Texture": "Livery Name",
      "ColorHex": "#ff4444",
      "ColorName": "Super Red"
    }
  ]
}

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

post

Authorizations

ServerKeyAuth

server-keystringRequired

REQUIRED ON ALL REQUESTS.

Body

application/json

commandstringOptional

The command to be executed

Example: :h Hey everyone!

Responses

200

Command executed successfully

application/json

messagestringOptional

A message explaining the status of your command

Example: Success

400

Bad request

application/json

403

Unauthorized

422

The private server has no players in it

application/json

500

Problem communicating with Roblox

application/json

post

/v2/server/command

HTTPcURLJavaScriptPython

POST /v2/server/command HTTP/1.1
Host: api.policeroleplay.community
server-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "command": ":h Hey everyone!"
}

{
  "message": "Success"
}

Resetting a global API key:

If you were issued a global API key, you can reset it by sending a POST to /v1/api-key/reset with the "authorization" header set as your API key. This will send a new key which can only be viewed once. If you lose the key, the person who requested the API key must contact PRC.