rocketleague.js
TypeScript icon, indicating that this package has built-in type declarations

1.3.1 • Public • Published

RocketLeague.js

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.

To install use:

npm i rocketleague.js

Example code: (Feel free to use my steam username for testing)

const { API, PLATFORM } = require('rocketleague.js')

try {
    const user = await API.fetchUser(PLATFORM.Epic, 'iFraan')
    /* Platform can be Steam, Epic, Playstation or Xbox */
    
    console.log('User:', user.getUserinfo())
    /*
    User: {
        platform: 'epic',
        uuid: 'fc0c61fe-8e96-48db-be12-80af22912376',
        name: 'iFraan',
        userid: 'iFraan',
        avatar: null
    }
    */

    console.log('Overview:', user.overview())
    /*
    Overview: {
        wins: 153,
        goals: 268,
        mVPs: 22,
        saves: 128,
        assists: 141,
        shots: 512,
        goalShotRatio: 52.34375,
        score: 29507.94,
        seasonRewardLevel: 0,
        seasonRewardWins: 0,
        tRNRating: 0
    }
    */

    console.log('2v2: ', user.get2v2())
    /*
    2v2: {
        rank: 'Gold I',
        tier: 7,
        division: 2,
        matchesPlayed: 0,
        winStreak: 2,
        rating: 511,
        peakRating: null
    }
    */
    console.log('3v3: ', user.get3v3())
    /*
    3v3: {
        rank: 'Gold I',
        tier: 7,
        division: 2,
        matchesPlayed: 0,
        winStreak: 5,
        rating: 505,
        peakRating: null
    }
    */
    console.log('ALL: ', user.getData())
    /* 
    ALL {
        overview: {
            wins: 153,
            goals: 268,
            mVPs: 22,
            saves: 128,
            assists: 141,
            shots: 512,
            goalShotRatio: 52.34375,
            score: 29507.94,
            seasonRewardLevel: 0,
            seasonRewardWins: 0,
            tRNRating: 0
        },
        gamemodes: {
            'Ranked Duel 1v1': {
                rank: 'Gold II',
                tier: 8,
                division: 1,
                matchesPlayed: 0,
                winStreak: 2,
                rating: 534,
                peakRating: null
            },
            'Ranked Doubles 2v2': {
                rank: 'Gold I',
                tier: 7,
                division: 2,
                matchesPlayed: 0,
                winStreak: 2,
                rating: 511,
                peakRating: null
            },
            'Ranked Standard 3v3': {
                rank: 'Gold I',
                tier: 7,
                division: 2,
                matchesPlayed: 0,
                winStreak: 5,
                rating: 505,
                peakRating: null
            },
            Hoops: {
                rank: 'Gold I',
                tier: 7,
                division: 2,
                matchesPlayed: 0,
                winStreak: 1,
                rating: 507,
                peakRating: null
            },
            Rumble: {
                rank: 'Gold I',
                tier: 7,
                division: 3,
                matchesPlayed: 0,
                winStreak: 1,
                rating: 505,
                peakRating: null
            },
            Dropshot: {
                rank: 'Platinum I',
                tier: 10,
                division: 3,
                matchesPlayed: 0,
                winStreak: 3,
                rating: 641,
                peakRating: null
            },
            'Un-Ranked': {
                rank: 'Unranked',
                tier: 0,
                division: 0,
                matchesPlayed: 0,
                winStreak: 0,
                rating: 411,
                peakRating: null
            }
        }
    }
    */
} catch (e) {
    console.log(e)
    /* Error: We could not find the player [player]. */
}

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 rocketleague.js

Weekly Downloads

3

Version

1.3.1

License

GPL-3.0

Unpacked Size

71.7 kB

Total Files

9

Last publish

Collaborators

  • ifraan_