# Getting Start

### brawlstars-php

brawlstars-php is library to conveniently access and query the BrawlStars API. It includes a pre-defined set of classes that initialise themselves dynamically from API responses.

This package uses the official BrawlStars API. For more information, please visit\
<https://developer.brawlstars.com/>

### Requirements

To use this package, you need to obtain an API key at <https://developer.brawlstars.com/>

### Installation <a href="#installation" id="installation"></a>

#### Using Composer <a href="#using-composer" id="using-composer"></a>

```
composer require ahsan112/brawlstars-php
```

### Usage <a href="#usage" id="usage"></a>

When instantiating the BrawlStarsClient, you have to provide your API key:

```
$client = new BrawlStarsClient('TOKEN');

$player = $client->getPlayer('tag');
$player->soloVictories();
```