Pokeapi V2 API Reference
Abilities
api/v2/ability/{id or name}
Abilities provide passive effects for pokemon in battle or in the overworld. Pokemon have mutiple possible abilities but can have only one ability at a time. Check out Bulbapedia for greater detail.
example response
{
"id": 1,
"name": "stench",
"is_main_series": true,
"generation": {
"name": "generation-iii",
"url": "http://localhost:8000/api/v2/generation/3/"
},
"names": [{
"name": "Stench",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}],
"effect_entries": [{
"effect": "This Pokémon's damaging moves have a 10% chance to make the target [flinch]{mechanic:flinch} with each hit if they do not already cause flinching as a secondary effect.\n\nThis ability does not stack with a held item.\n\nOverworld: The wild encounter rate is halved while this Pokémon is first in the party.",
"short_effect": "Has a 10% chance of making target Pokémon [flinch]{mechanic:flinch} with each hit.",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}],
"effect_changes": [{
"version_group": {
"name": "black-white",
"url": "http://localhost:8000/api/v2/version-group/11/"
},
"effect_entries": [{
"effect": "Has no effect in battle.",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}]
}],
"flavor_text_entries": [{
"flavor_text": "è‡ãã¦ã€€ç›¸æ‰‹ãŒ\nã²ã‚‹ã‚€ã€€ã“ã¨ãŒã‚る。",
"language": {
"name": "ja-kanji",
"url": "http://localhost:8000/api/v2/language/11/"
},
"version_group": {
"name": "x-y",
"url": "http://localhost:8000/api/v2/version-group/15/"
}
}],
"pokemon": [{
"is_hidden": true,
"slot": 3,
"pokemon": {
"name": "gloom",
"url": "http://localhost:8000/api/v2/pokemon/44/"
}
}]
}
response models
Ability
Name |
Description |
Data Type |
id |
The identifier for this ability resource |
integer |
name |
The name for this ability resource |
string |
is_main_series |
Whether or not this ability originated in the main series of the video games |
boolean |
generation |
The generation this ability originated in |
APIResource (Generation) |
names |
The name of this ability listed in different languages |
[Name] |
effect_entries |
The effect of this ability listed in different languages |
[VerboseEffect] |
effect_changes |
The list of previous effects this ability has had across version groups |
[AbilityEffectChange] |
flavor_text_entries |
The flavor text of this ability listed in different languages |
[VersionSpecificFlavorText] TODO |
pokemon |
A list of pokemon that could potentially have this ability |
[AbilityPokemon] |
AbilityEffectChange
Name |
Description |
Data Type |
effect_entries |
The previous effect of this ability listed in different languages |
Effect |
version_group |
The version group in which the previous effect of this ability originated |
APIResource (VersionGroup) |
AbilityFlavorText
Name |
Description |
Data Type |
flavor_text |
The localized name for an api resource in a specific language |
string |
language |
The language this name is in |
APIResource (Language) |
version_group |
The version group that uses this flavor text |
APIResource (VersionGroup) |
AbilityPokemon
Name |
Description |
Data Type |
is_hidden |
Whether or not this a hidden ability for the referenced pokemon |
boolean |
slot |
Pokemon have 3 ability 'slots' which hold references to possible abilities they could have. This is the slot of this ability for the referenced pokemon. |
integer |
pokemon |
The pokemon this ability could belong to |
APIResource (Pokemon) |
Berries
api/v2/berry/{id or name}
Berries are small fruits that can provide HP and status condition restoration, stat enhancement, and even damage negation when eaten by pokemon. Check out Bulbapedia for greater detail.
example response
{
"id": 1,
"name": "cheri",
"growth_time": 3,
"max_harvest": 5,
"natural_gift_power": 60,
"size": 20,
"smoothness": 25,
"soil_dryness": 15,
"firmness": {
"name": "soft",
"url": "http://localhost:8000/api/v2/berry-firmness/2/"
},
"flavors": [{
"potency": 10,
"flavor": {
"name": "spicy",
"url": "http://localhost:8000/api/v2/berry-flavor/1/"
}
}],
"item": {
"name": "cheri-berry",
"url": "http://localhost:8000/api/v2/item/126/"
},
"natural_gift_type": {
"name": "fire",
"url": "http://localhost:8000/api/v2/type/10/"
}
}
response models
Berry
Name |
Description |
Data Type |
id |
The identifier for this berry resource |
integer |
name |
The name for this berry resource |
string |
growth_time |
Time it takes the tree to grow one stage, in hours. Berry trees go through four of these growth stages before they can be picked. |
integer |
max_harvest |
The maximum number of these berries that can grow on one tree in Generation IV |
integer |
natural_gift_power |
The power of the move "Natural Gift" when used with this Berry |
integer |
size |
The size of this Berry, in millimeters |
integer |
smoothness |
The smoothness of this Berry, used in making Pokéblocks or Poffins |
integer |
soil_dryness |
The speed at which this Berry dries out the soil as it grows. A higher rate means the soil dries more quickly. |
integer |
firmness |
The firmness of this berry, used in making Pokéblocks or Poffins |
APIResource (BerryFirmness) |
flavors |
A list of references to each flavor a berry can have and the potency of each of those flavors in regard to this berry |
[BerryFlavorMap] |
item |
Berries are actually items. This is a reference to the item specific data for this berry. |
APIResource (Item) |
natural_gift_type |
The Type the move "Natural Gift" has when used with this Berry |
APIResource (Type) |
BerryFlavorMap
Name |
Description |
Data Type |
potency |
How powerful the referenced flavor is for this berry |
integer |
flavor |
The referenced berry flavor |
APIResource (BerryFlavor) |
Berry Firmnesses
api/v2/berry-firmness/{id or name}
Berry firmness is a fairly extraneous attribute that effects the outcome of Pokéblocks or Poffins. Check out Bulbapedia for greater detail.
example response
{
"id": 1,
"name": "very-soft",
"berries": [{
"name": "pecha",
"url": "http://localhost:8000/api/v2/berry/3/"
}],
"names": [{
"name": "Very Soft",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}]
}
response models
BerryFirmness
Name |
Description |
Data Type |
id |
The identifier for this berry firmness resource |
integer |
name |
The name for this berry firmness resource |
string |
berries |
A list of the berries with this firmness |
[APIResource (Berry)] |
names |
The name of this berry firmness listed in different languages |
[Name] |
Berry Flavors
api/v2/berry-flavor/{id or name}
Flavors determine whether a pokemon will benefit or suffer from eating a berry based on their nature. Check out Bulbapedia for greater detail.
example response
{
"id": 1,
"name": "spicy",
"berries": [{
"potency": 10,
"berry": {
"name": "rowap",
"url": "http://localhost:8000/api/v2/berry/64/"
}
}],
"contest_type": {
"name": "cool",
"url": "http://localhost:8000/api/v2/contest-type/1/"
},
"names": [{
"name": "Spicy",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}]
}
response models
BerryFlavor
Name |
Description |
Data Type |
id |
The identifier for this berry flavor resource |
integer |
name |
The name for this berry flavor resource |
string |
berries |
A list of the berries with this flavor |
[FlavorBerryMap] |
contest_type |
The contest type that correlates with this berry flavor |
APIResource (ContestType) |
names |
The name of this berry flavor listed in different languages |
[Name] |
FlavorBerryMap
Name |
Description |
Data Type |
potency |
How powerful the referenced flavor is for this berry |
integer |
berry |
The berry with the referenced flavor |
APIResource (Berry) |
Characteristics
api/v2/characteristic/{id}
Characteristics indicate which stat contains a Pokémon's highest IV. A Pokémon's Characteristic is determined by the remainder of its highest IV divided by 5 (gene_modulo). Check out Bulbapedia for greater detail.
example response
response models
Characteristic
Name |
Description |
Data Type |
id |
The identifier for this characteristic resource |
integer |
gene_modulo |
The remainder of the highest stat/IV divided by 5 |
integer |
possible_values |
The possible values of the highest stat that would result in a pokemon recieving this characteristic when divided by 5 |
[integer] |
descriptions |
The descriptions of this characteristic listed in different languages |
[Description] |
Contest Types
api/v2/contest-type/{id or name}
Contest types are categories judges used to weigh a pokemons condition in pokemon contests. Check out Bulbapedia for greater detail.
example response
{
"id": 1,
"name": "cool",
"berry_flavor": {
"name": "spicy",
"url": "http://localhost:8000/api/v2/berry-flavor/1/"
},
"names": [{
"name": "Cool",
"color": "Red",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}]
}
response models
ContestType
Name |
Description |
Data Type |
id |
The identifier for this contest type resource |
integer |
name |
The name for this contest type resource |
string |
berry_flavor |
The berry flavor that correlates with this contest type |
APIResource (BerryFlavor) |
names |
The name of this contest type listed in different languages |
[Name] |
Contest Effects
api/v2/contest-effect/{id or name}
Contest effects refer to the effects of moves when used in contests.
example response
{
"id": 1,
"appeal": 4,
"jam": 0,
"effect_entries": [{
"effect": "Gives a high number of appeal points wth no other effects.",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}],
"flavor_text_entries": [{
"flavor_text": "A highly appealing move.",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}]
}
response models
ContestEffect
Name |
Description |
Data Type |
id |
The identifier for this contest type resource |
integer |
appeal |
The base number of hearts the user of this move gets |
string |
jam |
The base number of hearts the user's opponent loses |
integer |
effect_entries |
The result of this contest effect listed in different languages |
[Effect] |
flavor_text_entries |
The flavor text of this contest effect listed in different languages |
[FlavorText] |
Egg Groups
api/v2/egg-group/{id or name}
Egg Groups are categories which determine which Pokémon are able to interbreed. Pokémon may belong to either one or two Egg Groups. Check out Bulbapedia for greater detail.
example response
{
"id": 1,
"name": "monster",
"names": [{
"name": "ã‹ã„ã˜ã‚…ã†",
"language": {
"name": "ja",
"url": "http://localhost:8000/api/v2/language/1/"
}
}],
"pokemon_species": [{
"name": "bulbasaur",
"url": "http://localhost:8000/api/v2/pokemon-species/1/"
}]
}
response models
EggGroup
Name |
Description |
Data Type |
id |
The identifier for this egg group resource |
integer |
name |
The name for this egg group resource |
string |
names |
The name of this egg group listed in different languages |
[Name] |
pokemon_species |
A list of all pokemon species that are members of this egg group |
APIResource (PokemonSpecies) |
Encounter Methods
api/v2/encounter-method/{id or name}
example response
response models
Encounter Method
Name |
Description |
Data Type |
id |
The identifier for this encounter method resource |
integer |
name |
The name for this encounter method resource |
string |
order |
The order index of this encounter method within the main game series data |
integer |
names |
The name of this encounter method listed in different languages |
[Name] |
Encounter Conditions
api/v2/encounter-condition/{id or name}
example response
response models
Encounter Condition
Name |
Description |
Data Type |
id |
The identifier for this encounter condition resource |
integer |
name |
The name for this encounter condition resource |
string |
names |
The name of this encounter method listed in different languages |
[Name] |
values |
A list of possible values for this encounter condition |
[APIReference (EncounterConditionValue)] |
Encounter Condition Values TODO
api/v2/encounter-condition-value/{id or name}
example response
response models
Encounter Condition Value
Name |
Description |
Data Type |
id |
The identifier for this encounter condition value resource |
integer |
name |
The name for this encounter condition value resource |
string |
condition |
The condition this encounter condition value pertains to |
[APIReference] |
names |
The name of this encounter method listed in different languages |
[Name] |
Evolution Chains
api/v2/evolution-chain/{id}
example response
response models
Evolution Chain
Name |
Description |
Data Type |
id |
The identifier for this evolution chain resource |
integer |
baby_trigger_item |
The item that a pokemon would be holding when mating that would trigger the egg hatching a baby pokemon rather than a basic pokemon |
APIReference (Item) |
chain |
The base chain link object. Each link contains evolution details for a pokemon in the chain. Each link references the next pokemon in the natural evolution order. |
ChainLink |
Chain Link
Name |
Description |
Data Type |
is_baby |
Whether or not this link is for a baby pokemon. This would only ever be true on the base link. |
boolean |
species |
The pokemon species at this point in the evolution chain |
APIReference (PokemonSpecies) |
evolution_details |
All details regarding the specific details of the referenced pokemon species evolution |
EvolutionDetail |
evolves_to |
A List of chain objects. |
ChainLink |
Evolution Detail
Name |
Description |
Data Type |
item |
The item required to cause evolution this into pokemon species |
APIReference (Item) |
trigger |
The type of event that triggers evolution into this pokemon species |
APIReference (EvolutionTrigger) |
gender |
The gender the evolving pokemon species must be in order to evolve into this pokemon species |
APIReference (Gender) |
held_item |
The item the evolving pokemon species must be holding during the evolution trigger event to evolve into this pokemon species |
APIReference (Item) |
known_move |
The move that must be known by the evolving pokemon species during the evolution trigger event in order to evolve into this pokemon species |
APIReference (Move) |
known_move_type |
The evolving pokemon species must know a move with this type during the evolution trigger event in order to evolve into this pokemon species |
APIReference (Type) |
location |
The location the evolution must be triggered at. |
APIReference (Location) |
min_level |
The minimum required level of the evolving pokemon species to evolve into this pokemon species |
integer |
min_hapiness |
The minimum required level of happiness the evolving pokemon species to evolve into this pokemon species |
integer |
min_beauty |
The minimum required level of beauty the evolving pokemon species to evolve into this pokemon species |
integer |
min_affection |
The minimum required level of affection the evolving pokemon species to evolve into this pokemon species |
integer |
needs_overworld_rain |
Whether or not it must be raining in the overworld to cause evolution this pokemon species |
boolean |
party_species |
The pokemon species that must be in the players party in order for the evolving pokemon species to evolve into this pokemon species |
APIReference (PokemonSpecies) |
party_type |
The player must have a pokemon of this type in their party during the evolution trigger event in order for the evolving pokemon species to evolve into this pokemon species |
APIReference (Type) |
relative_physical_stats |
The required relation between the Pokémon's Attack and Defense stats. 1 means Attack > Defense. 0 means Attack = Defense. -1 means Attack < Defense. |
integer |
time_of_day |
The required time of day. Day or night. |
string |
trade_species |
Pokemon species for which this one must be traded. |
APIReference (Pokemon Species) |
turn_upside_down |
Whether or not the 3DS needs to be turned upside-down as this Pokémon levels up. |
boolean |
Encounter Triggers
api/v2/evolution-trigger/{id or name}
example response
response models
Evolution Trigger
Name |
Description |
Data Type |
id |
The identifier for this evolution trigger resource |
integer |
name |
The name for this evolution trigger resource |
string |
names |
The name of this evolution trigger listed in different languages |
[Name] |
pokemon_species |
A list of pokemon species that result from this evolution trigger |
[APIReference (PokemonSpecies)] |
Generations
api/v2/generation/{id or name}
example response
response models
Generation
Name |
Description |
Data Type |
id |
The identifier for this generation resource |
integer |
name |
The name for this generation resource |
string |
abilities |
A list of abilities that were introduced in this generation |
[APIReference (Ability)] |
names |
The name of this generation listed in different languages |
[Name] |
main_region |
The main region travelled in this generation |
APIReference (Region) |
moves |
A list of moves that were introduced in this generation |
[APIReference (Move)] |
pokemon_species |
A list of pokemon species that were introduced in this generation |
[APIReference (PokemonSpecies)] |
types |
A list of types that were introduced in this generation |
[APIReference (Type)] |
version_groups |
A list of version groups that were introduced in this generation |
[APIReference (VersionGroup)] |
Gender
api/v2/gender/{id or name}
example response
response models
Gender
Name |
Description |
Data Type |
id |
The identifier for this gender resource |
integer |
name |
The name for this gender resource |
string |
pokemon_species_details |
A list of pokemon species that can be this gender and how likely it is that they will be |
[(PokemonSpeciesGenderChance] |
required_for_evolution |
A list of pokemon species that required this gender in order for a pokemon to evolve into them |
[APIReference (PokemonSpecies)] |
PokemonSpeciesGenderChance
Name |
Description |
Data Type |
rate |
The chance of this Pokémon being female, in eighths; or -1 for genderless |
integer |
pokemon_species |
A pokemon species that can be the referenced gender |
APIReference (PokemonSpecies) |
Growth Rates
api/v2/growth-rate/{id or name}
example response
response models
Growth Rate
Name |
Description |
Data Type |
id |
The identifier for this gender resource |
integer |
name |
The name for this gender resource |
string |
formula |
The formula used to calculate the rate at which the pokemon species gains level |
string |
descriptions |
The descriptions of this characteristic listed in different languages |
[Description] |
levels |
A list of levels and the amount of experienced needed to atain them based on this growth rate |
[GrowthRateExperienceLevel] |
pokemon_species |
A list of pokemon species that gain levels at this growth rate |
[APIReference (PokemonSpecies)] |
GrowthRateExperienceLevel
Name |
Description |
Data Type |
level |
The level gained |
integer |
experience |
The amount of experience required to reach the referenced level |
integer |
Items
api/v2/item/{id or name}
example response
response models
Item
Name |
Description |
Data Type |
id |
The identifier for this item resource |
integer |
name |
The name for this item resource |
string |
cost |
The price of this item in stores |
integer |
fling_power |
The power of the move Fling when used with this item. |
integer |
fling_effect |
The effect of the move Fling when used with this item |
ItemFlingEffect |
attributes |
A list of attributes this item has |
[APIReference (ItemAttribute)] |
category |
The category of items this item falls into |
ItemCategory |
effect_entries |
The effect of this ability listed in different languages |
[VerboseEffect] |
flavor_text_entries |
The flavor text of this ability listed in different languages |
[VersionSpecificFlavorText] TODO |
game_indices |
A list of game indices relevent to this item by generation |
[GenerationGameIndex] |
names |
The name of this item listed in different languages |
[Name] |
held_by_pokemon |
A list of pokemon that might be found in the wild holding this item |
[APIReference (Pokemon)] |
baby_trigger_for |
An evolution chain this item requires to produce a bay during mating |
[APIReference (Evolution Chain)] |
Item Fling Effects
api/v2/item-fling-effect/{id or name}
example response
response models
Item Fling Effect
Name |
Description |
Data Type |
id |
The identifier for this fling effect resource |
integer |
name |
The name for this fling effect resource |
string |
effect_entries |
The result of this fling effect listed in different languages |
[Effect] |
items |
A list of items that have this fling effect |
[Item] |
Item Categories
api/v2/item-category/{id or name}
example response
response models
Item Category
Name |
Description |
Data Type |
id |
The identifier for this item category resource |
integer |
name |
The name for this item category resource |
string |
items |
A list of items that fall into this category |
[Item] |
names |
The name of this item category listed in different languages |
[Name] |
pocket |
The pocket items in this category would be put in |
[APIReference (ItemPocket)] |
Item Pockets
api/v2/item-pocket/{id or name}
example response
response models
Item Pocket
Name |
Description |
Data Type |
id |
The identifier for this item pocket resource |
integer |
name |
The name for this item pocket resource |
string |
categories |
A list of item categories that are relevent to this item pocket |
[ItemCategory] |
names |
The name of this item category listed in different languages |
[Name] |
Languages
api/v2/language/{id or name}
example response
response models
Language
Name |
Description |
Data Type |
id |
The identifier for this item pocket resource |
integer |
name |
The name for this item pocket resource |
string |
official |
Whether or not the games are published in this language |
boolean |
is639 |
The two-letter code of the country where this language is spoken. Note that it is not unique. |
string |
iso3166 |
The two-letter code of the language. Note that it is not unique. |
string |
names |
The name of this language listed in different languages |
[Name] |
Locations
api/v2/location/{id or name}
example response
response models
Location
Name |
Description |
Data Type |
id |
The identifier for this location resource |
integer |
name |
The name for this location resource |
string |
region |
The region this location can be found in |
APIReference (Region) |
names |
The name of this language listed in different languages |
[Name] |
game_indices |
A list of game indices relevent to this location by generation |
[GenerationGameIndex] |
areas |
Areas that can be found within this location |
APIReference (LocationArea) |
Location Areas
api/v2/location-area/{id}
example response
response models
Location Area
Name |
Description |
Data Type |
id |
The identifier for this location resource |
integer |
name |
The name for this location resource |
string |
game_index |
The internal id of an api resource within game data |
integer |
encounter_method_rates |
A list of methods in which pokemon may be encountered in this area and how likely the method will occur depending on the version of the game |
[EncounterMethodRate] |
location |
The region this location can be found in |
APIReference (Region) |
names |
The name of this location area listed in different languages |
[Name] |
pokemon_encounters |
A list of pokemon that can be encountered in this area along with version specific details about the encounter |
PokemonEncounter |
PokemonEncounter
VersionGroupEncounterDetail
Name |
Description |
Data Type |
version |
The game version this encounter happens in |
APIReference (Version) |
max_chance |
The total percentage of all encounter potential |
integer |
encounter_details |
A list of encounters and their specifics |
[Encounter] |
Moves
api/v2/move/{id or name}
example response
response models
Move
Name |
Description |
Data Type |
id |
The identifier for this location resource |
integer |
name |
The name for this location resource |
string |
accuracy |
The percent value of how likely this move is to be successful |
integer |
effect_chance |
The percent value of how likely it is this moves effect will take effect |
integer |
pp |
Power points. The number of times this move can be used |
integer |
priority |
A value between -8 and 8. Sets the order in which moves are executed during battle. See Bulbapedia for greater detail. |
integer |
power |
The base power of this move with a value of 0 if it does not have a base power |
integer |
contest_combos |
A detail of normal and super contest combos that require this move |
[ContestComboSets] |
contest_type |
The type of appeal this move gives a pokemon when used in a contest |
APIReference (ContestType) |
contest_effect |
The effect the move has when used in a contest |
APIReference (ContestEffect) |
damage_class |
The type of damage the move inflicts on the target, e.g. physical |
APIReference (MoveDamageClass) |
effect_entries |
The effect of this move listed in different languages |
[VerboseEffect] |
effect_changes |
The list of previous effects this move has had across version groups of the games |
[AbilityEffectChange] |
generation |
The generation in which this move was introduced |
APIReference (Generation) |
meta |
Meta data about this move |
MoveMetaData |
names |
The name of this location area listed in different languages |
[Name] |
past_values |
A list of move resource value changes across ersion groups of the game |
PastMoveStatValues |
stat_changes |
A list of stats this moves effects and how much it effects them |
[MoveStatChange] |
contest_effect |
The effect the move has when used in a super contest |
APIReference (ContestEffect) |
target |
The type of target that will recieve the effects of the attack |
MoveTarget |
type |
The elemental type of this move |
Type |
ContestComboSets
Name |
Description |
Data Type |
normal |
A detail of moves this move can be used before or after, granting additional appeal points in contests |
[ContestComboDetail] |
super |
A detail of moves this move can be used before or after, granting additional appeal points in super contests |
[ContestComboDetail] |
ContestComboDetail
Name |
Description |
Data Type |
use_before |
A list of moves to use before this move |
[APIReference (Move)] |
use_after |
A list of moves to use after this move |
[APIReference (Move)] |
MoveMetaData
Name |
Description |
Data Type |
ailment |
The status ailment this move inflicts on its target |
APIReference (MoveAilment) |
category |
The category of move this move falls under, e.g. damage or ailment |
APIReference (Move) |
min_hits |
The minimum number of times this move hits. Null if it always only hits once. |
integer |
max_hits |
The maximum number of times this move hits. Null if it always only hits once. |
integer |
min_turns |
The minimum number of turns this move continues to take effect. Null if it always only lasts one turn. |
integer |
max_turns |
The maximum number of turns this move continues to take effect. Null if it always only lasts one turn. |
integer |
drain |
HP drain (if positive) or Recoil damage (if negative), in percent of damage done |
integer |
healing |
The amount of hp gained by the attacking pokemon, in percent of it's maximum HP |
integer |
crit_rate |
Critical hit rate bonus |
integer |
ailment_chance |
The likelyhood this attack will cause an ailment |
integer |
flinch_chance |
The likelyhood this attack will cause the target pokemon to flinch |
integer |
stat_chance |
The likelyhood this attack will cause a stat change in the target pokemon |
integer |
MoveStatChange
Name |
Description |
Data Type |
change |
The amount of change |
integer |
stat |
The stat being affected |
APIReference Stat |
PastMoveStatValues
Name |
Description |
Data Type |
accuracy |
The percent value of how likely this move is to be successful |
integer |
effect_chance |
The percent value of how likely it is this moves effect will take effect |
integer |
power |
The base power of this move with a value of 0 if it does not have a base power |
integer |
pp |
Power points. The number of times this move can be used |
integer |
effect_entries |
The effect of this move listed in different languages |
[VerboseEffect] |
type |
The elemental type of this move |
Type |
version group |
The version group in which these move stat values were in effect |
APIReference VersionGroup |
Move Ailments
api/v2/move-ailment/{id or name}
example response
response models
Move Ailment
Name |
Description |
Data Type |
id |
The identifier for this move ailment resource |
integer |
name |
The name for this move ailment resource |
string |
moves |
A list of moves that cause this ailment |
[APIReference (Move)] |
names |
The name of this move ailment listed in different languages |
[Name] |
Move Battle Styles
api/v2/move-battle-style/{id or name}
example response
response models
Move Battle Style
Name |
Description |
Data Type |
id |
The identifier for this move battle style resource |
integer |
name |
The name for this move battle style resource |
string |
names |
The name of this move battle style listed in different languages |
[Name] |
Move Categories
api/v2/move-category/{id or name}
example response
response models
Move Category
Name |
Description |
Data Type |
id |
The identifier for this move category resource |
integer |
name |
The name for this move category resource |
string |
moves |
A list of moves that fall into this category |
[APIReference (Move)] |
descriptions |
The description of this move ailment listed in different languages |
[Description] |
Move Damage Classes
api/v2/move-damage-class/{id or name}
example response
response models
Move Damage Class
Name |
Description |
Data Type |
id |
The identifier for this move damage class resource |
integer |
name |
The name for this move damage class resource |
string |
descriptions |
The description of this move damage class listed in different languages |
[Description] |
moves |
A list of moves that fall into this damage class |
[APIReference (Move)] |
names |
The name of this move damage class listed in different languages |
[Name] |
Move Learn Methods
api/v2/move-learn-method/{id or name}
example response
response models
Move Learn Method
Name |
Description |
Data Type |
id |
The identifier for this move learn method resource |
integer |
name |
The name for this move learn method resource |
string |
descriptions |
The description of this move learn method listed in different languages |
[Description] |
names |
The name of this move learn method listed in different languages |
[Name] |
version_groups |
A list of version groups where moves can be learned through this method |
[APIReference (VersionGroup)] |
Move Targets
api/v2/move-target/{id or name}
example response
response models
Move Target
Name |
Description |
Data Type |
id |
The identifier for this move target resource |
integer |
name |
The name for this move target resource |
string |
descriptions |
The description of this move target listed in different languages |
[Description] |
moves |
A list of moves that that are directed at this target |
[APIReference (Move)] |
names |
The name of this move target listed in different languages |
[Name] |
Natures
api/v2/nature/{id or name}
example response
response models
Nature
Name |
Description |
Data Type |
id |
The identifier for this nature resource |
integer |
name |
The name for this nature resource |
string |
decreased_stat |
The stat decreased by 10% in pokemon with this nature |
APIReference (Stat |
increased_stat |
The stat increased by 10% in pokemon with this nature |
APIReference (Stat |
hates_flavor |
The flavor hated by pokemon with this nature |
APIReference (BerryFlavor |
likes_flavor |
The flavor liked by pokemon with this nature |
APIReference (BerryFlavor |
pokeathlon_stat_changes |
A list of pokeathlon stats this nature effects and how much it effects them |
[NatureStatChange] |
move_battle_style_preferences |
A list of battle styles and how likely a pokemon with this nature is to use them in the Battle Palace or Battle Tent. |
[MoveBattleStylePreference] |
names |
The name of this nature listed in different languages |
[Name] |
NatureStatChange
MoveBattleStylePreference
Name |
Description |
Data Type |
low_hp_preference |
Chance of using the move, in percent, if HP is under one half |
integer |
high_hp_preference |
Chance of using the move, in percent, if HP is over one half |
integer |
move_battle_style |
The move battle style |
APIReference (MoveBattleStyle) |
Pal Park Areas
api/v2/pal-park-area/{id or name}
example response
response models
PalParkArea
Name |
Description |
Data Type |
id |
The identifier for this pal park area resource |
integer |
name |
The name for this pal park area resource |
string |
names |
The name of this pal park area listed in different languages |
[Name] |
pokemon_encounters |
A list of pokemon encountered in thi pal park area along with details |
PalParkEncounterSpecies |
PalParkEncounterSpecies
Name |
Description |
Data Type |
base_score |
The base score given to the player when this pokemon is caught during a pal park run |
integer |
rate |
The base rate for encountering this pokemon in this pal park area |
integer |
pokemon_species |
The pokemon species being encountered |
APIResource (PokemonSpecies) |
Pokedexes
api/v2/pokedex/{id or name}
example response
response models
Pokedex
Name |
Description |
Data Type |
id |
The identifier for this pokedex resource |
integer |
name |
The name for this pokedex resource |
string |
is_main_series |
Whether or not this pokedex originated in the main series of the video games |
boolean |
descriptions |
The description of this pokedex listed in different languages |
[Description] |
names |
The name of this pokedex listed in different languages |
[Name] |
pokemon_entries |
A list of pokemon catalogued in this pokedex and their indexes |
[PokemonEntry] |
region |
The region this pokedex catalogues pokemon for |
APIReference (Region) |
version_groups |
A list of version groups this pokedex is relevent to |
APIReference (VersionGroup) |
PalParkEncounter
Name |
Description |
Data Type |
entry_number |
The index of this pokemon species entry within the pokedex |
integer |
pokemon_species |
The pokemon species being encountered |
APIResource (PokemonSpecies) |
Pokemon
api/v2/pokemon/{id or name}
example response
response models
Pokemon
Name |
Description |
Data Type |
id |
The identifier for this pokemon resource |
integer |
name |
The name for this pokemon resource |
string |
base_experience |
The base experience gained for defeating this pokemon |
integer |
height |
The height of this pokemon |
integer |
is_default |
Set for exactly one pokemon used as the default for each species |
boolean |
order |
TODO |
integer |
weight |
The weight of this pokemon |
integer |
abilities |
A list of abilities this pokemon could potentially have |
[PokemonAbility] |
forms |
A list of forms this pokemon can take on |
[APIResource (PokemonForm)] |
game_indices |
A list of game indices relevent to pokemon item by generation |
[VersionGameIndex] |
held_items |
A list of items this pokemon may be holding when encountered |
[APIResource (Item)] |
location_area_encounters |
|
|
moves |
|
|
species |
The species this pokemon belongs to |
PokemonSpecies) |
stats |
A list of base stat values for this pokemon |
[APIResource (Stat)] |
types |
A list of details showing types this pokemon has |
[(PokemonType)] |
PokemonAbility
Name |
Description |
Data Type |
is_hidden |
Whether or not this is a hidden ability |
boolean |
slot |
The slot this ability occupies in this pokemon species |
integer |
ability |
The ability the pokemon may have |
APIResource (Ability) |
PokemonType
Name |
Description |
Data Type |
slot |
The order the pokemons types are listed in |
integer |
type |
The type the referenced pokemon has |
string |
Pokemon Colors
api/v2/pokemon-color/{id or name}
example response
response models
PokemonColor
Name |
Description |
Data Type |
id |
The identifier for this pokemon color resource |
integer |
name |
The name for this pokemon color resource |
string |
names |
The name of this pokemon color listed in different languages |
[Name] |
pokemon_species |
A list of the pokemon species that have this color |
[APIResource (PokemonSpecies)] |
Pokemon Forms
api/v2/pokemon-form/{id or name}
example response
response models
PokemonForm
Name |
Description |
Data Type |
id |
The identifier for this pokemon color resource |
integer |
name |
The name for this pokemon color resource |
string |
order |
The order in which forms should be sorted within all forms. Multiple forms may have equal order, in which case they should fall back on sorting by name. |
integer |
form_order |
The order in which forms should be sorted within a species' forms |
integer |
is_default |
True for exactly one form used as the default for each pokemon |
boolean |
is_battle_only |
Whether or not this form can only happen during battle |
boolean |
is_mega |
Whether or not this form requires mega evolution |
boolean |
form_name |
The name of this form |
string |
pokemon |
The pokemon that can take on this form |
APIResource (Pokemon) |
version_group |
The version group this pokemon form was introduced in |
APIResource (VersionGroup) |
Pokemon Habitats
api/v2/pokemon-habitat/{id or name}
example response
response models
PokemonHabitat
Name |
Description |
Data Type |
id |
The identifier for this pokemon habitat resource |
integer |
name |
The name for this pokemon habitat resource |
string |
names |
The name of this pokemon habitat listed in different languages |
[Name] |
pokemon_species |
A list of the pokemon species that can be found in this habitat |
[APIResource (PokemonSpecies)] |
Pokemon Shapes
api/v2/pokemon-shape/{id or name}
example response
response models
PokemonShape
Name |
Description |
Data Type |
id |
The identifier for this pokemon shape resource |
integer |
name |
The name for this pokemon shape resource |
string |
awesome_names |
The "scientific" name of this pokemon shape listed in different languages |
[AwesomeName] |
names |
The name of this pokemon shape listed in different languages |
[Name] |
pokemon_species |
A list of the pokemon species that have this shape |
[APIResource (PokemonSpecies)] |
AwesomeName
Name |
Description |
Data Type |
awesome_name |
The localized "scientific" name for an api resource in a specific language |
string |
language |
The language this "scientific" name is in |
APIResource (Language) |
Pokemon Species
api/v2/pokemon-species/{id or name}
example response
response models
PokemonSpecies
Name |
Description |
Data Type |
id |
The identifier for this pokemon species resource |
integer |
name |
The name for this pokemon species resource |
string |
order |
The order in which species should be sorted. Based on National Dex order, except families are grouped together and sorted by stage. |
integer |
gender_rate |
The chance of this Pokémon being female, in eighths; or -1 for genderless |
integer |
capture_rate |
The base capture rate; up to 255. The higher the number, the easier the catch. |
integer |
base_happiness |
The happiness when caught by a normal pokeball; up to 255. The higher the number, the happier the pokemon. |
integer |
is_baby |
Whether or not this is a baby pokemon |
boolean |
hatch_counter |
Initial hatch counter: one must walk 255 × (hatch_counter + 1) steps before this Pokémon's egg hatches, unless utilizing bonuses like Flame Body's |
integer |
has_gender_differences |
Whether or not this pokemon can have different genders |
boolean |
forms_switchable |
Whether or not this pokemon has multiple forms and can switch between them |
boolean |
growth_rate |
The rate at which this pokemon species gains levels |
APIResource (GrowthRate) |
pokedex_numbers |
A list of pokedexes and the indexes reserved within them for this pokemon species |
PokemonSpeciesDexEntry |
egg_groups |
A list of egg groups this pokemon species is a member of |
[APIResource (EggGroup)] |
color |
The color of this pokemon for gimmicky pokedex search |
[APIResource (PokemonColor)] |
shape |
The shape of this pokemon for gimmicky pokedex search |
[APIResource (PokemonShape)] |
evolves_from_species |
The pokemon species that evolves into this pokemon_species |
APIResource (PokemonSpecies) |
evolution_chain |
The evolution chain this pokemon species is a member of |
APIResource (EvolutionChain) |
habitat |
The habitat this pokemon species can be encountered in |
APIResource (PokemonHabitat) |
generation |
The generation this pokemon species was introduced in |
APIResource (Generation) |
names |
The name of this pokemon species listed in different languages |
[Name] |
pal_park_encounters |
A list of encounters that can be had with this pokemon species in pal park |
[PalParkEncounterArea] |
form_descriptions |
TODO |
|
genera |
The genus of this pokemon species listed in multiple languages |
Genus |
varieties |
A list of the pokemon that exist within this pokemon species |
[APIResource (Pokemon)] |
Genus
Name |
Description |
Data Type |
genus |
The localized genus for the referenced pokemon species |
string |
language |
The language this genus is in |
APIResource (Language) |
PokemonSpeciesDexEntry
Name |
Description |
Data Type |
entry_number |
The index number within the pokedex |
integer |
name |
The pokdex the referenced pokemon species can be found in |
APIResource (Pokedex) |
PalParkEncounterArea
Name |
Description |
Data Type |
base_score |
The base score given to the player when the referenced pokemon is caught during a pal park run |
integer |
rate |
The base rate for encountering the referenced pokemon in this pal park area |
integer |
area |
The pal park area where this encounter happens |
APIResource (PalParkArea) |
Pokeathlon Stats
api/v2/pokeathlon-stat/{id or name}
example response
response models
PokeathlonStat
Name |
Description |
Data Type |
id |
The identifier for this pokeathlon stat resource |
integer |
name |
The name for this pokeathlon stat resource |
string |
names |
The name of this pokeathlon stat listed in different languages |
[Name] |
affecting_natures |
A detail of natures which affect this pokeathlon stat positively or negatively |
NaturePokeathlonStatAffectSets |
NaturePokeathlonStatAffectSets
NaturePokeathlonStatAffect
Name |
Description |
Data Type |
max_change |
The maximum amount of change to the referenced pokeathlon stat |
integer |
nature |
The nature causing the change |
APIResource (Nature) |
Regions
api/v2/region/{id or name}
example response
response models
Region
Name |
Description |
Data Type |
id |
The identifier for this region resource |
integer |
name |
The name for this region resource |
string |
locations |
A list of locations that can be found in this region |
APIResource (Location) |
main_generation |
The generation this region was introduced in |
APIResource (Generation) |
names |
The name of this region listed in different languages |
[Name] |
pokedexes |
A list of pokedexes that catalogue pokemon in this region |
APIResource (Pokedex) |
version_groups |
A list of version groups where this region can be visited |
APIResource (VersionGroup) |
Stats
api/v2/stat/{id or name}
example response
response models
Stat
Name |
Description |
Data Type |
id |
The identifier for this stat resource |
integer |
name |
The name for this stat resource |
string |
game_index |
ID the games use for this stat |
integer |
is_battle_only |
Whether this stat only exists within a battle |
boolean |
affecting_moves |
A detail of moves which affect this stat positively or negatively |
MoveStatAffectSets |
affecting_natures |
A detail of natures which affect this stat positively or negatively |
NatureStatAffectSets |
characteristics |
A list of characteristics that are set on a pokemon when its highest base stat is this stat |
[APIResource (Characteristic)] |
move_damage_class |
The class of damage this stat is directly related to |
APIResource (MoveDamageClass) |
names |
The name of this region listed in different languages |
[Name] |
MoveStatAffectSets
Name |
Description |
Data Type |
increase |
A list of moves and how they change the referenced stat |
MoveStatAffect |
decrease |
A list of moves and how they change the referenced stat |
MoveStatAffect |
MoveStatAffect
Name |
Description |
Data Type |
max_change |
The maximum amount of change to the referenced stat |
integer |
move |
The move causing the change |
APIResource (Move) |
NatureStatAffectSets
Name |
Description |
Data Type |
increase |
A list of natures and how they change the referenced stat |
NatureStatAffect |
decrease |
A list of nature sand how they change the referenced stat |
NatureStatAffect |
NatureStatAffect
Name |
Description |
Data Type |
max_change |
The maximum amount of change to the referenced stat |
integer |
nature |
The nature causing the change |
APIResource (Nature) |
Super Contest Effects
api/v2/super-contest-effect/{id or name}
example response
response models
SuperContestEffect
Name |
Description |
Data Type |
id |
The identifier for this super contest effect resource |
integer |
appeal |
The level of appeal this super contest effect has |
string |
flavor_text_entries |
The flavor text of this super contest effect listed in different languages |
[FlavorText] |
moves |
A list of moves that have the effect when used in super contests |
[APIResource (Move)] |
Types
api/v2/types/{id or name}
example response
response models
Type
Name |
Description |
Data Type |
id |
The identifier for this type resource |
integer |
name |
The name for this type resource |
string |
damage_relations |
|
|
game_indices |
A list of game indices relevent to this item by generation |
[GenerationGameIndex] |
generation |
The generation this type was introduced in |
APIResource (Generation |
move_damage_class |
The class of damage inflicted by this type |
APIResource (MoveDamageClass) |
names |
The name of this type listed in different languages |
[Name] |
pokemon |
A list of details of pokemon that have this type |
TypePokemon |
moves |
A list of moves that have this type |
[APIResource (Move)] |
TypePokemon
Name |
Description |
Data Type |
slot |
The order the pokemons types are listed in |
integer |
pokemon |
The pokemon that has the referenced type |
APIResource (Pokemon |
Versions
api/v2/version/{id or name}
example response
response models
Version
Name |
Description |
Data Type |
id |
The identifier for this version resource |
integer |
name |
The name for this version resource |
string |
names |
The name of this version listed in different languages |
[Name] |
version_group |
The version group this version belongs to |
[APIResource (VersionGroup)] |
Version Groups
api/v2/version-group/{id or name}
example response
response models
VersionGroup
Name |
Description |
Data Type |
id |
The identifier for this version group resource |
integer |
name |
The name for this version group resource |
string |
order |
Order for sorting. Almost by date of release, except similar versions are grouped together. |
integer |
generation |
The generation this version was introduced in |
[APIResource (Generation)] |
move_learn_methods |
A list of methods in which pokemon can learn moves in this version group |
[APIResource (MoveLearnMethod)] |
names |
The name of this version group listed in different languages |
[Name] |
pokedexes |
A list of pokedexes introduces in this version group |
[APIResource (Pokedex)] |
regions |
A list of regions that can be visited in this version group |
[APIResource (Region)] |
versions |
The versions this version group owns |
[APIResource (Version)] |
Common Models
APIResource
Name |
Description |
Data Type |
name |
The name of the referenced resource |
string |
url |
The url of the referenced resource |
string |
Description
Name |
Description |
Data Type |
description |
The localized description for an api resource in a specific language |
string |
language |
The language this name is in |
APIResource (Language) |
Effect
Name |
Description |
Data Type |
effect |
The localized effect text for an api resource in a specific language |
string |
language |
The language this effect is in |
APIResource (Language) |
Encounter
Name |
Description |
Data Type |
min_level |
The lowest level the pokemon could be encountered at |
integer |
max_level |
The highest level the pokemon could be encountered at |
integer |
condition_values |
A list of condition values that must be in effect for this encounter to occur |
[APIResource (EncounterConditionValue)] |
chance |
percent chance that this encounter will occur |
integer |
method |
The method by which this encounter happens |
APIResource (EncounterMethod) |
FlavorText
Name |
Description |
Data Type |
flavor_text |
The localized name for an api resource in a specific language |
string |
language |
The language this name is in |
APIResource (Language) |
GenerationGameIndex
Name |
Description |
Data Type |
game_index |
The internal id of an api resource within game data |
integer |
generation |
The generation relevent to this game index |
APIResource (Generation) |
Name
Name |
Description |
Data Type |
name |
The localized name for an api resource in a specific language |
string |
language |
The language this name is in |
APIResource (Language) |
VerboseEffect
Name |
Description |
Data Type |
effect |
The localized effect text for an api resource in a specific language |
string |
short_effect |
The localized effect text in brief |
string |
language |
The language this effect is in |
APIResource (Language) |
VersionGameIndex
Name |
Description |
Data Type |
game_index |
The internal id of an api resource within game data |
integer |
version |
The version relevent to this game index |
APIResource (Version) |