Pokemon GO Java API

See this guide for adding functionality: https://docs.google.com/document/d/1BE8O6Z19sQ54T5T7QauXgA11GbL6D9vx9AAMCM5KlRA

See this spreadsheet for RPC endpoints and progress : https://docs.google.com/spreadsheets/d/1Xv0Gw5PzIRaVou2xrl6r7qySrcmOKjQWLBjJA73YnJM

❗ ❗ ❗

This API may have issues when the PokemonGO servers are under high load or down, in this case please wait for the official to get back up. You can check the official servers status on IsPokemonGoDownOrNot.com or MMOServerStatus.com.

This API doesnt fake the official client perfectly, niantic may know that you arent using the official app, we encourage you to use a alternate account to play with this API.

If you are using this lib to catch pokemon and loot pokestop, take care that you arent teleporting, the servers may issue a softban against your client (its temporary, between 10 and 30 minutes in general).

❗ ❗ ❗

• Clone the repo and cd into the folder
• git submodule update --init
• compile and package
• ./gradlew build bundle
• you should have the api bundled in build/libs/PokeGOAPI-Java_bundle-0.0.1-SNAPSHOT.jar

PS : To Eclipse user, you must build once : ./gradlew build and add the generated java class for proto into eclipse source path : Right click on the project > Build path > Configure Build Path > Source > Add Folder > Select build/generated/source/proto/main/java > Finish

You can import the lib directly from the jar OR with Maven/Gradle/SBT/Leiningen using JitPack :

Mostly everything is accessed through the PokemonGo class in the API package. The constructor of PokemonGo class requires a CredentialsProvider object (which can be obtained from GoogleCredentialsProvider or PtcCredentialsProvider) and a OkHttpClient object.

How to use example:

OkHttpClient httpClient = new OkHttpClient();

/** 
* Google work like this : the provider will get you a simple to enter to a url with the google account that you want to logged with.
* After that, you will get tokens (access_token that will be used to access niantic servers and a refresh_token that will be used to 
* ask for a new access_token when it will expire (every 15min).
*/
PokemonGo go = new PokemonGo(new GoogleCredentialProvider(httpClient, new GoogleLoginListener()), httpClient);

public class GoogleLoginListener implements OnGoogleLoginOAuthCompleteListener {
 
        @Override
        public void onInitialOAuthComplete(GoogleAuthJson auth) {
            logger.log("Waiting for the code " + auth.getUserCode() + " to be put in " + auth.getVerificationUrl());
        }
 
        @Override
        public void onTokenIdReceived(GoogleAuthTokenJson tokens) {
            // refresh_token is accessible here if you want to store it.
        }
}

/**
* After this, if you dont want to re-authorize the google account everytime, you will need to store the refresh token somewhere (our 
* lib doesnt store it for you) and loggin with it like this :
*/
PokemonGo go = new PokemonGo(new GoogleCredentialProvider(httpClient, refreshToken), httpClient);

/**
* PTC is much more simplier and at the same time less secure, you will need the username and password to relog the user since 
* these accounts doesnt support currently a refresh_token. A exemple to login :
*/
PokemonGo go = new PokemonGo(new PtcCredentialProvider(httpClient,username,password),httpClient);

// After this you can access the api from the PokemonGo instance :
go.getPlayerProfile(); // to get the user profile
go.getInventories(); // to get all his inventories (pokemon, backpack, egg, incubator)
go.setLocation(lat, long, alt); // set your position to get stuff around (altitude is not needed, you can use 1 for exemple)
go.getMap().getCatchablePokemon(); // get all currently catchables pokemons around you

// If you want to go deeper, you can directly send your request with our RequestHandler
// here we are sending a request to get the award for our level, just an exemple, you can send 
// whatever you want that are defined in the protos file as Request/Response)

LevelUpRewardsMessage msg = LevelUpRewardsMessage.newBuilder().setLevel(yourLVL).build(); 
ServerRequest serverRequest = new ServerRequest(RequestType.LEVEL_UP_REWARDS, msg);
go.getRequestHandler().sendServerRequests(serverRequest);

// and get the response like this :

LevelUpRewardsResponse response = null;
try {
		response = LevelUpRewardsResponse.parseFrom(serverRequest.getData());
	} catch (InvalidProtocolBufferException e) {
	   throw new RemoteServerException(e);
}

// its possible that the parsing fail when servers are in high load for example.

##Android Dev FAQ

• I can't use the sample code! It just throws a login exception!

You're running the sample code on the UI thread. Strict mode policy will throw an exception in that case and its being caught by the network client and treating it as a login failed exception. Run the sample code on a background thread in AsyncTask or RXJava and it will work.

• I want to submit a refactor so that this library will use Google Volley

This library is meant to be a Java implementation of the API. Google Volley is specific to Android and should not be introduced in this library. However, if you still want to refactor it, you should create it as a separate project.

• How can I use Android's native Google sign in with this library?

You can't. The Google Identity Platform uses the SHA1 fingerprint and package name to authenticate the caller of all sign in requests. This means that Niantic would need to add your app's SHA1 fingerprint and package name to their Google API Console. If you ever requested a Google Maps API key, you went through the same process. An alternative would be using a WebView to access the web based OAuth flow. This will work with the client ID and secret provided by this library.

• Fork it!
• Create your feature branch: git checkout -b my-new-feature
• Commit your changes: git commit -am 'Useful information about your new features'
• Push to the branch: git push origin my-new-feature
• Submit a pull request on the Development branch :D

• @Grover-c13
• @jabbink
• @Aphoh
• @mjmfighter
• @vmarchaud
• @langerhans

You can join us in the slack channel #javaapi on the pkre.slack.com (you should get an invite by a bot posted somewhere in the subreddit /r/pokemongodev)