https://github.com/Armax/Pokemon-GO-node-api

Pokemon GO api node.js library
https://github.com/Armax/Pokemon-GO-node-api

Last synced: 9 days ago
JSON representation

Pokemon GO api node.js library

• Host: GitHub
• URL: https://github.com/Armax/Pokemon-GO-node-api
• Owner: Armax
• License: mit
• Created: 2016-07-16T01:44:33.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2019-05-27T18:05:29.000Z (over 5 years ago)
• Last Synced: 2024-09-19T12:38:13.964Z (about 2 months ago)
• Language: JavaScript
• Size: 205 KB
• Stars: 875
• Watchers: 57
• Forks: 198
• Open Issues: 52
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-pokemon - Pokemon-GO-node-api - Pokémon GO API Node.js library. (Development Projects)

README

        
# Poke.io

Pokemon GO api node.js library, still WIP, we have a dev channel on discord: https://discord.gg/W9CZTgn (is for dev only don't ask for support here)


Check 'example.js' for examples

## Installation & Usage:

```

npm install pokemon-go-node-api

```

```javascript

var Pokeio = require('pokemon-go-node-api')

```

Check [example.js](./example.js) for the result showed in the demo or check the documentation below.

## Demo:

![alt tag](http://cl.arm4x.net/poke3.png)

## Documentation:

### Pokeio.init(username, password, location, provider, callback)

Initializes Pokeio with either pokemon trainer club credentials or google account.

Accepts locations by name or coordinates

**Parameters**

  * `username {String}` Your pokemon trainer club or google username

  * `password {String}` Your pokemon trainer club or google password

  * `location {Object}` location accepts a combination of type = 'name' & name or type = 'coords' & latitude, longitude, altitude

    * `type {String}` Must be one of ['name', 'coords']

    * `name {String}` Address for lookup using the google maps api.

    * `coords {Object}`

      * `latitude {Number}`

      * `longitude {Number}`

      * `altitude {Number}`

  * `provider {String}` Must be one of ['ptc', 'google']

  * `callback {Function(error)}`

    * `error {Error}`

### Pokeio.GetAccessToken(username, password, callback)

Will save the access token to the Pokeio internal state.

**Parameters**

  * `username {String}` Your pokemon trainer club username

  * `password {String}` Your pokemon trainer club password

  * `callback {Function(error, token)}`

    * `error {Error}`

    * `token {String}`

### Pokeio.GetApiEndpoint(callback)

Will save the api endpoint to the Pokeio internal state.

**Parameters**

  * `callback {Function(error, api_endpoint)}`

    * `error {Error}`

    * `api_endpoint {String}`

### Pokeio.GetProfile(callback)

**Parameters**

  * `callback {Function(error, profile)}`

    * `error {Error}`

    * `profile {Object}`

      * `creation_time {Number}`

      * `username {String}`

      * `team {Number}`

      * `tutorial {Number/Boolean}`

        * `poke_storage {String}`

        * `item_storage {String}`

        * `daily_bonus {Object}`

          * `NextCollectTimestampMs {Number}`

          * `NextDefenderBonusCollectTimestampMs {Number}`

        * `currency {Object}`

          * `type {String}`

          * `amount {Number}`

### Pokeio.GetLocation(callback)

Reads current latitude and longitude and returns a human readable address using the google maps api.

**Parameters**

  * `callback {Function(error, formatted_address)}`

    * `error {Error}`

    * `formatted_address {String}`

### Pokeio.GetLocationCoords()

**Returns**

  * `coordinates {Object}`

    * `latitude {Number}`

    * `longitude {Number}`

    * `altitude {Number}`

### Pokeio.SetLocation(location, callback)

Will save cooridinates to the Pokeio internal state.

Accepts raw coordinates or location name based on the type property.

**Parameters**

  * `location {Object}`

    * `type {String}` One of ['name', 'coords']

    * `name {String}` Address for lookup using the google maps api.

    * `coords {object}`

        * `latitude {Number}`

        * `longitude {Number}`

        * `altitude {Number}`

  * `callback {Function(error, coordinates)}`

    * `error {Error}`

    * `coordinates {Object}`

      * `latitude {Number}`

      * `longitude {Number}`

      * `altitude {Number}`

### Pokeio.RenamePokemon(id, name, callback)

Sets the nickname of a pokemon

**Parameters**

  * `id {Object]` The pokemon id to change

  * `name {String}` The new nickname

  * `callback {Function(error, status)}`

    * `error {Error}`

    * `status {Number}`

The status can eather of:

  * `UNSET = 0`

  * `SUCCESS = 1`

  * `ERROR_INVALID_NICKNAME = 2`

  * `ERROR_POKEMON_NOT_FOUND = 3`

  * `ERROR_POKEMON_IS_EGG = 4`

## Thanks to:

Python demo: [tejado](https://github.com/tejado/pokemongo-api-demo) 


## Contact me

[@Arm4x](https://twitter.com/Arm4x)

Feel free to contact me for help or anything else