rocket-league-stats
TypeScript icon, indicating that this package has built-in type declarations

1.0.9 • Public • Published

Rocket League Stats

CodeFactor NPM-Version NPM-Downloads Github Stars Issues

This a wrapper/scrapper of the TRNetwork site with Rocket League stats.

There are no dependencies nor API key required.

This project is built upon rocketleague.js

To install use:

npm i rocket-league-stats
pnpm add rocket-league-stats
bun a rocket-league-stats

Usage

Initialise

Basic

const api = new API(PLATFORM.Epic, 'lil McNugget');

Expiry

The data is by default stored for 60 seconds from the first request to limit the number of requests to the API. This number can be adjusted with the following code

 const api = new API(PLATFORM.Epic, 'lil McNugget', {
  expiresAfter: 5000 // Sets the expiry to 5 seconds (5000 ms)
 });

Sample Code

import { API, PLATFORM } from 'rocket-league-stats';

async function main() {
	const api = new API(PLATFORM.Epic, 'lil McNugget');
	const data1s = await api.get1v1();
	console.log(data1s);
	const data2s = await api.get2v2();
	console.log(data2s);
	const data3s = await api.get3v3();
	console.log(data3s);
	const dataHS = await api.getDropshot();
	console.log(dataHS);
	const dataH = await api.getHoops();
	console.log(dataH);
	const dataR = await api.getRumble();
	console.log(dataR);
	const dataS = await api.getSnowday();
	console.log(dataS);
	const dataT = await api.getTournament();
	console.log(dataT)
	const dataAll = await api.getData();
	console.log(dataAll);
	const dataRaw = await api.getRaw();
	console.log(dataRaw);

	const data1sFresh = await api.get1v1({
		fresh: true,
	});
	console.log(data1sFresh);
}

main().catch((err) => {
	console.log(err);
});

Disclaimer

This project is fully for educational purposes and if you want to use the rocketleague api in a production/commertial enviroment you should ask for one at Rocket League Support or email the guys at TRNetwork.

Package Sidebar

Install

npm i rocket-league-stats

Weekly Downloads

3

Version

1.0.9

License

GPL-3.0

Unpacked Size

126 kB

Total Files

9

Last publish

Collaborators

  • xnugget_