Package Exports
- erlc-api
- erlc-api/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (erlc-api) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
ER:LC API Wrapper
A lightweight API Wrapper with 100% coverage of the ER:LC API. Fixed Error and Improvements 7
Getting Started
First you need to install the package.
npm i erlc-api
Setting Up
Setting up is super simple:
// index.js
const erlc = require("erlc");
const client = new erlc.Client({
globalToken: "", // You get the global key directly from the ERLC developers. To increase your API request limits
});
client.config(); // Registers your clientNow you can start using API Methods - here are a few examples:
// GetServerInfo.js
const erlc = require("erlc-api"); //JS
import erlc from "erlc-api"; // Module or typeScript
const getServerFunc = async () => {
const serverId = ""; // The server ApiKey you wish to target. You can get this api key in your (Server Settings)
const server = await erlc.getServer(serverId).catch(console.log); // Gets the server, logs any errors
console.log(server); // Logs the server object
// Expected Response:
// {
// Name: "Your Sever Name",
// CurrentPlayers: 0,
// MaxPlayers: 40,
// JoinKey: "Your Code Join",
// AccVerifiedReq: "Disabled" | "Email" | "Phone/ID",
// TeamBalance: true or false ,
// OwnerUsername: "Your Name",
// CoOwnerUsernames: [],
// VanityURL: "https://policeroleplay.community/join?code=YourCode",
// },
};
getServerFunc();// GetPlayers.js
const erlc = require("erlc-api"); //JS
import erlc from "erlc-api"; // Module or typeScript
const getPlayersFunc = async () => {
const serverId = ""; // The server ApiKey you wish to target. You can get this api key in your (Server Settings)
const server = await erlc.getPlayers(serverId).catch(console.log); // Gets the server, logs any errors
console.log(server); // Logs the server object
// Expected Response:
// [
// {
// "Permission": "Server Owner" Or Member, Moderator,
// "Player": "Player-Username and ID" ,
// "Team": "Civilian" Or Fire, Police, Sherift
// }
// ]
};
getPlayersFunc();//getmodCalls.js
const erlc = require("erlc-api"); //JS
import erlc from "erlc-api"; // Module or typeScript
const getModCallsFunc = async () => {
const serverId = ""; // The server ApiKey you wish to target. You can get this api key in your (Server Settings)
const server = await erlc.getModcallLogs(serverId).catch(console.log); // Gets the server, logs any errors
console.log(server); // Logs the server object
// Expected Response:
// {
// Caller: ErlcPlayer;
// Moderator?: ErlcPlayer; // If call is unanswered property is undefined
// Timestamp: number;
// }
};
getModCallsFunc()Discord Bot
The Discord Bot Back Online 29/05/2024
Module Examples
PRC API Docs
Liveries
Credits
Library Re-Development - Egologics
API Development - Police Roleplay Community
Apply for more API request limits - Discord