pogobuf.Client Pokémon Go API Methods

`pogobuf.Client` Pokémon Go API methods

Each of these methods returns a Promise that will be resolved with the response message object (or true if there was no response message) unless you are using batch mode.

Use ⌘ (cmd) + F or CTRL + F to search methods.

`addFortModifier(modifierItemID, fortID)` ⇒ `Promise`

Adds a modifier to a fort.

Params

Name	Type
modifierItemID	`integer (ItemId)`
fortID	`string`

Response

Name	Type	Description
result	`enum (AddFortModifierResponse.Result)`	0 = NO_RESULT_SET 1 = SUCCESS 2 = FORT_ALREADY_HAS_MODIFIER 3 = TOO_FAR_AWAY 4 = NO_ITEM_IN_INVENTORY
fort_details	`enum (FortDetailsResponse)`

Fort modifiers

Item name	Item	Description
Lure	TROY_DISK	Basic lure

`attackGym(gymID, battleID, attackActions, lastRetrievedAction)` ⇒ `Promise`

Attack a gym

Params

Name	Type
gymID	`string`
battleID	`string`
attackActions	`repeated BattleAction`
lastRetrievedAction	`BattleAction`

Response

Name	Type	Description
result	`enum (AttackGymResponse.Result)`	0 = UNSET 1 = SUCCESS (success) 2 = ERROR_INVALID_ATTACK_ACTIONS (invalid action) 3 = ERROR_NOT_IN_RANGE (gym not in range)
battle_log	`BattleLog`	Log of the battle
battle_id	`string`	Battle ID
active_defender	`BattlePokemonInfo`	Current defender
active_attacker	`BattlePokemonInfo`	Current attacker

`catchPokemon(encounterID, pokeballItemID, normalizedReticleSize, spawnPointID, hitPokemon, spinModifier, normalizedHitPosition)` ⇒ `Promise`

Catch a pokemon

Params

Name	Type
encounterID	`integer (integer (fixed64))`
pokeballItemID	`integer (ItemId)`
normalizedReticleSize	`double`
spawnPointID	`string`
hitPokemon	`boolean`
spinModifier	`double`
normalizedHitPosition	`double`

Response

Name	Type	Description
result	`enum (CatchStatus)`	0 = CATCH_ERROR 1 = CATCH_SUCCESS (success) 2 = CATCH_ESCAPE (Pokémon escaped) 3 = CATCH_FLEE (Pokémon flew away) 4 = CATCH_MISSED (missed throw)
miss_percent	`double`	Miss percent
captured_pokemonID	`integer (integer (fixed64))`	Captured Pokémon ID
capture_award	`CaptureAward`	Awards from capture

`checkAwardedBadges()` ⇒ `Promise`

Checks awarded badges

Params

(no parameters required)

Response

Name	Type	Description
success	`boolean`	If boolean is true, the request was successful
awarded_badges	`repeated BadgeType`	Badge types
awarded_badge_levels	`repeated integer (integer (int32))`	Badge levels
avatar_template	_ids	`repeated string`

`checkChallenge(isDebugRequest)` ⇒ `Promise`

Checks challenge (captcha?)

Params

| Name | Type | |---|---|---| | debug_request | boolean |

Response

Name	Type	Description
show_challenge	`boolean`
challenge_url	`string`

`claimCodename(codename)` ⇒ `Promise`

Claims a codename (or username).

Params

Name	Type
codename	`string`

`collectDailyBonus()` ⇒ `Promise`

Collects daily bonus.

Params

(no parameters required)

Response

Name	Type	Description
result	`enum (CollectDailyBonusResponse.Result)`	0 = UNSET 1 = SUCCESS 2 = FAILURE 3 = TOO_SOON

`collectDailyDefenderBonus()` ⇒ `Promise`

Collects daily defender bonus.

Params

(no parameters required)

Response

Name	Type	Description
result	`enum (CollectDailyDefenderBonusResponse.Result)`	0 = UNSET 1 = SUCCESS 2 = FAILURE 3 = TOO_SOON 4 = NO_DEFENDERS
currency_type	`string`
currency_awarded	`integer (int32)`
defenders_count	`integer (int32)`

`diskEncounter(encounterID, fortID)` ⇒ `Promise`

Encounters a pokémon spawned from a lure (or a pokéstop).

Params

Name	Type
encounterID	`integer (integer (uint64))`
fortID	`string`

Response

Name	Type	Description
result	`Result`
pokemon_data	`enum (PokemonData)`
capture_probability	`enum (Capture.CaptureProbability)`
active_item	`integer (ItemId)`

`downloadItemTemplates(paginate, pageOffset, pageTimestamp)` ⇒ `Promise`

Downloads item templates.

Params

Name	Type
paginate	`boolean`
pageOffset	`integer`
pageTimestamp	`integer (uint64)`

Response

Name	Type	Description
result	`boolean`	0 = UNSET 1 = SUCCESS 2 = PAGE 3 = RETRY
item_templates	`enum (DownloadItemTemplatesResponse.ItemTemplate)`
timestamp_ms	`integer (uint64)`
page_offset	`integer`
template_id	`string`
pokemon_settings	`unknown (Settings.Master.PokemonSettings)`
item_settings	`unknown (Settings.Master.ItemSettings)`
move_settings	`unknown (Settings.Master.MoveSettings)`
move_sequence_settings	`unknown (Settings.Master.MoveSequenceSettings)`
type_effective	`unknown (Settings.Master.TypeEffectiveSettings)`
badge_settings	`unknown (Settings.Master.BadgeSettings)`
camera	`unknown (Settings.Master.CameraSettings)`
player_level	`unknown (Settings.Master.PlayerLevelSettings)`
gym_level	`unknown (Settings.Master.GymLevelSettings)`
battle_settings	`unknown (Settings.Master.GymBattleSettings)`
encounter_settings	`unknown (Settings.Master.EncounterSettings)`
iap_item_display	`unknown (Settings.Master.IapItemDisplay)`
iap_settings	`unknown (Settings.Master.IapSettings)`
pokemon_upgrades	`unknown (Settings.Master.PokemonUpgradeSettings)`
equipped_badges	`unknown (Settings.Master.EquippedBadgeSettings)`
quest_settings	`unknown (Settings.Master.QuestSettings)`
avatar_customization_settings	`unknown (Settings.Master.AvatarCustomizationSettings)`
form_settings	`unknown (Settings.Master.FormSettings)`
gender_settings	`unknown (Settings.Master.GenderSettings)`

`downloadRemoteConfigVersion(platform, deviceManufacturer, deviceModel, locale, appVersion)` ⇒ `Promise`

Sends information about device and returns with asset and item template information.

Params

Name	Type
platform	`enum (Platform)`
deviceManufacturer	`string`
deviceModel	`string`
locale	`string`
appVersion	`integer (uint32)`

Response

Name	Type	Description
result	`enum (DownloadRemoteConfigVersionResponse.Result)`	0 = UNSET 1 = SUCCESS
item_templates_timestamp_ms	`integer (uint64)`
asset_digest_timestamp_ms	`integer (uint64)`

`downloadSettings(hash)` ⇒ `Promise`

Fetches settings.

Params

Name	Type
hash	`string`

Response

Name	Type	Description
error	`string`
hash	`string`
settings	`unknown (Settings.GlobalSettings)`

`echo()` ⇒ `Promise`

Params

(no parameters required)

Response

Name	Type	Description
context	`string`

`encounter(encounterID, spawnPointID)` ⇒ `Promise`

Encounters a wild pokemon.

Params

Name	Type
encounterID	`integer (fixed64)`
spawnPointID	`string`

Response

Name	Type	Description
wild_pokemon	`unknown (Map.Pokemon.WildPokemon)`
background	`Background`
status	`Status`
capture_probability	`enum (Capture.CaptureProbability)`
active_item	`integer (ItemId)`

`encounterTutorialComplete(pokemonID)` ⇒ `Promise`

Triggered when player catches one of the starter pokémon.

Params

Name	Type
pokemonID	`enum (PokemonId)`

Response

Name	Type	Description
result	`enum (EncounterTutorialCompleteResponse.Result)`	0 = UNSET 1 = SUCCESS 2 = ERROR_INVALID_POKEMON
pokemon_data	`enum (PokemonData)`
capture_award	`enum (Capture.CaptureAward)`

`equipBadge(badgeType)` ⇒ `Promise`

Equips a badge.

Params

Name	Type
badgeType	`enum (BadgeType)`

Response

Name	Type	Description
result	`enum (EquipBadgeResponse.Result)`	0 = UNSET 1 = SUCCESS 2 = COOLDOWN_ACTIVE 3 = NOT_QUALIFIED
equipped	`enum (Player.EquippedBadge)`

`evolvePokemon(pokemonID, evolutionRequirementItemID)` ⇒ `Promise`

Evolves a pokémon. Requirement item is optional.

Params

Name	Type
pokemonID	`integer (fixed64)`
evolutionRequirementItemID	`integer (ItemId)`

Response

Name	Type	Description
result	`enum (EvolvePokemonResponse.Result)`	0 = UNSET 1 = SUCCESS 2 = FAILED_POKEMON_MISSING 3 = FAILED_INSUFFICIENT_RESOURCES 4 = FAILED_POKEMON_CANNOT_EVOLVE 5 = FAILED_POKEMON_IS_DEPLOYED
evolved_pokemon_data	`enum (PokemonData)`
experience_awarded	`integer (int32)`
candy_awarded	`integer (int32)`

`fortDeployPokemon(fortID, pokemonID)` ⇒ `Promise`

Deploys a pokémon to a gym (or fort).

Params

Name	Type
fortID	`string`
pokemonID	`integer (fixed64)`

Response

Name	Type	Description
result	`enum (FortDeployPokemonResponse.Result)`	0 = NO_RESULT_SET 1 = SUCCESS 2 = ERROR_ALREADY_HAS_POKEMON_ON_FORT 3 = ERROR_OPPOSING_TEAM_OWNS_FORT 4 = ERROR_FORT_IS_FULL 5 = ERROR_NOT_IN_RANGE 6 = ERROR_PLAYER_HAS_NO_TEAM 7 = ERROR_POKEMON_NOT_FULL_HP 8 = ERROR_PLAYER_BELOW_MINIMUM_LEVEL 9 = ERROR_POKEMON_IS_BUDDY
fort_details	`enum (FortDetailsResponse)`
pokemon_data	`enum (PokemonData)`
gym_state	`enum (Gym.GymState)`

`fortDetails(fortID, fortLatitude, fortLongitude)` ⇒ `Promise`

Fetches information (team, pokémons, image, description, etc.) about a pokéstop or a gym (fort).

Params

Name	Type
fortID	`string`
fortLatitude	`double`
fortLongitude	`double`

Response

Name	Type	Description
fort_id	`string`
team_color	`enum (TeamColor)`
pokemon_data	`enum (PokemonData)`
name	`string`
image_urls	`string`
fp	`integer (int32)`
stamina	`integer (int32)`
max_stamina	`integer (int32)`
type	`unknown (Map.Fort.FortType)`
latitude	`double`
longitude	`double`
description	`string`
modifiers	`unknown (Map.Fort.FortModifier)`

`fortRecallPokemon(fortID, pokemonID)` ⇒ `Promise`

Recalls a fort pokémon.

Params

Name	Type
fortID	`string`
pokemonID	`integer (fixed64)`

Response

Name	Type	Description
result	`enum (FortRecallPokemonResponse.Result)`	0 = NO_RESULT_SET 1 = SUCCESS 2 = ERROR_NOT_IN_RANGE 3 = ERROR_POKEMON_NOT_ON_FORT 4 = ERROR_NO_PLAYER
fort_details	`enum (FortDetailsResponse)`

`fortSearch(fortID, fortLatitude, fortLongitude)` ⇒ `Promise`

Searches a fort (collects items from a pokéstop).

Params

Name	Type
fortID	`string`
fortLatitude	`double`
fortLongitude	`double`

Response

Name	Type	Description
result	`enum (FortSearchResponse.Result)`	0 = NO_RESULT_SET 1 = SUCCESS 2 = OUT_OF_RANGE 3 = IN_COOLDOWN_PERIOD 4 = INVENTORY_FULL 5 = EXCEEDED_DAILY_LIMIT
items_awarded	`unknown (Inventory.Item.ItemAward)`
gems_awarded	`integer (int32)`
pokemon_data_egg	`enum (PokemonData)`
experience_awarded	`integer (int32)`
cooldown_complete_timestamp_ms	`integer (int64)`
chain_hack_sequence_number	`integer (int32)`

`getAssetDigest(platform, deviceManufacturer, deviceModel, locale, appVersion)` ⇒ `Promise`

Fetches the asset digest.

Params

Name	Type
platform	`enum (Platform)`
deviceManufacturer	`string`
deviceModel	`string`
locale	`string`
appVersion	`integer (uint32)`

Response

Name	Type	Description
digest	`enum (AssetDigestEntry)`
timestamp_ms	`integer (uint64)`

`getBuddyWalked()` ⇒ `Promise`

Params

No parameters for message GetBuddyWalkedMessage

Response

Name	Type	Description
success	`boolean`
family_candy_id	enum (PokemonFamilyId)
candy_earned_count	integer (int32)

`getDownloadURLs(assetIDs)` ⇒ `Promise`

Fetches download URLs.

Params

Name	Type
assetIDs	`string`

Response

Name	Type	Description
download_urls	`enum (DownloadUrlEntry)`

`getGymDetails(gymID, gymLatitude, gymLongitude, clientVersion)` ⇒ `Promise`

Fetches information about a gym.

Params

Name	Type
gymID	`string`
gymLatitude	`double`
gymLongitude	`double`
clientVersion	`string`

Response

Name	Type	Description
gym_state	`enum (Gym.GymState)`
name	`string`
urls	`string`
result	enum (GetGymDetailsResponse.Result)`	0 = UNSET 1 = SUCCESS 2 = ERROR_NOT_IN_RANGE
description	`string`
secondary_url	`string`

`getHatchedEggs()` ⇒ `Promise`

Returns all hatched eggs and information about them.

Params

(no parameters required)

Response

Name	Type	Description
success	`boolean`
pokemon_id	`integer (fixed64)`
experience_awarded	`integer (int32)`
candy_awarded	`integer (int32)`
stardust_awarded	`integer (int32)`
hatched_pokemon	`enum (PokemonData)`

`getIncensePokemon()` ⇒ `Promise`

Fetches pokémons in an incense.

Params

(no parameters required)

Response

Name	Type	Description
result	`enum (GetIncensePokemonResponse.Result)`	0 = INCENSE_ENCOUNTER_UNKNOWN 1 = INCENSE_ENCOUNTER_AVAILABLE 2 = INCENSE_ENCOUNTER_NOT_AVAILABLE
pokemon_id	`enum (PokemonId)`
latitude	`double`
longitude	`double`
encounter_location	`string`
encounter_id	`integer (fixed64)`
disappear_timestamp_ms	`integer (int64)`
pokemon_display	`Data.PokemonDisplay`

`getInventory(lastTimestamp)` ⇒ `Promise`

Fetches the inventory with a delta (0 = load all).

Params

Name	Type
lastTimestamp	`integer (int64)`

Response

Name	Type	Description
success	`boolean`
inventory_delta	`unknown (Inventory.InventoryDelta)`

`getMapObjects(cellIDs, sinceTimestamps)` ⇒ `Promise`

Fetches all objects in the map.

Params

Name	Type
cellIDs	`integer (uint64)`
sinceTimestamps	`integer (int64)`

Response

Name	Type	Description
map_cells	`unknown (Map.MapCell)`
status	`unknown (Map.MapObjectsStatus)`
time_of_day	`enum (GetMapObjectsReponse.TimeOfDay)`	0 = NONE 1 = DAY 2 = NIGHT

`getPlayer()` ⇒ `Promise`

Fetches player information.

Params

Name	Type
country	`string`
language	`string`
timezone	`string`

Response

Name	Type	Description
result	`enum (GetPlayerProfileResponse.Result)`	0 = UNSET 1 = SUCCESS
start_time	`integer (int64)`
badges	`enum (PlayerBadge)`

`getPlayerProfile(playerName)` ⇒ `Promise`

Fetches player's profile.

Params

Name	Type
playerName	`string`

Response

Name	Type	Description
success	`boolean`
player_data	`enum (PlayerData)`

`incenseEncounter(encounterID, encounterLocation)` ⇒ `Promise`

Triggered when encountering a pokémon spawned from an incense.

Params

Name	Type
encounterID	`integer (int64)`
encounterLocation	`string`
active_item	`integer (ItemId)`

Response

Name	Type	Description
result	`enum (IncenseEncounterResponse.Result)`	0 = INCENSE_ENCOUNTER_UNKNOWN 1 = INCENSE_ENCOUNTER_SUCCESS 2 = INCENSE_ENCOUNTER_NOT_AVAILABLE 3 = POKEMON_INVENTORY_FULL
pokemon_data	`enum (PokemonData)`
capture_probability	`enum (Capture.CaptureProbability)`

`levelUpRewards(level)` ⇒ `Promise`

Requests rewards when level upping.

Params

Name	Type
level	`integer (int32)`
avatar_template_ids	`string`

Response

Name	Type	Description
result	`enum (LevelUpRewardsResponse.Result)`	0 = UNSET 1 = SUCCESS 2 = AWARDED_ALREADY
items_awarded	`unknown (Inventory.Item.ItemAward)`
items_unlocked	`unknown (Inventory.Item.ItemId)`

`listAvatarCustomizations(avatarType, slots, filters, start, limit) ⇒` Promise`

Params

Name	Type
avatarType	`enum (Data.Player.PlayerAvatarType)`
slots	`enum (Enums.Slot)[]`
filters	`enum (Enums.Fliter)[]`
start	`integer`
limit	`integer`

Response

Name	Type	Description
result	`enum (ListAvatarCustomizationsResponse.Result)`	0 = UNSET 1 = SUCCESS 2 = FAILURE
avatar_customizations	`Data.Avatar.AvatarCustomization`

`markTutorialComplete(tutorialsCompleted, sendMarketingEmails, sendPushNotifications)` ⇒ `Promise`

Completes the tutorial.

Params

Name	Type
tutorialsCompleted	`enum (TutorialState)`
sendMarketingEmails	`boolean`
sendPushNotifications	`boolean`

Response

Name	Type	Description
success	`boolean`
player_data	`enum (PlayerData)`

`nicknamePokemon(pokemonID, nickname)` ⇒ `Promise`

Gives a nickname to a pokémon.

Params

Name	Type
pokemonID	`integer (fixed64)`
nickname	`string`

Response

Name	Type	Description
result	`enum (NicknamePokemonResponse.Result)`	0 = UNSET 1 = SUCCESS 2 = ERROR_INVALID_NICKNAME 3 = ERROR_POKEMON_NOT_FOUND 4 = ERROR_POKEMON_IS_EGG

`recycleInventoryItem(itemID, count)` ⇒ `Promise`

Deletes an inventory item.

Params

Name	Type
itemID	`integer (ItemId)`
count	`integer (int32)`

Response

Name	Type	Description
result	`enum (RecycleInventoryItemResponse.Result)`	0 = UNSET 1 = SUCCESS 2 = ERROR_NOT_ENOUGH_COPIES 3 = ERROR_CANNOT_RECYCLE_INCUBATORS
new_count	`integer (int32)`

`releasePokemon(pokemonIDs)` ⇒ `Promise`

Releases (or transfers) one or multiple pokémon.

Params

Name	Type
pokemonIDs	`integer (fixed64)` or `integer[]`

Response

Name	Type	Description
result	`enum (ReleasePokemonResponse.Result)`	0 = UNSET 1 = SUCCESS 2 = POKEMON_DEPLOYED 3 = FAILED 4 = ERROR_POKEMON_IS_EGG 5 = ERROR_POKEMON_IS_BUDDY
candy_awarded	`integer (int32)`

`setAvatar(playerAvatar)` ⇒ `Promise`

Changes player's avatar.

Params

Name	Type
playerAvater	`POGOProtos.Data.Player.PlayerAvatar`

Response

Name	Type	Description
status	`enum (SetAvatarResponse.Status)`	0 = UNSET 1 = SUCCESS 2 = AVATAR_ALREADY_SET 3 = FAILURE 4 = SLOT_NOT_ALLOWED 5 = ITEM_NOT_OWNED 6 = INVALID_AVATAR_TYPE
player_data	`enum (PlayerData)`

`setAvatarItemAsViewed(avatarTemplateID)` ⇒ `Promise`

Params

Name	Type
avatarTemplateIDs	`string[]`

Response

Name	Type	Description
result	`enum (SetAvatarItemAsViewedReponse.Result)`	0 = UNSET 1 = SUCCESS 2 = FAILURE

`setBuddyPokemon(pokemonID)` ⇒ `Promise`

Params

| Name | Type | |---|---|---| | pokemon_id | integer (fixed64) |

Response

Name	Type	Description
status	`enum (SetBuddyPokemonResponse.Result)`	0 = UNEST 1 = SUCCESS 2 = ERROR_POKEMON_DEPLOYED 3 = ERROR_POKEMON_NOT_OWNED 4 = ERROR_POKEMON_IS_EGG
updated_buddy	`enum (Data.BuddyPokemon)`

`setContactSettings(sendMarketingEmails, sendPushNotifications)` ⇒ `Promise`

Sets contact settings.

Params

Name	Type
sendMarketingEmails	`boolean`
sendPushNotifications	`boolean`

Response

Name	Type	Description
status	`enum (SetContactSettingsResponse.Status)`	0 = UNSET 1 = SUCCESS 2 = FAILURE
player_data	`enum (PlayerData)`

`setFavoritePokemon(pokemonID, isFavorite)` ⇒ `Promise`

Sets a pokémon as a favorite.

Params

Name	Type
pokemonID	`integer (uint64)`
isFavorite	`boolean`

Response

Name	Type	Description
result	`enum (SetFavoritePokemonResponse.Result)`	0 = UNSET 1 = SUCCESS 2 = ERROR_POKEMON_NOT_FOUND 3 = ERROR_POKEMON_IS_EGG

`setPlayerTeam(teamColor)` ⇒ `Promise`

Sets player's team (can be set only once).

Params

Name	Type
team	`enum (TeamColor)`

Response

Name	Type	Description
status	`enum (SetPlayerTeamResponse.Status)`	0 = UNSET 1 = SUCCESS 2 = TEAM_ALREADY_SET 3 = FAILURE
player_data	`enum (PlayerData)`

`sfidaActionLog()` ⇒ `Promise`

Params

(no parameters required)

Response

Name	Type	Description
result	`enum (SfidaActionLogResponse.Result)`	0 = UNSET 1 = SUCCESS
log_entries	`enum (Logs.ActionLogEntry)`

`startGymBattle(gymID, attackingPokemonIDs, defendingPokemonID)` ⇒ `Promise`

Starts a gym battle.

Params

Name	Type
gymID	`string`
attackingPokemonIDs	`integer (fixed64)`
defendingPokemonID	`integer (fixed64)`

Response

Name	Type	Description
result	`enum (StartGymBattleResponse.Result)`	0 = UNSET 1 = SUCCESS 2 = ERROR_GYM_NOT_FOUND 3 = ERROR_GYM_NEUTRAL 4 = ERROR_GYM_WRONG_TEAM 5 = ERROR_GYM_EMPTY 6 = ERROR_INVALID_DEFENDER 7 = ERROR_TRAINING_INVALID_ATTACKER_COUNT 8 = ERROR_ALL_POKEMON_FAINTED 9 = ERROR_TOO_MANY_BATTLES 10 = ERROR_TOO_MANY_PLAYERS 11 = ERROR_GYM_BATTLE_LOCKOUT 12 = ERROR_PLAYER_BELOW_MINIMUM_LEVEL 13 = ERROR_NOT_IN_RANGE
battle_start_timestamp_ms	`integer (int64)`
battle_end_timestamp_ms	`integer (int64)`
battle_id	`string`
defender	`enum (Battle.BattleParticipant)`
battle_log	`enum (Battle.BattleLog)`

`upgradePokemon(pokemonID)` ⇒ `Promise`

Upgrades or powers up a pokémon.

Params

Name	Type
pokemonID	`integer (fixed64)`

Response

Name	Type	Description
result	`enum (UpgradePokemonResponse.Result)`	0 = UNSET 1 = SUCCESS 2 = ERROR_POKEMON_NOT_FOUND 3 = ERROR_INSUFFICIENT_RESOURCES 4 = ERROR_UPGRADE_NOT_AVAILABLE 5 = ERROR_POKEMON_IS_DEPLOYED
upgraded_pokemon	`enum (PokemonData)`

`useIncense(itemID)` ⇒ `Promise`

Uses an incense.

Params

Name	Type
itemID	`integer (ItemId)`

Response

Name	Type	Description
result	`enum (UseIncenseResponse.Result)`	0 = UNKNOWN 1 = SUCCESS 2 = INCENSE_ALREADY_ACTIVE 3 = NONE_IN_INVENTORY 4 = LOCATION_UNSET
applied_incense	`unknown (Inventory.AppliedItem)`

`useItemCapture(itemID, encounterID, spawnPointID)` ⇒ `Promise`

Uses a razz berry (legacy).

Params

Name	Type
itemID	`integer (ItemId)`
encounterID	`integer (fixed64)`
spawnPointID	`string`

Response

Name	Type	Description
success	`boolean`
item_capture_mult	`double`
item_flee_mult	`double`
stop_movement	`boolean`
stop_attack	`boolean`
target_max	`boolean`
target_slow	`boolean`

`useItemEggIncubator(itemID, pokemonID)` ⇒ `Promise`

Adds an egg to an incubator.

Params

Name	Type
itemID	`string`
pokemonID	`integer (uint64)`

Response

Name	Type	Description
result	`enum (UseItemEggIncubatorResponse.Result)`	0 = UNSET 1 = SUCCESS 2 = ERROR_INCUBATOR_NOT_FOUND 3 = ERROR_POKEMON_EGG_NOT_FOUND 4 = ERROR_POKEMON_ID_NOT_EGG 5 = ERROR_INCUBATOR_ALREADY_IN_USE 6 = ERROR_POKEMON_ALREADY_INCUBATING 7 = ERROR_INCUBATOR_NO_USES_REMAINING
egg_incubator	`unknown (Inventory.EggIncubator)`

`useItemEncounter(itemID, encounterID, spawnPointGUID)` ⇒ `Promise`

Uses a berry.

Params

Name	Type
itemID	`integer (ItemId)`
encounterID	`integer (fixed64)`
spawnPointGUID	`string`

Response

Name	Type	Description
status	`Status`
capture_probability	`enum (Capture.CaptureProbability)`
active_item	`integer (ItemId)`

`useItemGym(itemID, gymID)` ⇒ `Promise`

Params

Name	Type
itemID	`integer (ItemId)`
gymID	`string`

Response

Name	Type	Description
result	enum (UseItemGymResponse.Result)`	0 = UNSET 1 = SUCCESS 2 = ERROR_CANNOT_USE 3 = ERROR_NOT_IN_RANGE
updated_gp	`integer (int64)`

`useItemPotion(itemID, pokemonID)` ⇒ `Promise`

Uses a potion to a pokémon.

Params

Name	Type
itemID	`integer (ItemId)`
pokemonID	`integer (fixed64)`

Response

Name	Type	Description
result	`enum (UseItemPotionResponse.Result)`	0 = UNSET 1 = SUCCESS 2 = ERROR_NO_POKEMON 3 = ERROR_CANNOT_USE 4 = ERROR_DEPLOYED_TO_FORT
stamina	`integer (int32)`

`useItemRevive(itemID, pokemonID)` ⇒ `Promise`

Uses a revive to a pokémon.

Params

Name	Type
itemID	`integer (ItemId)`
pokemonID	`integer (fixed64)`

Response

Name	Type	Description
result	`enum (UseItemReviveResponse.Result)`	0 = UNSET 1 = SUCCESS 2 = ERROR_NO_POKEMON 3 = ERROR_CANNOT_USE 4 = ERROR_DEPLOYED_TO_FORT

`useItemXPBoost(itemID)` ⇒ `Promise`

Uses a lucky egg.

Params

Name	Type
itemID	`integer (ItemId)`

Response

Name	Type	Description
result	`enum (UseItemXpBoostResponse.Result)`	0 = UNSET 1 = SUCCESS 2 = ERROR_INVALID_ITEM_TYPE 3 = ERROR_XP_BOOST_ALREADY_ACTIVE 4 = ERROR_NO_ITEMS_REMAINING 5 = ERROR_LOCATION_UNSET
applied_items	`unknown (Inventory.AppliedItems)`

`verifyChallenge(token)` ⇒ `Promise`

Params

Name	Type
token	`string`

Response

Name	Type	Description
success	`boolean`

pogobuf.Client Pokémon Go API Methods