nicklasw/pkm-go-api

The Pokemon Go API library.

v2.0.5 2016-12-31 13:14 UTC

README

Total Downloads PHP7 Ready

Pokemon GO PHP API library

Install

Run the command composer require nicklasw/pkm-go-api.

Usage

EG:

 // Create the authentication config
$config = new Config();
$config->setProvider(Factory::PROVIDER_PTC);
$config->setUser('INSERT_USER');
$config->setPassword('INSERT_PASSWORD');

// Create the authentication manager
$manager = Factory::create($config);

// Add a event listener,
$manager->addListener(function ($event, $value) {
    if ($event === Manager::EVENT_ACCESS_TOKEN) {
        /** @var AccessToken $accessToken */
        $accessToken = $value;

        // Persist the access token in session storage, cache or whatever.
    }
});

// Initialize the pokemon go application
$application = new ApplicationKernel($manager);

// Retrieve the pokemon go api instance
$pokemonGoApi = $application->getPokemonGoApi();

// Retrieve the inventory
$inventory = $pokemonGoApi->getInventory();

// Retrieve the poke bank
$pokeBank = $inventory->getPokeBank();

// Retrieve a pokemon of type pidgey
$pokemon = $pokeBank->getPokemonsByType(PokemonId::PIDGEY)->first();

// Transfer / Release the pokemon (Send to the meat grinder)
$pokemon->transfer();

TODO

  • Implement the Map API
  • Improve logging

Contributors

Testing

$ composer test

Slack Chat

We use Slack for community discussions. You can find our team here: https://pokemongoapi-php.slack.com

Credits