Skip to content
This repository has been archived by the owner on Jul 9, 2019. It is now read-only.

pogobuf.Client Methods

Andreas Reich edited this page Feb 19, 2017 · 14 revisions

pogobuf.Client Constructor

new pogobuf.Client(options)

Param Type Description
options Object Client options (see options page for description of available options)

pogobuf.Client Methods

Note that this page only lists the methods that deal with the client itself. The Pokémon Go API methods (which are also methods of pogobuf.Client) are on a separate page.

setOption(option, value)

Sets the specified client option to the given value. Note that not all options support changes after client initialization.

See options page for description of available options.

Param Type Description
option string Option name
value any Option value

setPosition(latitude, longitude, [accuracy], [altitude])

Sets the player's latitude and longitude. Note that this does not actually update the player location on the server, it only sets the location to be used in following API calls. To update the location on the server you need to make an API call.

Param Type Description
latitude number Object
longitude number The player's longitude
accuracy number The location accuracy in m (optional)
altitude number The player's altitude (optional)

init()Promise

Performs client initialization and downloads needed settings from the API and hashing server.

batchStart()Client

Sets batch mode. All further API requests will be held and executed in one RPC call when batchCall is called.

batchClear()

Clears the list of batched requests and aborts batch mode.

batchCall()Promise

Executes any batched requests.

getSignatureRateInfo()Object

Gets rate limit info from the latest signature server request, if applicable.