pe-paladins.js

A strongly typed fork of paladins.js, used by Paladins Edge

• Well maintained and up-to-date library
• All of the methods have the exact response type
• Updated champion enums to include Betty la Bomba as per Monstercat patch

Changelog

v4.0.1

• BREAKING CHANGE: Removed getBountyItems api
• Added getPlayerQueueStatsBatch api
• Added getLeaderboard api
• Updated dependencies internally

Reason: Paladins bounty store has been closed, this changes removes the api from being used in the future

v3.6.1

• Added support for Omen
• Added Bans 7,8 in match details
• Removed Ranked Controller
• Renamed Ranked Keyboard to Ranked

v3.5.0

• Added support for Nyx

v3.4.0

• Added support for Kasumi
• Added support for Choose Any

v3.3.4

• Added Region in getMatchIdsByQueue api response

v3.3.3

• Added support for Caspian

v3.3.2

• Added getDevId method
• Added forceRefresh param in getRequestsInfo

v3.3.0

• Added support for Lillith
• Upgrade dependencies
• Replaced moment library with dayjs

v3.2.8

• Updated readme

v3.2.6

• Added support for Betty la Bomba

v3.2.5

• Added Siege: Beyond queue in Enums, Strings and Data

v3.2.4

• Updated Data, Enums, Strings for champion VII
• Updated enums for getMatchDetails, getPlayerMatchHistory
• Added TaskForce to Enums
• Fixed champion_id type in ChampionCard

v3.2.1

• BREAKING CHANGE: renamed GetMatchIDSByQueue ApiResponse interface to GetMatchIdsByQueue
• BREAKING CHANGE: renamed Data objects from capital to pascal case and changed keys from strings to enums
• Refactored ApiResponse, Data, Enums, Strings into their own folders
• Updated documentation for a few API methods
• Updated getPlayerQueueStats and getMatchIdsByQueue queueId params to be Enums.Queue instead of number
• Updated for ApiResponse property

Reason: these changes are a part of the library refactoring and removing clutter, and making things consistent. These will be the last set of breaking changes.

Install

$ npm install pe-paladins.js

Usage

TypeScript

import { API, ApiResponse } from "pe-paladins.js";

const api = new API({
  devId: "your dev id",
  authKey: "your authKey",
  languageId: 1, // optional
}); // API loaded and ready to go.

const foo = async () => {
  let response: ApiResponse.GetDataUsage
  try {
    response = await api.getDataUsage()
    // Do something with response
  } catch(error) {
    // Handle the error
  }
}

JavaScript

const { API } = require("pe-paladins.js");

const api = new API({
  devId: "your dev id",
  authKey: "your authKey",
  languageId: 1, // optional
}); // API loaded and ready to go.

const foo = async () => {
  let response;
  try {
    response = await api.getDataUsage()
    // Do something with response
  } catch(error) {
    // Handle the error
  }
}

Documentation / Methods

You can view all the available methods and documentation on pe-paladins.paladinsedge.app. Some of the methods are removed/changed in pe-paladins.js compared to paladins.js