README.md

rocket-league-apis-client

Client for pulling data from various rocket league apis

Usage

import rankApis, { TRACKER } from 'rocket-league-rank-apis-client'

const API_KEY = 'abc123';
const options = {
  tracker: TRACKER.RLTRACKER_PRO,
  apiUrl: 'http://rltracker.pro/api/profile/get',
  apiKey: API_KEY,
};
/* Create a client for the specific tracker */
const RLTrackerProClient = rankApis(options);

const platform = 0; // 0 = steam, 1 = ps4, 2 = xbox
const id = 'freedomrl'; // steam vanity id, STEAM64 id, or xbox/ps4 handle
RLTrackerProClient(platform, id);

Supported trackers

• RLTRACKER_PRO = http://rltracker.pro
• ROCKETLEAGUE_TRACKER_NETWORK = http://rocketleague.tracker.network

Player information schema

{
  "player": {
    "id": "Player id (xbox/psn handle or STEAM64 id)",
    "platform": "Player platform",
    "name": "Player name",
    "1v1": "1v1 rank",
    "1v1_division": "1-5",
    "1v1_tier": "1v1 tier (0-15 i.e. unranked to GC)",
    "...": "same for 2v2, 3v3, 3v3s"
  }
}

Authors

• hugogrochau