craigchilds/rls-api

Rocket League Stats PHP API

dev-master 2017-04-27 12:02 UTC

Requires

• doctrine/collections: ^1.3
• guzzlehttp/guzzle: ^6.2

Requires (Dev)

• phpspec/phpspec: ~2.0
• vlucas/phpdotenv: ^2.3

MIT

• CraigChilds94

README

This is the un-official PHP client library for the RocketLeagueStats API.

Installation

composer require craigchilds/rls-api

Usage

Here are a few examples of how you can use the api to fetch different types of data.

Fetching a list of the playlists

use RocketLeagueStats\Stats as Api;

$api = new Api([
    'api_key' => 'your_api_key_here'
]);

$playlists = $api->playlists()->toCollection();

Fetching a player by platform & name

use RocketLeagueStats\Stats as Api;
use RocketLeagueStats\Data\Platform;

$api = new Api([
    'api_key' => 'your_api_key_here'
]);

$player = $api->player(Platform::PS4, 'PS4_UserNameHere');

Searching for a player on any platform

use RocketLeagueStats\Stats as Api;

$api = new Api([
    'api_key' => 'your_api_key_here'
]);

$results = $api->search('UserNameHere')->toCollection();

Environment Variables

If you want you can supply the api key through an environment variable. Lets say, if you had DotEnv installed on your project you could add the entry to your .env file.

RLS_API_KEY="rls_api_key_here"

And then you will not need to pass it in the constructor of the RocketLeagueStats\Stats class. Here is an example batch player request without passing the api key:

use RocketLeagueStats\Stats as Api;
use RocketLeagueStats\Data\Collection;

$api = new Api();

$players = new Collection([
    ['player' => 'UserName1', 'platform' => Platform::PS4],
    ['player' => 'UserName1', 'platform' => Platform::Steam],
]);

$allPlayers = $api->batch($players);

Links

• Example
• API Documentation