Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nicklaswallgren/pokemongoapi-php

Pokemon Go API PHP library
https://github.com/nicklaswallgren/pokemongoapi-php

api php pokemon-go pokemongo

Last synced: 7 days ago
JSON representation

Pokemon Go API PHP library

Awesome Lists containing this project

README

        

# PokemonGoAPI-PHP

[![Total Downloads][ico-downloads]][link-packagist]
[![PHP7 Ready](https://img.shields.io/badge/PHP7-ready-green.svg)][link-packagist]

Pokemon GO PHP API library

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

# Usage
EG:
```php
// 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
- [Nicklas Wallgren](https://github.com/NicklasWallgren)
- [Ni42](https://github.com/Ni42)
- [All Contributors][link-contributors]

## Testing

``` bash
$ composer test
```

## Slack Chat

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

## Credits
- [Grover-c13](https://github.com/Grover-c13) for the inspiration
- [AeonLucid](https://github.com/AeonLucid/POGOProtos) for improved protos

[ico-downloads]: https://img.shields.io/packagist/dt/nicklasw/pkm-go-api.svg?style=flat-square

[link-packagist]: https://packagist.org/packages/nicklasw/pkm-go-api
[link-contributors]: ../../contributors