2015-11-28 14:30:55 +00:00
# Pokeapi V2 API Reference
2015-12-02 01:00:20 +00:00
< table >
< tbody >
< tr >
< th colspan = "3" > API Endpoints< / th >
< / tr >
< tr >
< td >
< ul >
< li > < a href = "#abilities" > Abilities< / a > < / li >
< li > < a href = "#berries" > Berries< / a > < / li >
2015-12-02 05:05:16 +00:00
< li > < a href = "#berry-firmnesses" > Berry Firmnesses< / a > < / li >
< li > < a href = "#berry-flavors" > Berry Flavors< / a > < / li >
2015-12-02 01:00:20 +00:00
< li > < a href = "#characteristics" > Characteristics< / a > < / li >
2015-12-02 05:05:16 +00:00
< li > < a href = "#contest-types" > Contest Types< / a > < / li >
< li > < a href = "#contest-effects" > Contest Effects< / a > < / li >
< li > < a href = "#egg-groups" > Egg Groups< / a > < / li >
< li > < a href = "#encounter-methods" > Encounter Methods< / a > < / li >
< li > < a href = "#encounter-conditions" > Encounter Conditions< / a > < / li >
< li > < a href = "#encounter-condition-values" > Encounter Condition Values< / a > < / li >
< li > < a href = "#evolution-chains" > Evolution Chains< / a > < / li >
< li > < a href = "#evolution-triggers" > Evolution Triggers< / a > < / li >
2015-12-02 01:00:20 +00:00
< li > < a href = "#generations" > Generations< / a > < / li >
< li > < a href = "#genders" > Genders< / a > < / li >
2015-12-02 05:05:16 +00:00
< li > < a href = "#growth-rates" > Growth Rates< / a > < / li >
2015-12-02 01:00:20 +00:00
< / ul >
< / td >
< td >
< ul >
< li > < a href = "#items" > Items< / a > < / li >
2015-12-02 05:05:16 +00:00
< li > < a href = "#item-categories" > Item Categories< / a > < / li >
< li > < a href = "#item-attributes" > Item Attributes< / a > < / li >
< li > < a href = "#item-fling-effects" > Item Fling Effects< / a > < / li >
< li > < a href = "#item-pockets" > Item Pockets< / a > < / li >
2015-12-02 01:00:20 +00:00
< li > < a href = "#languages" > Languages< / a > < / li >
< li > < a href = "#locations" > Locations< / a > < / li >
2015-12-02 05:05:16 +00:00
< li > < a href = "#location-areas" > Location Areas< / a > < / li >
2015-12-02 01:00:20 +00:00
< li > < a href = "#moves" > Moves< / a > < / li >
2015-12-02 05:05:16 +00:00
< li > < a href = "#move-ailments" > Move Ailments< / a > < / li >
< li > < a href = "#move-battle-styles" > Move Battle Styles< / a > < / li >
< li > < a href = "#move-categories" > Move Categories< / a > < / li >
< li > < a href = "#move-damage-classes" > Move Damage Classes< / a > < / li >
< li > < a href = "#move-learn-methods" > Move Learn Methods< / a > < / li >
< li > < a href = "#move-targets" > Move Targets< / a > < / li >
2015-12-02 01:00:20 +00:00
< li > < a href = "#natures" > Natures< / a > < / li >
< / ul >
< / td >
< td >
< ul >
2015-12-02 05:05:16 +00:00
< li > < a href = "#pal-park-areas" > Pal Park Areas< / a > < / li >
2015-12-02 01:00:20 +00:00
< li > < a href = "#pokedexes" > Pokedexes< / a > < / li >
< li > < a href = "#pokemon" > Pokemon< / a > < / li >
2015-12-02 05:05:16 +00:00
< li > < a href = "#pokemon-colors" > Pokemon Colors< / a > < / li >
< li > < a href = "#pokemon-forms" > Pokemon Forms< / a > < / li >
< li > < a href = "#pokemon-habitats" > Pokemon Habitats< / a > < / li >
< li > < a href = "#pokemon-shapes" > Pokemon Shapes< / a > < / li >
< li > < a href = "#pokemon-species" > Pokemon Species< / a > < / li >
< li > < a href = "#pokeathlon-stats" > Pokeathlon Stats< / a > < / li >
2015-12-02 01:00:20 +00:00
< li > < a href = "#regions" > Regions< / a > < / li >
< li > < a href = "#stats" > Stats< / a > < / li >
2015-12-04 14:05:49 +00:00
< li > < a href = "#super-contest-effects" > Super Contest Effects< / a > < / li >
2015-12-02 01:00:20 +00:00
< li > < a href = "#types" > Types< / a > < / li >
< li > < a href = "#version" > Versions< / a > < / li >
2015-12-02 05:05:16 +00:00
< li > < a href = "#version-groups" > Version Groups< / a > < / li >
2015-12-02 01:00:20 +00:00
< / ul >
< / td >
< / tr >
< / tbody >
< / table >
2015-12-02 00:21:01 +00:00
2015-12-02 00:21:01 +00:00
2015-11-29 23:39:38 +00:00
## Abilities
```
api/v2/ability/{id or name}
```
2015-12-02 05:05:16 +00:00
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 ](http://bulbapedia.bulbagarden.net/wiki/Ability ) for greater detail.
2015-11-28 14:30:55 +00:00
2015-12-02 00:01:17 +00:00
###### example response
```json
{
"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
2015-11-28 14:30:55 +00:00
Name | Description | Data Type
---- | ----------- | ---------
2015-12-02 05:05:16 +00:00
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 ](#apiresource ) ([Generation](#generations))
names | The name of this ability listed in different languages | [[Name ](#resourcename )]
effect_entries | The effect of this ability listed in different languages | [[VerboseEffect ](#verboseeffect )]
effect_changes | The list of previous effects this ability has had across version groups | [[AbilityEffectChange ](#abilityeffectchange )]
2015-12-04 05:07:19 +00:00
flavor_text_entries | The flavor text of this ability listed in different languages | [[VersionGroupFlavorText ](#versiongroupflavortext )]
2015-12-02 05:05:16 +00:00
pokemon | A list of pokemon that could potentially have this ability | [[AbilityPokemon ](#abilitypokemon )]
2015-11-28 14:30:55 +00:00
2015-11-28 23:52:05 +00:00
#### AbilityEffectChange
2015-11-28 14:30:55 +00:00
Name | Description | Data Type
---- | ----------- | ---------
2015-12-02 05:05:16 +00:00
effect_entries | The previous effect of this ability listed in different languages | [Effect ](#effect )
2015-12-02 00:01:17 +00:00
version_group | The version group in which the previous effect of this ability originated | [APIResource ](#apiresource ) ([VersionGroup](#versiongroups))
2015-11-28 14:30:55 +00:00
2015-12-02 05:05:16 +00:00
#### 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 ](#apiresource ) ([Language](#languages))
version_group | The version group that uses this flavor text | [APIResource ](#apiresource ) ([VersionGroup](#version-groups))
#### AbilityPokemon
2015-11-28 14:30:55 +00:00
Name | Description | Data Type
---- | ----------- | ---------
2015-11-28 16:25:30 +00:00
is_hidden | Whether or not this a hidden ability for the referenced pokemon | boolean
2015-11-28 14:30:55 +00:00
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
2015-11-29 23:39:38 +00:00
pokemon | The pokemon this ability could belong to | [APIResource ](#apiresource ) ([Pokemon](#pokemon))
2015-11-28 14:30:55 +00:00
2015-11-29 23:39:38 +00:00
## Berries
2015-11-28 14:30:55 +00:00
```
api/v2/berry/{id or name}
```
2015-11-29 23:39:38 +00:00
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 ](http://bulbapedia.bulbagarden.net/wiki/Berry ) for greater detail.
2015-11-28 14:30:55 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
{
"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
2015-11-28 14:30:55 +00:00
Name | Description | Data Type
---- | ----------- | ---------
2015-12-02 05:05:16 +00:00
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 ](#apiresource ) ([BerryFirmness](#berry-firmnesses))
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 ](#berryflavormap )]
item | Berries are actually items. This is a reference to the item specific data for this berry. | [APIResource ](#apiresource ) ([Item](#items))
natural_gift_type | The Type the move "Natural Gift" has when used with this Berry | [APIResource ](#apiresource ) ([Type](#types))
2015-11-28 14:30:55 +00:00
#### BerryFlavorMap
Name | Description | Data Type
---- | ----------- | ---------
potency | How powerful the referenced flavor is for this berry | integer
2015-12-02 05:05:16 +00:00
flavor | The referenced berry flavor | [APIResource ](#apiresource ) ([BerryFlavor](#berry-flavors))
2015-11-28 14:30:55 +00:00
2015-11-29 23:39:38 +00:00
## Berry Firmnesses
2015-11-28 14:30:55 +00:00
```
api/v2/berry-firmness/{id or name}
```
2015-12-02 05:05:16 +00:00
Berry firmness is a fairly extraneous attribute that effects the outcome of Pokéblocks or Poffins. Check out [Bulbapedia ](http://bulbapedia.bulbagarden.net/wiki/Berry ) for greater detail.
###### example response
```json
{
"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
2015-11-28 14:30:55 +00:00
Name | Description | Data Type
---- | ----------- | ---------
2015-11-29 23:39:38 +00:00
id | The identifier for this berry firmness resource | integer
name | The name for this berry firmness resource | string
2015-12-01 18:47:46 +00:00
berries | A list of the berries with this firmness | [[APIResource ](#apiresource ) ([Berry](#berries))]
2015-11-29 23:39:38 +00:00
names | The name of this berry firmness listed in different languages | [[Name ](#resourcename )]
2015-11-28 14:30:55 +00:00
2015-11-29 23:39:38 +00:00
## Berry Flavors
2015-11-28 14:30:55 +00:00
```
api/v2/berry-flavor/{id or name}
```
2015-12-02 05:05:16 +00:00
2015-11-29 23:39:38 +00:00
Flavors determine whether a pokemon will benefit or suffer from eating a berry based on their [nature ](#natures ). Check out [Bulbapedia ](http://bulbapedia.bulbagarden.net/wiki/Flavor ) for greater detail.
2015-11-28 14:30:55 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
{
"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
2015-11-28 14:30:55 +00:00
Name | Description | Data Type
---- | ----------- | ---------
2015-11-29 23:39:38 +00:00
id | The identifier for this berry flavor resource | integer
name | The name for this berry flavor resource | string
2015-12-02 05:05:16 +00:00
berries | A list of the berries with this flavor | [[FlavorBerryMap ](#flavorberrymap )]
contest_type | The contest type that correlates with this berry flavor | [APIResource ](#apiresource ) ([ContestType](#contest-types))
2015-11-29 23:39:38 +00:00
names | The name of this berry flavor listed in different languages | [[Name ](#resourcename )]
2015-12-02 05:05:16 +00:00
#### FlavorBerryMap
Name | Description | Data Type
---- | ----------- | ---------
potency | How powerful the referenced flavor is for this berry | integer
berry | The berry with the referenced flavor | [APIResource ](#apiresource ) ([Berry](#berry))
2015-11-28 14:30:55 +00:00
2015-11-29 23:39:38 +00:00
## Characteristics
2015-11-28 14:30:55 +00:00
```
api/v2/characteristic/{id}
```
2015-12-02 05:05:16 +00:00
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 ](http://bulbapedia.bulbagarden.net/wiki/Characteristic ) for greater detail.
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"gene_modulo": 0,
"possible_values": [0, 5, 10, 15, 20, 25, 30],
"highest_stat": {
"name": "hp",
"url": "http://localhost:8000/api/v2/stat/1/"
},
"descriptions": [{
"description": "Loves to eat",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### Characteristic
2015-11-28 14:30:55 +00:00
Name | Description | Data Type
---- | ----------- | ---------
2015-12-02 05:05:16 +00:00
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 ](#description )]
2015-11-28 14:30:55 +00:00
2015-11-29 23:39:38 +00:00
## Contest Types
2015-11-28 14:30:55 +00:00
```
api/v2/contest-type/{id or name}
```
2015-12-02 05:05:16 +00:00
Contest types are categories judges used to weigh a pokemons condition in pokemon contests. Check out [Bulbapedia ](http://bulbapedia.bulbagarden.net/wiki/Contest_condition ) for greater detail.
###### example response
```json
{
"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
2015-11-28 14:30:55 +00:00
Name | Description | Data Type
---- | ----------- | ---------
2015-11-29 23:39:38 +00:00
id | The identifier for this contest type resource | integer
name | The name for this contest type resource | string
2015-12-02 05:05:16 +00:00
berry_flavor | The berry flavor that correlates with this contest type | [APIResource ](#apiresource ) ([BerryFlavor](#berry-flavors))
2015-11-29 23:39:38 +00:00
names | The name of this contest type listed in different languages | [[Name ](#resourcename )]
2015-11-28 14:30:55 +00:00
2015-11-29 23:39:38 +00:00
## Contest Effects
2015-11-28 14:30:55 +00:00
```
2015-11-29 23:39:38 +00:00
api/v2/contest-effect/{id or name}
2015-11-28 14:30:55 +00:00
```
2015-12-02 05:05:16 +00:00
Contest effects refer to the effects of moves when used in contests.
###### example response
```json
{
"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
2015-11-28 14:30:55 +00:00
Name | Description | Data Type
---- | ----------- | ---------
2015-11-29 23:39:38 +00:00
id | The identifier for this contest type resource | integer
2015-12-02 05:05:16 +00:00
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
2015-11-29 23:39:38 +00:00
effect_entries | The result of this contest effect listed in different languages | [[Effect ](#effect )]
flavor_text_entries | The flavor text of this contest effect listed in different languages | [[FlavorText ](#flavortext )]
2015-11-28 14:30:55 +00:00
2015-11-29 23:39:38 +00:00
## Egg Groups
2015-11-28 14:30:55 +00:00
```
api/v2/egg-group/{id or name}
```
2015-12-02 05:05:16 +00:00
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 ](http://bulbapedia.bulbagarden.net/wiki/Egg_Group ) for greater detail.
###### example response
```json
{
"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
2015-11-28 14:30:55 +00:00
Name | Description | Data Type
---- | ----------- | ---------
2015-12-02 05:05:16 +00:00
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 ](#resourcename )]
pokemon_species | A list of all pokemon species that are members of this egg group | [APIResource ](#apiresource ) ([PokemonSpecies](#pokemon-species))
2015-11-28 14:30:55 +00:00
2015-11-29 23:39:38 +00:00
## Encounter Methods
2015-11-28 14:30:55 +00:00
```
api/v2/encounter-method/{id or name}
```
2015-12-02 05:36:29 +00:00
Methods by which the player might can encounter pokemon in the wild, e.g., walking in tall grass. Check out [Bulbapedia ](http://bulbapedia.bulbagarden.net/wiki/Wild_Pokémon ) for greater detail.
2015-11-28 14:30:55 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-02 05:36:29 +00:00
{
"id": 1,
"name": "walk",
"order": 1,
"names": [{
"name": "Walking in tall grass or a cave",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
2015-12-04 05:07:19 +00:00
#### EncounterMethod
2015-12-02 05:05:16 +00:00
2015-11-28 14:30:55 +00:00
Name | Description | Data Type
---- | ----------- | ---------
2015-12-02 05:36:29 +00:00
id | The identifier for this encounter method resource | integer
name | The name for this encounter method resource | string
order | A good value for sorting | integer
names | The name of this encounter method listed in different languages | [[Name ](#resourcename )]
2015-11-28 14:30:55 +00:00
2015-11-29 23:39:38 +00:00
## Encounter Conditions
2015-11-28 14:30:55 +00:00
```
api/v2/encounter-condition/{id or name}
```
2015-12-02 05:36:29 +00:00
Conditions which affect what pokemon might appear in the wild, e.g., day or night.
2015-11-28 14:30:55 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-02 05:36:29 +00:00
{
"id": 1,
"name": "swarm",
"values": [{
"name": "swarm-yes",
"url": "http://localhost:8000/api/v2/encounter-condition-value/1/"
}, {
"name": "swarm-no",
"url": "http://localhost:8000/api/v2/encounter-condition-value/2/"
}],
"names": [{
"name": "Schwarm",
"language": {
"name": "de",
"url": "http://localhost:8000/api/v2/language/6/"
}
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
2015-12-04 05:07:19 +00:00
#### EncounterCondition
2015-12-02 05:05:16 +00:00
2015-11-28 14:30:55 +00:00
Name | Description | Data Type
---- | ----------- | ---------
2015-11-29 23:39:38 +00:00
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 ](#resourcename )]
2015-12-04 14:05:49 +00:00
values | A list of possible values for this encounter condition | [[APIResource ](#apiresource ) ([EncounterConditionValue](#encounter-condition-values))]
2015-11-28 14:30:55 +00:00
2015-12-02 05:36:29 +00:00
## Encounter Condition Values
2015-11-28 14:30:55 +00:00
```
api/v2/encounter-condition-value/{id or name}
```
2015-12-02 05:36:29 +00:00
Encounter condition values are the various states that an encounter condition can have, i.e., Time of day can be either day or night.
2015-11-28 14:30:55 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-02 05:36:29 +00:00
{
"id": 1,
"name": "swarm-yes",
"condition": {
"name": "swarm",
"url": "http://localhost:8000/api/v2/encounter-condition/1/"
},
"names": [{
"name": "Während eines Schwarms",
"language": {
"name": "de",
"url": "http://localhost:8000/api/v2/language/6/"
}
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
2015-12-04 05:07:19 +00:00
#### EncounterConditionValue
2015-12-02 05:05:16 +00:00
2015-11-28 14:30:55 +00:00
Name | Description | Data Type
---- | ----------- | ---------
2015-12-02 05:36:29 +00:00
id | The identifier for this encounter condition value resource | integer
name | The name for this encounter condition value resource | string
2015-12-04 14:05:49 +00:00
condition | The condition this encounter condition value pertains to | [[APIResource ](#apiresource ) ([EncounterCondition](#encounter-conditions))]
2015-12-02 05:36:29 +00:00
names | The name of this encounter condition value listed in different languages | [[Name ](#resourcename )]
2015-11-28 14:30:55 +00:00
2015-12-01 18:47:46 +00:00
## Evolution Chains
2015-11-28 14:30:55 +00:00
```
2015-11-29 23:39:38 +00:00
api/v2/evolution-chain/{id}
2015-11-28 14:30:55 +00:00
```
2015-12-02 05:36:29 +00:00
Evolution chains are essentially family trees. They start with the lowest stage within a family and detail evolution conditions for each as well as pokemon they can evolve into up through the hierarchy.
2015-11-28 14:30:55 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-02 05:36:29 +00:00
{
"id": 7,
"baby_trigger_item": null,
"chain": {
"is_baby": false,
"species": {
"name": "rattata",
"url": "http://localhost:8000/api/v2/pokemon-species/19/"
},
"evolution_details": null,
"evolves_to": [{
"is_baby": false,
"species": {
"name": "raticate",
"url": "http://localhost:8000/api/v2/pokemon-species/20/"
},
"evolution_details": {
"item": null,
"trigger": {
"name": "level-up",
"url": "http://localhost:8000/api/v2/evolution-trigger/1/"
},
"gender": null,
"held_item": null,
"known_move": null,
"known_move_type": null,
"location": null,
"min_level": 20,
"min_happiness": null,
"min_beauty": null,
"min_affection": null,
"needs_overworld_rain": false,
"party_species": null,
"party_type": null,
"relative_physical_stats": null,
"time_of_day": "",
"trade_species": null,
"turn_upside_down": false
},
"evolves_to": []
}]
}
}
2015-12-02 05:05:16 +00:00
```
###### response models
2015-12-02 05:36:29 +00:00
#### EvolutionChain
2015-12-02 05:05:16 +00:00
2015-11-28 14:30:55 +00:00
Name | Description | Data Type
---- | ----------- | ---------
2015-11-29 23:39:38 +00:00
id | The identifier for this evolution chain resource | integer
2015-12-04 14:05:49 +00:00
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 | [APIResource ](#apiresource ) ([Item](#items))
2015-11-29 23:39:38 +00:00
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 ](#chainlink )
2015-11-28 14:30:55 +00:00
2015-12-04 14:05:49 +00:00
#### ChainLink
2015-11-28 14:30:55 +00:00
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
2015-12-04 14:05:49 +00:00
species | The pokemon species at this point in the evolution chain | [APIResource ](#apiresource ) ([PokemonSpecies](#pokemon-species))
2015-12-02 00:01:17 +00:00
evolution_details | All details regarding the specific details of the referenced pokemon species evolution | [EvolutionDetail ](#evolutiondetail )
2015-11-29 23:39:38 +00:00
evolves_to | A List of chain objects. | [ChainLink ](#chainlink )
2015-12-04 14:05:49 +00:00
#### EvolutionDetail
2015-11-29 23:39:38 +00:00
Name | Description | Data Type
---- | ----------- | ---------
2015-12-04 14:05:49 +00:00
item | The item required to cause evolution this into pokemon species | [APIResource ](#apiresource ) ([Item](#items))
trigger | The type of event that triggers evolution into this pokemon species | [APIResource ](#apiresource ) ([EvolutionTrigger](#evolution-triggers))
gender | The gender the evolving pokemon species must be in order to evolve into this pokemon species | [APIResource ](#apiresource ) ([Gender](#genders))
held_item | The item the evolving pokemon species must be holding during the evolution trigger event to evolve into this pokemon species | [APIResource ](#apiresource ) ([Item](#items))
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 | [APIResource ](#apiresource ) ([Move](#moves))
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 | [APIResource ](#apiresource ) ([Type](#types))
location | The location the evolution must be triggered at. | [APIResource ](#apiresource ) ([Location](#locations))
2015-12-02 00:01:17 +00:00
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
2015-11-29 23:39:38 +00:00
needs_overworld_rain | Whether or not it must be raining in the overworld to cause evolution this pokemon species | boolean
2015-12-04 14:05:49 +00:00
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 | [APIResource ](#apiresource ) ([PokemonSpecies](#pokemon-species))
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 | [APIResource ](#apiresource ) ([Type](#types))
2015-11-29 23:39:38 +00:00
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
2015-12-04 14:05:49 +00:00
trade_species | Pokemon species for which this one must be traded. | [APIResource ](#apiresource ) ([Pokemon Species](#pokemon-species))
2015-11-29 23:39:38 +00:00
turn_upside_down | Whether or not the 3DS needs to be turned upside-down as this Pokémon levels up. | boolean
2015-12-04 14:05:49 +00:00
## Evolution Triggers
2015-11-29 23:39:38 +00:00
```
api/v2/evolution-trigger/{id or name}
```
2015-12-02 05:36:29 +00:00
Evolution triggers are the events and conditions that cause a pokemon to evolve. Check out [Bulbapedia ](http://bulbapedia.bulbagarden.net/wiki/Methods_of_evolution ) for greater detail.
2015-11-29 23:39:38 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-02 05:36:29 +00:00
{
"id": 1,
"name": "level-up",
"names": [{
"name": "Level up",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}],
"pokemon_species": [{
"name": "ivysaur",
"url": "http://localhost:8000/api/v2/pokemon-species/2/"
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
2015-12-02 05:36:29 +00:00
#### EvolutionTrigger
2015-12-02 05:05:16 +00:00
2015-11-29 23:39:38 +00:00
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 ](#resourcename )]
2015-12-04 14:05:49 +00:00
pokemon_species | A list of pokemon species that result from this evolution trigger | [[APIResource ](#apiresource ) ([PokemonSpecies](#pokemon-species))]
2015-11-29 23:39:38 +00:00
2015-12-01 18:47:46 +00:00
## Generations
2015-11-29 23:39:38 +00:00
```
api/v2/generation/{id or name}
```
2015-12-04 05:07:19 +00:00
A generation is a grouping of the Pokémon games that separates them based on the Pokémon they include. In each generation, a new set of Pokémon, Moves, Abilities and Types that did not exist in the previous generation are released.
2015-11-29 23:39:38 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "generation-i",
"abilities": [],
"main_region": {
"name": "kanto",
"url": "http://localhost:8000/api/v2/region/1/"
},
"moves": [{
"name": "pound",
"url": "http://localhost:8000/api/v2/move/1/"
}],
"names": [{
"name": "Generation I",
"language": {
"name": "de",
"url": "http://localhost:8000/api/v2/language/6/"
}
}],
"pokemon_species": [{
"name": "bulbasaur",
"url": "http://localhost:8000/api/v2/pokemon-species/1/"
}],
"types": [{
"name": "normal",
"url": "http://localhost:8000/api/v2/type/1/"
}],
"version_groups": [{
"name": "red-blue",
"url": "http://localhost:8000/api/v2/version-group/1/"
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### Generation
2015-11-29 23:39:38 +00:00
Name | Description | Data Type
---- | ----------- | ---------
id | The identifier for this generation resource | integer
name | The name for this generation resource | string
2015-12-04 14:05:49 +00:00
abilities | A list of abilities that were introduced in this generation | [[APIResource ](#apiresource ) ([Ability](#abilities))]
2015-11-29 23:39:38 +00:00
names | The name of this generation listed in different languages | [[Name ](#resourcename )]
2015-12-04 14:05:49 +00:00
main_region | The main region travelled in this generation | [APIResource ](#apiresource ) ([Region](#regions))
moves | A list of moves that were introduced in this generation | [[APIResource ](#apiresource ) ([Move](#moves))]
pokemon_species | A list of pokemon species that were introduced in this generation | [[APIResource ](#apiresource ) ([PokemonSpecies](#pokemon-species))]
types | A list of types that were introduced in this generation | [[APIResource ](#apiresource ) ([Type](#types))]
version_groups | A list of version groups that were introduced in this generation | [[APIResource ](#apiresource ) ([VersionGroup](#version-groups))]
2015-11-29 23:39:38 +00:00
2015-12-04 05:07:19 +00:00
## Genders
2015-11-29 23:39:38 +00:00
```
api/v2/gender/{id or name}
```
2015-12-04 05:07:19 +00:00
Genders were introduced in Generation II for the purposes of breeding pokemon but can also rsult in visual differences or even different evolutionary lines. Check out [Bulbapedia ](http://bulbapedia.bulbagarden.net/wiki/Gender ) for greater detail.
2015-11-29 23:39:38 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "female",
"pokemon_species_details": [{
"rate": 1,
"pokemon_species": {
"name": "bulbasaur",
"url": "http://localhost:8000/api/v2/pokemon-species/1/"
}
}],
"required_for_evolution": [{
"name": "wormadam",
"url": "http://localhost:8000/api/v2/pokemon-species/413/"
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### Gender
2015-11-29 23:39:38 +00:00
Name | Description | Data Type
---- | ----------- | ---------
id | The identifier for this gender resource | integer
name | The name for this gender resource | string
2015-12-04 14:05:49 +00:00
pokemon_species_details | A list of pokemon species that can be this gender and how likely it is that they will be | [[PokemonSpeciesGender ](#pokemonspeciesgender )]
required_for_evolution | A list of pokemon species that required this gender in order for a pokemon to evolve into them | [[APIResource ](#apiresource ) ([PokemonSpecies](#pokemon-species))]
2015-11-29 23:39:38 +00:00
2015-12-04 05:07:19 +00:00
#### PokemonSpeciesGender
2015-11-29 23:39:38 +00:00
Name | Description | Data Type
---- | ----------- | ---------
rate | The chance of this Pokémon being female, in eighths; or -1 for genderless | integer
2015-12-04 14:05:49 +00:00
pokemon_species | A pokemon species that can be the referenced gender | [APIResource ](#apiresource ) ([PokemonSpecies](#pokemon-species))
2015-11-29 23:39:38 +00:00
2015-12-01 18:47:46 +00:00
## Growth Rates
2015-11-29 23:39:38 +00:00
```
api/v2/growth-rate/{id or name}
```
2015-12-04 05:07:19 +00:00
Growth rates are the speed with which pokemon gain levels through experience. Check out [Bulbapedia ](http://bulbapedia.bulbagarden.net/wiki/Experience ) for greater detail.
2015-11-29 23:39:38 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "slow",
"formula": "\\frac{5x^3}{4}",
"descriptions": [{
"description": "langsam",
"language": {
"name": "de",
"url": "http://localhost:8000/api/v2/language/6/"
}
}],
"levels": [{
"level": 100,
"experience": 1250000
}],
"pokemon_species": [{
"name": "growlithe",
"url": "http://localhost:8000/api/v2/pokemon-species/58/"
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### Growth Rate
2015-11-29 23:39:38 +00:00
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 ](#description )]
levels | A list of levels and the amount of experienced needed to atain them based on this growth rate | [[GrowthRateExperienceLevel ](#growthrateexperiencelevel )]
2015-12-04 14:05:49 +00:00
pokemon_species | A list of pokemon species that gain levels at this growth rate | [[APIResource ](#apiresource ) ([PokemonSpecies](#pokemon-species))]
2015-11-29 23:39:38 +00:00
#### GrowthRateExperienceLevel
Name | Description | Data Type
---- | ----------- | ---------
level | The level gained | integer
experience | The amount of experience required to reach the referenced level | integer
2015-12-01 18:47:46 +00:00
## Items
2015-11-29 23:39:38 +00:00
```
api/v2/item/{id or name}
```
2015-12-04 05:07:19 +00:00
An item is an object in the games which the player can pick up, keep in their bag, and use in some manner. They have various uses, including healing, powering up, helping catch Pokémon, or to access a new area.
2015-11-29 23:39:38 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "master-ball",
"cost": 0,
"fling_power": 10,
"fling_effect": {
"name":"flinch",
"url":"http://localhost:8000/api/v2/item-fling-effect/7/"
},
"attributes": [{
"name": "holdable",
"url": "http://localhost:8000/api/v2/item-attribute/5/"
}],
"category": {
"name": "standard-balls",
"url": "http://localhost:8000/api/v2/item-category/34/"
},
"effect_entries": [{
"effect": "Used in battle\n: [Catches]{mechanic:catch} a wild Pokémon without fail.\n\n If used in a trainer battle, nothing happens and the ball is lost.",
"short_effect": "Catches a wild Pokémon every time.",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}],
"flavor_text_entries": [{
"text": "野生ã®ã€€ãƒã‚±ãƒ¢ãƒ³ã‚’ 必ãš\næ •ã ¾ã ˆ ã‚ ‹ 㠓㠨㠌 㠧ã ã‚ ‹ \n最高  性能㠮 ボール。 ",
"version_group": {
"name": "x-y",
"url": "http://localhost:8000/api/v2/version-group/15/"
},
"language": {
"name": "ja-kanji",
"url": "http://localhost:8000/api/v2/language/11/"
}
}],
"game_indices": [{
"game_index": 1,
"generation": {
"name": "generation-vi",
"url": "http://localhost:8000/api/v2/generation/6/"
}
}],
"names": [{
"name": "Master Ball",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}],
"held_by_pokemon": [{
"pokemon": {
"name": "chansey",
"url": "http://localhost:8000/api/v2/pokemon/113/"
},
"version_details": [{
"rarity": 50,
"version": {
"name": "soulsilver",
"url": "http://localhost:8000/api/v2/version/16/"
}
}]
}],
"baby_trigger_for": {
"url":"http://localhost:8000/api/v2/evolution-chain/1/"
}
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### Item
2015-11-29 23:39:38 +00:00
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
2015-12-04 05:07:19 +00:00
fling_effect | The effect of the move Fling when used with this item | [ItemFlingEffect ](#item-fling-effects )
2015-12-04 14:05:49 +00:00
attributes | A list of attributes this item has | [[APIResource ](#apiresource ) ([ItemAttribute](#item-attributes))]
2015-12-04 05:07:19 +00:00
category | The category of items this item falls into | [ItemCategory ](#item-categories )
2015-11-29 23:39:38 +00:00
effect_entries | The effect of this ability listed in different languages | [[VerboseEffect ](#verboseeffect )]
2015-12-04 05:07:19 +00:00
flavor_text_entries | The flavor text of this ability listed in different languages | [[VersionGroupFlavorText ](#versiongroupflavortext )]
2015-11-29 23:39:38 +00:00
game_indices | A list of game indices relevent to this item by generation | [[GenerationGameIndex ](#generationgameindex )]
names | The name of this item listed in different languages | [[Name ](#resourcename )]
2015-12-04 14:05:49 +00:00
held_by_pokemon | A list of pokemon that might be found in the wild holding this item | [[APIResource ](#apiresource ) ([Pokemon](#pokemon))]
baby_trigger_for | An evolution chain this item requires to produce a bay during mating | [[APIResource ](#apiresource ) ([EvolutionChain](#evolution-chains))]
2015-11-29 23:39:38 +00:00
2015-12-01 18:47:46 +00:00
## Item Fling Effects
2015-11-29 23:39:38 +00:00
```
api/v2/item-fling-effect/{id or name}
```
2015-12-04 05:07:19 +00:00
The various effects of the move "Fling" when used with different items.
2015-11-29 23:39:38 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "badly-poison",
"effect_entries": [{
"effect": "Badly poisons the target.",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}],
"items": [{
"name": "toxic-orb",
"url": "http://localhost:8000/api/v2/item/249/"
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
2015-12-04 14:05:49 +00:00
#### ItemFlingEffect
2015-12-02 05:05:16 +00:00
2015-11-29 23:39:38 +00:00
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 ](#effect )]
2015-12-04 14:05:49 +00:00
items | A list of items that have this fling effect | [[APIResource ](#apiresource ) ([Item](#items))]
## Item Attributes
```
api/v2/item-attribute/{id or name}
```
Item attributes define particular aspects of items, e.g. "usable in battle" or "consumable".
###### example response
```json
{
"id": 1,
"name": "countable",
"descriptions": [{
"description": "Has a count in the bag",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}],
"items": [{
"name": "master-ball",
"url": "http://localhost:8000/api/v2/item/1/"
}],
"names": [{
"name": "Countable",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}]
}
```
###### response models
#### ItemAttribute
Name | Description | Data Type
---- | ----------- | ---------
id | The identifier for this item attribute resource | integer
name | The name for this item attribute resource | string
items | A list of items that have this attribute | [[Item ](#items )]
names | The name of this item attribute listed in different languages | [[Name ](#resourcename )]
descriptions | The description of this item attribute listed in different languages | [[Description ](#description )]
2015-11-29 23:39:38 +00:00
2015-12-01 18:47:46 +00:00
## Item Categories
2015-11-29 23:39:38 +00:00
```
api/v2/item-category/{id or name}
```
2015-12-04 05:07:19 +00:00
Item categories determine where items will be placed in the players bag.
2015-11-29 23:39:38 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "stat-boosts",
"items": [{
"name": "guard-spec",
"url": "http://localhost:8000/api/v2/item/55/"
}],
"names": [{
"name": "Stat boosts",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}],
"pocket": {
"name": "battle",
"url": "http://localhost:8000/api/v2/item-pocket/7/"
}
}
2015-12-02 05:05:16 +00:00
```
###### response models
2015-12-04 14:05:49 +00:00
#### ItemCategory
2015-12-02 05:05:16 +00:00
2015-11-29 23:39:38 +00:00
Name | Description | Data Type
---- | ----------- | ---------
id | The identifier for this item category resource | integer
name | The name for this item category resource | string
2015-12-04 05:07:19 +00:00
items | A list of items that are a part of this category | [[Item ](#items )]
2015-11-29 23:39:38 +00:00
names | The name of this item category listed in different languages | [[Name ](#resourcename )]
2015-12-04 14:05:49 +00:00
pocket | The pocket items in this category would be put in | [[APIResource ](#apiresource ) ([ItemPocket](#item-pockets))]
2015-11-29 23:39:38 +00:00
2015-12-01 18:47:46 +00:00
## Item Pockets
2015-11-29 23:39:38 +00:00
```
api/v2/item-pocket/{id or name}
```
2015-12-04 05:07:19 +00:00
Pockets within the players bag used for storing items by category.
2015-11-29 23:39:38 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "misc",
"categories": [{
"name": "collectibles",
"url": "http://localhost:8000/api/v2/item-category/9/"
}],
"names": [{
"name": "Items",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
2015-12-04 14:05:49 +00:00
#### ItemPocket
2015-12-02 05:05:16 +00:00
2015-11-29 23:39:38 +00:00
Name | Description | Data Type
---- | ----------- | ---------
id | The identifier for this item pocket resource | integer
name | The name for this item pocket resource | string
2015-12-04 05:07:19 +00:00
categories | A list of item categories that are relevent to this item pocket | [[ItemCategory ](#item-categories )]
names | The name of this item pocket listed in different languages | [[Name ](#resourcename )]
2015-11-29 23:39:38 +00:00
2015-12-01 18:47:46 +00:00
## Languages
2015-11-29 23:39:38 +00:00
```
api/v2/language/{id or name}
```
2015-12-04 05:07:19 +00:00
Languages for translations of api resource information.
2015-11-29 23:39:38 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "ja",
"official": true,
"iso639": "ja",
"iso3166": "jp",
"names": [{
"name": "Japanese",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### Language
2015-11-29 23:39:38 +00:00
Name | Description | Data Type
---- | ----------- | ---------
2015-12-04 05:07:19 +00:00
id | The identifier for this language resource | integer
name | The name for this language resource | string
2015-12-01 18:47:46 +00:00
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 ](#resourcename )]
## Locations
```
api/v2/location/{id or name}
```
2015-12-04 05:07:19 +00:00
Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes.
2015-12-01 18:47:46 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "canalave-city",
"region": {
"name": "sinnoh",
"url": "http://localhost:8000/api/v2/region/4/"
},
"names": [{
"name": "Canalave City",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}],
"game_indices": [{
"game_index": 7,
"generation": {
"name": "generation-iv",
"url": "http://localhost:8000/api/v2/generation/4/"
}
}],
"areas": [{
"name": "canalave-city-area",
"url": "http://localhost:8000/api/v2/location-area/1/"
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### Location
2015-12-01 18:47:46 +00:00
Name | Description | Data Type
---- | ----------- | ---------
2015-12-02 00:01:17 +00:00
id | The identifier for this location resource | integer
name | The name for this location resource | string
2015-12-04 14:05:49 +00:00
region | The region this location can be found in | [APIResource ](#apiresource ) ([Region](#regions))
2015-12-02 00:01:17 +00:00
names | The name of this language listed in different languages | [[Name ](#resourcename )]
game_indices | A list of game indices relevent to this location by generation | [[GenerationGameIndex ](#generationgameindex )]
2015-12-04 14:05:49 +00:00
areas | Areas that can be found within this location | [APIResource ](#apiresource ) ([LocationArea](#location-areas))
2015-12-01 18:47:46 +00:00
## Location Areas
```
api/v2/location-area/{id}
```
2015-12-04 05:07:19 +00:00
Location areas are sections of areas, such as floors in a building or cave. Each area has its own set of possible pokemon encounters.
2015-12-01 18:47:46 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "canalave-city-area",
"game_index": 1,
"encounter_method_rates": [{
"encounter_method": {
"name": "old-rod",
"url": "http://localhost:8000/api/v2/encounter-method/2/"
},
"version_details": [{
"rate": 25,
"version": {
"name": "platinum",
"url": "http://localhost:8000/api/v2/version/14/"
}
}]
}],
"location": {
"name": "canalave-city",
"url": "http://localhost:8000/api/v2/location/1/"
},
"names": [{
"name": "",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}],
"pokemon_encounters": [{
"pokemon": {
"name": "tentacool",
"url": "http://localhost:8000/api/v2/pokemon/72/"
},
"version_details": [{
"version": {
"name": "diamond",
"url": "http://localhost:8000/api/v2/version/12/"
},
"max_chance": 60,
"encounter_details": [{
"min_level": 20,
"max_level": 30,
"condition_values": [],
"chance": 60,
"method": {
"name": "surf",
"url": "http://localhost:8000/api/v2/encounter-method/5/"
}
}]
}]
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
2015-12-04 05:07:19 +00:00
#### LocationArea
2015-12-02 05:05:16 +00:00
2015-12-01 18:47:46 +00:00
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 ](#encountermethodrate )]
2015-12-04 14:05:49 +00:00
location | The region this location can be found in | [APIResource ](#apiresource ) ([Region](#regions))
2015-12-01 18:47:46 +00:00
names | The name of this location area listed in different languages | [[Name ](#resourcename )]
2015-12-04 14:05:49 +00:00
pokemon_encounters | A list of pokemon that can be encountered in this area along with version specific details about the encounter | [[PokemonEncounter ](#pokemonencounter )]
2015-12-01 18:47:46 +00:00
#### PokemonEncounter
Name | Description | Data Type
---- | ----------- | ---------
2015-12-04 14:05:49 +00:00
pokemon | The pokemon being encountered | [APIResource ](#apiresource ) ([Pokemon](#pokemon))
2015-12-04 05:07:19 +00:00
version_details | A list of versions and encounters with pokemon that might happen in the referenced location area | [[VersionEncounterDetail ](#versionencounterdetail )]
2015-12-01 18:47:46 +00:00
## Moves
```
api/v2/move/{id or name}
```
2015-12-04 05:07:19 +00:00
Moves are the skills of pokemon in battle. In battle, a Pokémon uses one move each turn. Some moves (including those learned by Hidden Machine) can be used outside of battle as well, usually for the purpose of removing obstacles or exploring new areas.
2015-12-01 18:47:46 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "pound",
"accuracy": 100,
"effect_chance": null,
"pp": 35,
"priority": 0,
"power": 40,
"contest_combos": {
"normal": {
"use_before": [{
"name": "double-slap",
"url": "http://localhost:8000/api/v2/move/3/"
}, {
"name": "headbutt",
"url": "http://localhost:8000/api/v2/move/29/"
}, {
"name": "feint-attack",
"url": "http://localhost:8000/api/v2/move/185/"
}],
"use_after": null
},
"super": {
"use_before": null,
"use_after": null
}
},
"contest_type": {
"name": "tough",
"url": "http://localhost:8000/api/v2/contest-type/5/"
},
"contest_effect": {
"url": "http://localhost:8000/api/v2/contest-effect/1/"
},
"damage_class": {
"name": "physical",
"url": "http://localhost:8000/api/v2/move-damage-class/2/"
},
"effect_entries": [{
"effect": "Inflicts [regular damage]{mechanic:regular-damage}.",
"short_effect": "Inflicts regular damage with no additional effect.",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}],
"effect_changes": [],
"generation": {
"name": "generation-i",
"url": "http://localhost:8000/api/v2/generation/1/"
},
"meta": {
"ailment": {
"name": "none",
"url": "http://localhost:8000/api/v2/move-ailment/0/"
},
"category": {
"name": "damage",
"url": "http://localhost:8000/api/v2/move-category/0/"
},
"min_hits": null,
"max_hits": null,
"min_turns": null,
"max_turns": null,
"drain": 0,
"healing": 0,
"crit_rate": 0,
"ailment_chance": 0,
"flinch_chance": 0,
"stat_chance": 0
},
"names": [{
"name": "Pound",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}],
"past_values": [],
"stat_changes": [],
"super_contest_effect": {
"url": "http://localhost:8000/api/v2/super-contest-effect/5/"
},
"target": {
"name": "selected-pokemon",
"url": "http://localhost:8000/api/v2/move-target/10/"
},
"type": {
"name": "normal",
"url": "http://localhost:8000/api/v2/type/1/"
}
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### Move
2015-12-01 18:47:46 +00:00
Name | Description | Data Type
---- | ----------- | ---------
2015-12-04 05:07:19 +00:00
id | The identifier for this move resource | integer
name | The name for this move resource | string
2015-12-01 18:47:46 +00:00
accuracy | The percent value of how likely this move is to be successful | integer
2015-12-04 05:07:19 +00:00
effect_chance | The percent value of how likely it is this moves effect will happen | integer
2015-12-01 18:47:46 +00:00
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 ](http://bulbapedia.bulbagarden.net/wiki/Priority ) 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 ](#contestcombosets )]
2015-12-04 14:05:49 +00:00
contest_type | The type of appeal this move gives a pokemon when used in a contest | [APIResource ](#apiresource ) ([ContestType](#contest-types))
contest_effect | The effect the move has when used in a contest | [APIResource ](#apiresource ) ([ContestEffect](#contest-effects))
damage_class | The type of damage the move inflicts on the target, e.g. physical | [APIResource ](#apiresource ) ([MoveDamageClass](#move-damage-classes))
2015-12-01 18:47:46 +00:00
effect_entries | The effect of this move listed in different languages | [[VerboseEffect ](#verboseeffect )]
effect_changes | The list of previous effects this move has had across version groups of the games | [[AbilityEffectChange ](#abilityeffectchange )]
2015-12-04 14:05:49 +00:00
generation | The generation in which this move was introduced | [APIResource ](#apiresource ) ([Generation](#generations))
2015-12-01 18:47:46 +00:00
meta | Meta data about this move | [MoveMetaData ](#movemetadata )
2015-12-04 05:07:19 +00:00
names | The name of this move listed in different languages | [[Name ](#resourcename )]
2015-12-04 14:05:49 +00:00
past_values | A list of move resource value changes across ersion groups of the game | [[PastMoveStatValues ](#pastmovestatvalues )]
2015-12-01 18:47:46 +00:00
stat_changes | A list of stats this moves effects and how much it effects them | [[MoveStatChange ](#movestatchange )]
2015-12-04 14:05:49 +00:00
contest_effect | The effect the move has when used in a super contest | [APIResource ](#apiresource ) ([ContestEffect](#contest-effects))
target | The type of target that will recieve the effects of the attack | [MoveTarget ](#move-targets )
2015-12-01 18:47:46 +00:00
type | The elemental type of this move | [Type ](#types )
#### 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 ](#contestcombodetail )]
super | A detail of moves this move can be used before or after, granting additional appeal points in super contests | [[ContestComboDetail ](#contestcombodetail )]
#### ContestComboDetail
Name | Description | Data Type
---- | ----------- | ---------
2015-12-04 14:05:49 +00:00
use_before | A list of moves to use before this move | [[APIResource ](#apiresource ) ([Move](#moves))]
use_after | A list of moves to use after this move | [[APIResource ](#apiresource ) ([Move](#moves))]
2015-12-01 18:47:46 +00:00
#### MoveMetaData
Name | Description | Data Type
---- | ----------- | ---------
2015-12-04 14:05:49 +00:00
ailment | The status ailment this move inflicts on its target | [APIResource ](#apiresource ) ([MoveAilment](#move-ailments))
category | The category of move this move falls under, e.g. damage or ailment | [APIResource ](#apiresource ) ([Move](#moves))
2015-12-01 18:47:46 +00:00
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
2015-12-04 14:05:49 +00:00
stat | The stat being affected | [APIResource ](#apiresource ) [Stat ](#stats )
2015-12-01 18:47:46 +00:00
#### 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 ](#verboseeffect )]
type | The elemental type of this move | [Type ](#types )
2015-12-04 14:05:49 +00:00
version group | The version group in which these move stat values were in effect | [APIResource ](#apiresource ) ([VersionGroup](#version-groups))
2015-12-01 18:47:46 +00:00
## Move Ailments
```
api/v2/move-ailment/{id or name}
```
2015-12-04 05:07:19 +00:00
Move Ailments are status conditions caused by moves used during battle. See [Bulbapedia ](http://bulbapedia.bulbagarden.net/wiki/http://bulbapedia.bulbagarden.net/wiki/Status_condition ) for greater detail.
2015-12-01 18:47:46 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "paralysis",
"moves": [{
"name": "thunder-punch",
"url": "http://localhost:8000/api/v2/move/9/"
}],
"names": [{
"name": "Paralysis",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### Move Ailment
2015-12-01 18:47:46 +00:00
Name | Description | Data Type
---- | ----------- | ---------
id | The identifier for this move ailment resource | integer
name | The name for this move ailment resource | string
2015-12-04 14:05:49 +00:00
moves | A list of moves that cause this ailment | [[APIResource ](#apiresource ) ([Move](#moves))]
2015-12-01 18:47:46 +00:00
names | The name of this move ailment listed in different languages | [[Name ](#resourcename )]
2015-12-02 05:05:16 +00:00
## Move Battle Styles
2015-12-01 18:47:46 +00:00
```
api/v2/move-battle-style/{id or name}
```
2015-12-04 05:07:19 +00:00
Styles of moves when used in the Battle Palace. See [Bulbapedia ](http://bulbapedia.bulbagarden.net/wiki/Battle_Frontier_(Generation_III )) for greater detail.
2015-12-01 18:47:46 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "attack",
"names": [{
"name": "Attack",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### Move Battle Style
2015-12-01 18:47:46 +00:00
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 ](#resourcename )]
2015-12-02 05:05:16 +00:00
## Move Categories
2015-12-01 18:47:46 +00:00
```
api/v2/move-category/{id or name}
```
2015-12-04 05:07:19 +00:00
Very general categories that loosely group move effects.
2015-12-01 18:47:46 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "ailment",
"descriptions": [{
"description": "No damage; inflicts status ailment",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}],
"moves": [{
"name": "sing",
"url": "http://localhost:8000/api/v2/move/47/"
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### Move Category
2015-12-01 18:47:46 +00:00
Name | Description | Data Type
---- | ----------- | ---------
id | The identifier for this move category resource | integer
name | The name for this move category resource | string
2015-12-04 14:05:49 +00:00
moves | A list of moves that fall into this category | [[APIResource ](#apiresource ) ([Move](#moves))]
2015-12-01 18:47:46 +00:00
descriptions | The description of this move ailment listed in different languages | [[Description ](#description )]
2015-12-02 05:05:16 +00:00
## Move Damage Classes
2015-12-01 18:47:46 +00:00
```
api/v2/move-damage-class/{id or name}
```
2015-12-04 05:07:19 +00:00
Damage classes moves can have, e.g. physical, special, or non-damaging.
2015-12-01 18:47:46 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "status",
"descriptions": [{
"description": "ダメージãªã„",
"language": {
"name": "ja",
"url": "http://localhost:8000/api/v2/language/1/"
}
}],
"moves": [{
"name": "swords-dance",
"url": "http://localhost:8000/api/v2/move/14/"
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### Move Damage Class
2015-12-01 18:47:46 +00:00
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 ](#description )]
2015-12-04 14:05:49 +00:00
moves | A list of moves that fall into this damage class | [[APIResource ](#apiresource ) ([Move](#moves))]
2015-12-01 18:47:46 +00:00
names | The name of this move damage class listed in different languages | [[Name ](#resourcename )]
2015-12-02 05:05:16 +00:00
## Move Learn Methods
2015-12-01 18:47:46 +00:00
```
api/v2/move-learn-method/{id or name}
```
2015-12-04 05:07:19 +00:00
Methods by which pokemon can learn moves.
2015-12-01 18:47:46 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "level-up",
"names": [{
"name": "Level up",
"language": {
"name": "de",
"url": "http://localhost:8000/api/v2/language/6/"
}
}],
"descriptions": [{
"description": "Wird gelernt, wenn ein Pokémon ein bestimmtes Level erreicht.",
"language": {
"name": "de",
"url": "http://localhost:8000/api/v2/language/6/"
}
}],
"version_groups": [{
"name": "red-blue",
"url": "http://localhost:8000/api/v2/version-group/1/"
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### Move Learn Method
2015-12-01 18:47:46 +00:00
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 ](#description )]
names | The name of this move learn method listed in different languages | [[Name ](#resourcename )]
2015-12-04 14:05:49 +00:00
version_groups | A list of version groups where moves can be learned through this method | [[APIResource ](#apiresource ) ([VersionGroup](#version-groups))]
2015-12-01 18:47:46 +00:00
2015-12-02 05:05:16 +00:00
## Move Targets
2015-12-01 18:47:46 +00:00
```
api/v2/move-target/{id or name}
```
2015-12-04 05:07:19 +00:00
Targets moves can be directed at during battle. Targets can be pokemon, environments or even other moves.
2015-12-01 18:47:46 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "specific-move",
"descriptions": [{
"description": "Eine spezifische Fähigkeit. Wie diese Fähigkeit genutzt wird hängt von den genutzten Fähigkeiten ab.",
"language": {
"name": "de",
"url": "http://localhost:8000/api/v2/language/6/"
}
}],
"moves": [{
"name": "counter",
"url": "http://localhost:8000/api/v2/move/68/"
}],
"names": [{
"name": "Spezifische Fähigkeit",
"language": {
"name": "de",
"url": "http://localhost:8000/api/v2/language/6/"
}
}]
}
```
2015-12-02 05:05:16 +00:00
###### response models
#### Move Target
2015-12-01 18:47:46 +00:00
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 ](#description )]
2015-12-04 14:05:49 +00:00
moves | A list of moves that that are directed at this target | [[APIResource ](#apiresource ) ([Move](#moves))]
2015-12-01 18:47:46 +00:00
names | The name of this move target listed in different languages | [[Name ](#resourcename )]
2015-12-02 05:05:16 +00:00
## Natures
2015-12-01 18:47:46 +00:00
```
api/v2/nature/{id or name}
```
2015-12-04 05:07:19 +00:00
Natures influence how a pokemon's stats grow. See [Bulbapedia ](http://bulbapedia.bulbagarden.net/wiki/Nature ) for greater detail.
2015-12-01 18:47:46 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 2,
"name": "bold",
"decreased_stat": {
"name": "attack",
"url": "http://localhost:8000/api/v2/stat/2/"
},
"increased_stat": {
"name": "defense",
"url": "http://localhost:8000/api/v2/stat/3/"
},
"likes_flavor": {
"name": "sour",
"url": "http://localhost:8000/api/v2/berry-flavor/5/"
},
"hates_flavor": {
"name": "spicy",
"url": "http://localhost:8000/api/v2/berry-flavor/1/"
},
"pokeathlon_stat_changes": [{
"max_change": -2,
"pokeathlon_stat": {
"name": "speed",
"url": "http://localhost:8000/api/v2/pokeathlon-stat/1/"
}
}],
"move_battle_style_preferences": [{
"low_hp_preference": 32,
"high_hp_preference": 30,
"move_battle_style": {
"name": "attack",
"url": "http://localhost:8000/api/v2/move-battle-style/1/"
}
}],
"names": [{
"name": "ãšã¶ã¨ã„",
"language": {
"name": "ja",
"url": "http://localhost:8000/api/v2/language/1/"
}
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### Nature
2015-12-01 18:47:46 +00:00
Name | Description | Data Type
---- | ----------- | ---------
id | The identifier for this nature resource | integer
name | The name for this nature resource | string
2015-12-04 14:05:49 +00:00
decreased_stat | The stat decreased by 10% in pokemon with this nature | [APIResource ](#apiresource ) ([Stat](#stats))
increased_stat | The stat increased by 10% in pokemon with this nature | [APIResource ](#apiresource ) ([Stat](#stats))
hates_flavor | The flavor hated by pokemon with this nature | [APIResource ](#apiresource ) ([BerryFlavor](#berry-flavors))
likes_flavor | The flavor liked by pokemon with this nature | [APIResource ](#apiresource ) ([BerryFlavor](#berry-flavors))
2015-12-01 18:47:46 +00:00
pokeathlon_stat_changes | A list of pokeathlon stats this nature effects and how much it effects them | [[NatureStatChange ](#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 ](#movebattlestylepreference )]
names | The name of this nature listed in different languages | [[Name ](#resourcename )]
#### NatureStatChange
Name | Description | Data Type
---- | ----------- | ---------
change | The amount of change | integer
2015-12-04 14:05:49 +00:00
stat | The stat being affected | [APIResource ](#apiresource ) ([PokeathlonStat](#pokeathlon-stats))
2015-12-01 18:47:46 +00:00
#### 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
2015-12-04 14:05:49 +00:00
move_battle_style | The move battle style | [APIResource ](#apiresource ) ([MoveBattleStyle](#move-battle-styles))
2015-12-01 18:47:46 +00:00
2015-12-02 05:05:16 +00:00
## Pal Park Areas
2015-12-01 18:47:46 +00:00
```
api/v2/pal-park-area/{id or name}
```
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "forest",
"names": [{
"name": "Forest",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}],
"pokemon_encounters": [{
"base_score": 30,
"rate": 50,
"pokemon_species": {
"name": "caterpie",
"url": "http://localhost:8000/api/v2/pokemon-species/10/"
}
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### PalParkArea
2015-12-01 18:47:46 +00:00
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 ](#resourcename )]
2015-12-04 14:05:49 +00:00
pokemon_encounters | A list of pokemon encountered in thi pal park area along with details | [[PalParkEncounterSpecies ](#palparkencounterspecies )]
2015-12-01 18:47:46 +00:00
2015-12-02 00:01:17 +00:00
#### PalParkEncounterSpecies
2015-12-01 18:47:46 +00:00
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 ](#apiresource ) ([PokemonSpecies](#pokemonspecies))
2015-12-02 05:05:16 +00:00
## Pokedexes
2015-12-01 18:47:46 +00:00
```
api/v2/pokedex/{id or name}
```
2015-12-04 05:07:19 +00:00
A Pokédex is a handheld electronic encyclopedia device; one which is capable of recording and retaining information of the various Pokémon in a given region with the exception of the national dex and some smaller dexes related to portions of a region. See [Bulbapedia ](http://bulbapedia.bulbagarden.net/wiki/Pokedex ) for greater detail.
2015-12-01 18:47:46 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 2,
"name": "kanto",
"is_main_series": true,
"descriptions": [{
"description": "Rot/Blau/Gelb Kanto Dex",
"language": {
"name": "de",
"url": "http://localhost:8000/api/v2/language/6/"
}
}],
"names": [{
"name": "Kanto",
"language": {
"name": "de",
"url": "http://localhost:8000/api/v2/language/6/"
}
}],
"pokemon_entries": [{
"entry_number": 1,
"pokemon_species": {
"name": "bulbasaur",
"url": "http://localhost:8000/api/v2/pokemon-species/1/"
}
}],
"region": {
"name": "kanto",
"url": "http://localhost:8000/api/v2/region/1/"
},
"version_groups": [{
"name": "red-blue",
"url": "http://localhost:8000/api/v2/version-group/1/"
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### Pokedex
2015-12-01 18:47:46 +00:00
Name | Description | Data Type
---- | ----------- | ---------
2015-12-02 00:01:17 +00:00
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 ](#description )]
names | The name of this pokedex listed in different languages | [[Name ](#resourcename )]
pokemon_entries | A list of pokemon catalogued in this pokedex and their indexes | [[PokemonEntry ](#pokemonentry )]
2015-12-04 14:05:49 +00:00
region | The region this pokedex catalogues pokemon for | [APIResource ](#apiresource ) ([Region](#regions))
version_groups | A list of version groups this pokedex is relevent to | [APIResource ](#apiresource ) ([VersionGroup](#version-groups))
2015-12-02 00:01:17 +00:00
2015-12-04 14:05:49 +00:00
#### PokemonEntry
2015-12-02 00:01:17 +00:00
Name | Description | Data Type
---- | ----------- | ---------
entry_number | The index of this pokemon species entry within the pokedex | integer
2015-12-04 05:07:19 +00:00
pokemon_species | The pokemon species being encountered | [APIResource ](#apiresource ) ([PokemonSpecies](#pokemon-species))
2015-12-02 00:01:17 +00:00
## Pokemon
```
api/v2/pokemon/{id or name}
```
2015-12-04 05:07:19 +00:00
Pokemon are the creatures that inhabit the world of the pokemon games. They can be caught using pokeball's and trained by battling with other pokemon. See [Bulbapedia ](http://bulbapedia.bulbagarden.net/wiki/Pokémon_(species )) for greater detail.
2015-12-02 00:01:17 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 12,
"name": "butterfree",
"base_experience": 178,
"height": 11,
"is_default": true,
"order": 16,
"weight": 320,
"abilities": [{
"is_hidden": true,
"slot": 3,
"ability": {
"name": "tinted-lens",
"url": "http://localhost:8000/api/v2/ability/110/"
}
}],
"forms": [{
"name": "butterfree",
"url": "http://localhost:8000/api/v2/pokemon-form/12/"
}],
"game_indices": [{
"game_index": 12,
"version": {
"name": "white-2",
"url": "http://localhost:8000/api/v2/version/22/"
}
}],
"held_items": [{
"item": {
"name": "silver-powder",
"url": "http://localhost:8000/api/v2/item/199/"
},
"version_details": [{
"rarity": 5,
"version": {
"name": "y",
"url": "http://localhost:8000/api/v2/version/24/"
}
}]
}],
"location_area_encounters": [{
"location_area": {
"name": "kanto-route-2-south-towards-viridian-city",
"url": "http://localhost:8000/api/v2/location-area/296/"
},
"version_details": [{
"max_chance": 10,
"encounter_details": [{
"min_level": 7,
"max_level": 7,
"condition_values": [{
"name": "time-morning",
"url": "http://localhost:8000/api/v2/encounter-condition-value/3/"
}],
"chance": 5,
"method": {
"name": "walk",
"url": "http://localhost:8000/api/v2/encounter-method/1/"
}
}],
"version": {
"name": "heartgold",
"url": "http://localhost:8000/api/v2/version/15/"
}
}]
}],
"moves": [{
"move": {
"name": "flash",
"url": "http://localhost:8000/api/v2/move/148/"
},
"version_group_details": [{
"level_learned_at": 0,
"version_group": {
"name": "x-y",
"url": "http://localhost:8000/api/v2/version-group/15/"
},
"move_learn_method": {
"name": "machine",
"url": "http://localhost:8000/api/v2/move-learn-method/4/"
}
}]
}],
"species": {
"name": "butterfree",
"url": "http://localhost:8000/api/v2/pokemon-species/12/"
},
"stats": [{
"base_stat": 70,
"effort": 0,
"stat": {
"name": "speed",
"url": "http://localhost:8000/api/v2/stat/6/"
}
}],
"types": [{
"slot": 2,
"type": {
"name": "flying",
"url": "http://localhost:8000/api/v2/type/3/"
}
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### Pokemon
2015-12-02 00:01:17 +00:00
Name | Description | Data Type
---- | ----------- | ---------
2015-12-04 05:07:19 +00:00
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 | Order for sorting. Almost national order, except families are grouped together. | integer
weight | The weight of this pokemon | integer
abilities | A list of abilities this pokemon could potentially have | [[PokemonAbility ](#pokemonability )]
forms | A list of forms this pokemon can take on | [[APIResource ](#apiresource ) ([PokemonForm](#pokemon-forms))]
game_indices | A list of game indices relevent to pokemon item by generation | [[VersionGameIndex ](#versiongameindex )]
held_items | A list of items this pokemon may be holding when encountered | [[APIResource ](#apiresource ) ([Item](#items))]
2015-12-04 14:05:49 +00:00
location_area_encounters | A list of location areas as well as encounter details pertaining to specific versions | [[LocationAreaEncounter ](#locationareaencounter )]
moves | A list of moves along with learn methods and level details pertaining to specific version groups | [APIResource ](#apiresource ) (Move](#moves))
species | The species this pokemon belongs to | [APIResource ](#apiresource ) (PokemonSpecies](#pokemon-species))
2015-12-04 05:07:19 +00:00
stats | A list of base stat values for this pokemon | [[APIResource ](#apiresource ) ([Stat](#stats))]
types | A list of details showing types this pokemon has | [[PokemonType ](#pokemontype )]
2015-12-02 00:01:17 +00:00
#### 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 ](#apiresource ) ([Ability](#abilities))
#### PokemonType
Name | Description | Data Type
---- | ----------- | ---------
slot | The order the pokemons types are listed in | integer
type | The type the referenced pokemon has | string
2015-12-04 05:07:19 +00:00
#### LocationAreaEncounter
Name | Description | Data Type
---- | ----------- | ---------
2015-12-04 14:05:49 +00:00
location_area | The location area the referenced pokemon can be encountered in | [APIResource ](#apiresource ) ([Pokemon](#pokemon))
2015-12-04 05:07:19 +00:00
version_details | A list of versions and encounters with the referenced pokemon that might happen | [[VersionEncounterDetail ](#versionencounterdetail )]
2015-12-02 00:01:17 +00:00
## Pokemon Colors
```
api/v2/pokemon-color/{id or name}
```
2015-12-04 05:07:19 +00:00
Colors used for sorting pokemon in a pokedex. The color listed in the Pokédex is usually the color most apparent or covering each Pokémon's body. No orange category exists; Pokémon that are primarily orange are listed as red or brown.
2015-12-02 00:01:17 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "black",
"names": [{
"name": "é»’ã„",
"language": {
"name": "ja",
"url": "http://localhost:8000/api/v2/language/1/"
}
}],
"pokemon_species": [{
"name": "snorlax",
"url": "http://localhost:8000/api/v2/pokemon-species/143/"
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### PokemonColor
2015-12-02 00:01:17 +00:00
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 ](#resourcename )]
2015-12-04 05:07:19 +00:00
pokemon_species | A list of the pokemon species that have this color | [[APIResource ](#apiresource ) ([PokemonSpecies](#pokemon-species))]
2015-12-02 00:01:17 +00:00
## Pokemon Forms
```
api/v2/pokemon-form/{id or name}
```
2015-12-04 05:07:19 +00:00
Some pokemon have the ability to take on different forms. At times, these differences are purely cosmetic and have no bearing on the difference in the Pokémon's stats from another; however, several Pokémon differ in stats (other than HP), type, and Ability depending on their form.
2015-12-02 00:01:17 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 413,
"name": "wormadam-plant",
"order": 503,
"form_order": 1,
"is_default": true,
"is_battle_only": false,
"is_mega": false,
"form_name": "plant",
"pokemon": {
"name": "wormadam-plant",
"url": "http://localhost:8000/api/v2/pokemon/413/"
},
"version_group": {
"name": "diamond-pearl",
"url": "http://localhost:8000/api/v2/version-group/8/"
}
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### PokemonForm
2015-12-02 00:01:17 +00:00
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 ](#apiresource ) ([Pokemon](#pokemon))
2015-12-04 05:07:19 +00:00
version_group | The version group this pokemon form was introduced in | [APIResource ](#apiresource ) ([VersionGroup](#version-groups))
2015-12-02 00:01:17 +00:00
## Pokemon Habitats
```
api/v2/pokemon-habitat/{id or name}
```
2015-12-04 05:07:19 +00:00
Habitats are generally different terrain pokemon can be found in but can also be areas designated for rare or legendary pokemon.
2015-12-02 00:01:17 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
```
###### response models
#### PokemonHabitat
2015-12-02 00:01:17 +00:00
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 ](#resourcename )]
2015-12-04 05:07:19 +00:00
pokemon_species | A list of the pokemon species that can be found in this habitat | [[APIResource ](#apiresource ) ([PokemonSpecies](#pokemon-species))]
2015-12-02 00:01:17 +00:00
## Pokemon Shapes
```
api/v2/pokemon-shape/{id or name}
```
2015-12-04 05:07:19 +00:00
Shapes used for sorting pokemon in a pokedex.
2015-12-02 00:01:17 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
```
###### response models
#### PokemonShape
2015-12-02 00:01:17 +00:00
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 ](#awesomename )]
names | The name of this pokemon shape listed in different languages | [[Name ](#resourcename )]
2015-12-04 05:07:19 +00:00
pokemon_species | A list of the pokemon species that have this shape | [[APIResource ](#apiresource ) ([PokemonSpecies](#pokemon-species))]
2015-12-02 00:01:17 +00:00
#### 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 ](#apiresource ) ([Language](#languages))
## Pokemon Species
```
api/v2/pokemon-species/{id or name}
```
2015-12-04 05:07:19 +00:00
A Pokemon Species forms the basis for at least one pokemon. Attributes of a Pokemon species are shared across all varieties of pokemon within the species. A good example is Wormadam; Wormadam is the species which can be found in three different varieties, Wormadam-Trash, Wormadam-Sandy and Wormadam-Plant.
2015-12-02 00:01:17 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 413,
"name": "wormadam",
"order": 441,
"gender_rate": 8,
"capture_rate": 45,
"base_happiness": 70,
"is_baby": false,
"hatch_counter": 15,
"has_gender_differences": false,
"forms_switchable": false,
"growth_rate": {
"name": "medium",
"url": "http://localhost:8000/api/v2/growth-rate/2/"
},
"pokedex_numbers": [{
"entry_number": 45,
"pokedex": {
"name": "kalos-central",
"url": "http://localhost:8000/api/v2/pokedex/12/"
}
}],
"egg_groups": [{
"name": "bug",
"url": "http://localhost:8000/api/v2/egg-group/3/"
}],
"color": {
"name": "gray",
"url": "http://localhost:8000/api/v2/pokemon-color/4/"
},
"shape": {
"name": "squiggle",
"url": "http://localhost:8000/api/v2/pokemon-shape/2/"
},
"evolves_from_species": {
"name": "burmy",
"url": "http://localhost:8000/api/v2/pokemon-species/412/"
},
"evolution_chain": {
"url": "http://localhost:8000/api/v2/evolution-chain/213/"
},
"habitat": null,
"generation": {
"name": "generation-iv",
"url": "http://localhost:8000/api/v2/generation/4/"
},
"names": [{
"name": "Wormadam",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}],
"form_descriptions": [{
"description": "Forms have different stats and movepools. During evolution, Burmy's current cloak becomes Wormadam's form, and can no longer be changed.",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}],
"genera": [{
"genus": "Bagworm",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}],
"varieties": [{
"is_default": true,
"pokemon": {
"name": "wormadam-plant",
"url": "http://localhost:8000/api/v2/pokemon/413/"
}
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### PokemonSpecies
2015-12-02 00:01:17 +00:00
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
2015-12-04 05:07:19 +00:00
growth_rate | The rate at which this pokemon species gains levels | [APIResource ](#apiresource ) ([GrowthRate](#growth-rates))
2015-12-04 14:05:49 +00:00
pokedex_numbers | A list of pokedexes and the indexes reserved within them for this pokemon species | [[PokemonSpeciesDexEntry ](#pokemonspeciesdexentry )]
2015-12-04 05:07:19 +00:00
egg_groups | A list of egg groups this pokemon species is a member of | [[APIResource ](#apiresource ) ([EggGroup](#egg-groups))]
color | The color of this pokemon for gimmicky pokedex search | [[APIResource ](#apiresource ) ([PokemonColor](#pokemon-colors))]
shape | The shape of this pokemon for gimmicky pokedex search | [[APIResource ](#apiresource ) ([PokemonShape](#pokemon-shapes))]
evolves_from_species | The pokemon species that evolves into this pokemon_species | [APIResource ](#apiresource ) ([PokemonSpecies](#pokemon-species))
evolution_chain | The evolution chain this pokemon species is a member of | [APIResource ](#apiresource ) ([EvolutionChain](#evolution-chains))
habitat | The habitat this pokemon species can be encountered in | [APIResource ](#apiresource ) ([PokemonHabitat](#pokemon-habitats))
2015-12-02 00:01:17 +00:00
generation | The generation this pokemon species was introduced in | [APIResource ](#apiresource ) ([Generation](#generations))
names | The name of this pokemon species listed in different languages | [[Name ](#resourcename )]
pal_park_encounters | A list of encounters that can be had with this pokemon species in pal park | [[PalParkEncounterArea ](#palparkencounterarea )]
2015-12-04 14:05:49 +00:00
form_descriptions | Descriptions of different forms pokemon take on within the pokemon species | [[Description ](#description )]
2015-12-02 00:01:17 +00:00
genera | The genus of this pokemon species listed in multiple languages | [Genus ](#genus )
varieties | A list of the pokemon that exist within this pokemon species | [[APIResource ](#apiresource ) ([Pokemon](#pokemon))]
#### Genus
Name | Description | Data Type
---- | ----------- | ---------
genus | The localized genus for the referenced pokemon species | string
language | The language this genus is in | [APIResource ](#apiresource ) ([Language](#languages))
2015-12-02 05:05:16 +00:00
#### PokemonSpeciesDexEntry
2015-12-02 00:01:17 +00:00
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 ](#apiresource ) ([Pokedex](#pokedexes))
2015-12-02 05:05:16 +00:00
#### PalParkEncounterArea
2015-12-02 00:01:17 +00:00
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
2015-12-04 14:05:49 +00:00
area | The pal park area where this encounter happens | [APIResource ](#apiresource ) ([PalParkArea](#pal-park-areas))
2015-12-02 00:01:17 +00:00
2015-12-02 05:05:16 +00:00
## Pokeathlon Stats
2015-12-02 00:01:17 +00:00
```
api/v2/pokeathlon-stat/{id or name}
```
2015-12-04 05:07:19 +00:00
Pokeathlon Stats are different attributes of a pokemons performance in pokeathlons. In Pokeathlons, competitions happen on different courses; one for each of the different pokeathlon stats. See [Bulbapedia ](http://bulbapedia.bulbagarden.net/wiki/Pokéathlon ) for greater detail.
2015-12-02 00:01:17 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "speed",
"affecting_natures": {
"increase": [{
"max_change": 2,
"nature": {
"name": "timid",
"url": "http://localhost:8000/api/v2/nature/5/"
}
}],
"decrease": [{
"max_change": -1,
"nature": {
"name": "hardy",
"url": "http://localhost:8000/api/v2/nature/1/"
}
}]
},
"names": [{
"name": "Speed",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### PokeathlonStat
2015-12-02 00:01:17 +00:00
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 ](#resourcename )]
affecting_natures | A detail of natures which affect this pokeathlon stat positively or negatively | [NaturePokeathlonStatAffectSets ](#naturepokeathlonstataffectsets )
#### NaturePokeathlonStatAffectSets
Name | Description | Data Type
---- | ----------- | ---------
2015-12-04 14:05:49 +00:00
increase | A list of natures and how they change the referenced pokeathlon stat | [[NaturePokeathlonStatAffect ](#naturepokeathlonstataffect )]
decrease | A list of natures and how they change the referenced pokeathlon stat | [[NaturePokeathlonStatAffect ](#naturepokeathlonstataffect )]
2015-12-02 00:01:17 +00:00
2015-12-02 05:05:16 +00:00
#### NaturePokeathlonStatAffect
2015-12-02 00:01:17 +00:00
Name | Description | Data Type
---- | ----------- | ---------
max_change | The maximum amount of change to the referenced pokeathlon stat | integer
nature | The nature causing the change | [APIResource ](#apiresource ) ([Nature](#natures))
2015-12-02 05:05:16 +00:00
## Regions
2015-12-02 00:01:17 +00:00
```
api/v2/region/{id or name}
```
2015-12-04 05:07:19 +00:00
A region is an organized area of the pokemon world. Most often, the main difference between regions is the species of pokemon that can be encountered within them.
2015-12-02 00:01:17 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "kanto",
"locations": [{
"name": "celadon-city",
"url": "http://localhost:8000/api/v2/location/67/"
}],
"main_generation": {
"name": "generation-i",
"url": "http://localhost:8000/api/v2/generation/1/"
},
"names": [{
"name": "Kanto",
"language": {
"name": "de",
"url": "http://localhost:8000/api/v2/language/6/"
}
}],
"pokedexes": [{
"name": "kanto",
"url": "http://localhost:8000/api/v2/pokedex/2/"
}],
"version_groups": [{
"name": "red-blue",
"url": "http://localhost:8000/api/v2/version-group/1/"
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### Region
2015-12-02 00:01:17 +00:00
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 ](#apiresource ) ([Location](#locations))
main_generation | The generation this region was introduced in | [APIResource ](#apiresource ) ([Generation](#generations))
names | The name of this region listed in different languages | [[Name ](#resourcename )]
pokedexes | A list of pokedexes that catalogue pokemon in this region | [APIResource ](#apiresource ) ([Pokedex](#pokedexes))
2015-12-04 05:07:19 +00:00
version_groups | A list of version groups where this region can be visited | [APIResource ](#apiresource ) ([VersionGroup](#version-groups))
2015-12-02 00:01:17 +00:00
## Stats
```
api/v2/stat/{id or name}
```
2015-12-04 05:07:19 +00:00
Stats determine certain aspects of battles. Each pokemon has a value for each stat which grows as they gain levels and can be altered momenarily by effects in battles.
2015-12-02 00:01:17 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 2,
"name": "attack",
"game_index": 2,
"is_battle_only": false,
"affecting_moves": {
"increase": [{
"change": 2,
"move": {
"name": "swords-dance",
"url": "http://localhost:8000/api/v2/move/14/"
}
}],
"decrease": [{
"change": -1,
"move": {
"name": "growl",
"url": "http://localhost:8000/api/v2/move/45/"
}
}]
},
"affecting_natures": {
"increase": [{
"name": "lonely",
"url": "http://localhost:8000/api/v2/nature/6/"
}],
"decrease": [{
"name": "bold",
"url": "http://localhost:8000/api/v2/nature/2/"
}]
},
"characteristics": [{
"url": "http://localhost:8000/api/v2/characteristic/2/"
}],
"move_damage_class": {
"name": "physical",
"url": "http://localhost:8000/api/v2/move-damage-class/2/"
},
"names": [{
"name": "ã“ã†ã’ã",
"language": {
"name": "ja",
"url": "http://localhost:8000/api/v2/language/1/"
}
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### Stat
2015-12-02 00:01:17 +00:00
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 ](#movestataffectsets )
affecting_natures | A detail of natures which affect this stat positively or negatively | [NatureStatAffectSets ](#naturestataffectsets )
characteristics | A list of characteristics that are set on a pokemon when its highest base stat is this stat | [[APIResource ](#apiresource ) ([Characteristic](#characteristics))]
2015-12-04 05:07:19 +00:00
move_damage_class | The class of damage this stat is directly related to | [APIResource ](#apiresource ) ([MoveDamageClass](#move-damage-classes))
2015-12-02 00:01:17 +00:00
names | The name of this region listed in different languages | [[Name ](#resourcename )]
#### MoveStatAffectSets
Name | Description | Data Type
---- | ----------- | ---------
2015-12-04 14:05:49 +00:00
increase | A list of moves and how they change the referenced stat | [[MoveStatAffect ](#movestataffect )]
decrease | A list of moves and how they change the referenced stat | [[MoveStatAffect ](#movestataffect )]
2015-12-02 00:01:17 +00:00
#### MoveStatAffect
Name | Description | Data Type
---- | ----------- | ---------
max_change | The maximum amount of change to the referenced stat | integer
move | The move causing the change | [APIResource ](#apiresource ) ([Move](#moves))
#### NatureStatAffectSets
Name | Description | Data Type
---- | ----------- | ---------
2015-12-04 14:05:49 +00:00
increase | A list of natures and how they change the referenced stat | [[NatureStatAffect ](#naturestataffect )]
decrease | A list of nature sand how they change the referenced stat | [[NatureStatAffect ](#naturestataffect )]
2015-12-02 00:01:17 +00:00
#### NatureStatAffect
Name | Description | Data Type
---- | ----------- | ---------
max_change | The maximum amount of change to the referenced stat | integer
nature | The nature causing the change | [APIResource ](#apiresource ) ([Nature](#natures))
## Super Contest Effects
```
api/v2/super-contest-effect/{id or name}
```
2015-12-04 05:07:19 +00:00
Super contest effects refer to the effects of moves when used in super contests.
2015-12-02 00:01:17 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"appeal": 2,
"flavor_text_entries": [{
"flavor_text": "Enables the user to perform first in the next turn.",
"language": {
"name": "en",
"url": "http://localhost:8000/api/v2/language/9/"
}
}],
"moves": [{
"name": "agility",
"url": "http://localhost:8000/api/v2/move/97/"
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### SuperContestEffect
2015-12-02 00:01:17 +00:00
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 ](#flavortext )]
moves | A list of moves that have the effect when used in super contests | [[APIResource ](#apiresource ) ([Move](#moves))]
## Types
```
api/v2/types/{id or name}
```
2015-12-04 05:07:19 +00:00
Types are properties for Pokémon and their moves. Each type has three properties: which types of Pokémon it is super effective against, which types of Pokémon it is not very effective against, and which types of Pokémon it is completely ineffective against.
2015-12-02 00:01:17 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 5,
"name": "ground",
"damage_relations": {
"no_damage_to": [{
"name": "flying",
"url": "http://localhost:8000/api/v2/type/3/"
}],
"half_damage_to": [{
"name": "bug",
"url": "http://localhost:8000/api/v2/type/7/"
}],
"double_damage_to": [{
"name": "poison",
"url": "http://localhost:8000/api/v2/type/4/"
}],
"no_damage_from": [{
"name": "electric",
"url": "http://localhost:8000/api/v2/type/13/"
}],
"half_damage_from": [{
"name": "poison",
"url": "http://localhost:8000/api/v2/type/4/"
}],
"double_damage_from": [{
"name": "water",
"url": "http://localhost:8000/api/v2/type/11/"
}]
},
"game_indices": [{
"game_index": 4,
"generation": {
"name": "generation-i",
"url": "http://localhost:8000/api/v2/generation/1/"
}
}],
"generation": {
"name": "generation-i",
"url": "http://localhost:8000/api/v2/generation/1/"
},
"move_damage_class": {
"name": "physical",
"url": "http://localhost:8000/api/v2/move-damage-class/2/"
},
"names": [{
"name": "ã˜ã‚ã‚“",
"language": {
"name": "ja",
"url": "http://localhost:8000/api/v2/language/1/"
}
}],
"pokemon": [{
"slot": 1,
"pokemon": {
"name": "sandshrew",
"url": "http://localhost:8000/api/v2/pokemon/27/"
}
}],
"moves": [{
"name": "sand-attack",
"url": "http://localhost:8000/api/v2/move/28/"
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### Type
2015-12-02 00:01:17 +00:00
Name | Description | Data Type
---- | ----------- | ---------
2015-12-04 05:07:19 +00:00
id | The identifier for this type resource | integer
name | The name for this type resource | string
damage_relations | A detail of how effective this type is toward others and vice versa | [TypeRelations ](#typerelations )
game_indices | A list of game indices relevent to this item by generation | [[GenerationGameIndex ](#generationgameindex )]
2015-12-04 14:05:49 +00:00
generation | The generation this type was introduced in | [APIResource ](#apiresource ) ([Generation](#generations))
2015-12-04 05:07:19 +00:00
move_damage_class | The class of damage inflicted by this type | [APIResource ](#apiresource ) ([MoveDamageClass](#move-damage-classes))
names | The name of this type listed in different languages | [[Name ](#resourcename )]
pokemon | A list of details of pokemon that have this type | [TypePokemon ](#typepokemon )
moves | A list of moves that have this type | [[APIResource ](#apiresource ) ([Move](#moves))]
2015-12-02 00:01:17 +00:00
#### TypePokemon
Name | Description | Data Type
---- | ----------- | ---------
slot | The order the pokemons types are listed in | integer
2015-12-04 14:05:49 +00:00
pokemon | The pokemon that has the referenced type | [APIResource ](#apiresource ) ([Pokemon](#pokemon))
2015-12-02 00:01:17 +00:00
2015-12-04 05:07:19 +00:00
#### TypeRelations
Name | Description | Data Type
---- | ----------- | ---------
no_damage_to | A list of types this type has no effect on | [[APIResource ](#apiresource ) ([Type](#types))]
half_damage_to | A list of types this type is not very effect against | [[APIResource ](#apiresource ) ([Type](#types))]
double_damage_to | A list of types this type is very effect against | [[APIResource ](#apiresource ) ([Type](#types))]
no_damage_from | A list of types that have no effect on this type | [[APIResource ](#apiresource ) ([Type](#types))]
half_damage_from | A list of types that are not very effective against this type | [[APIResource ](#apiresource ) ([Type](#types))]
double_damage_from | A list of types that are very effective against this type | [[APIResource ](#apiresource ) ([Type](#types))]
2015-12-02 00:01:17 +00:00
## Versions
```
api/v2/version/{id or name}
```
2015-12-04 05:07:19 +00:00
Versions of the games, e.g., Red, Blue or Yellow.
2015-12-02 00:01:17 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "red",
"names": [{
"name": "Rot",
"language": {
"name": "de",
"url": "http://localhost:8000/api/v2/language/6/"
}
}],
"version_group": {
"name": "red-blue",
"url": "http://localhost:8000/api/v2/version-group/1/"
}
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### Version
2015-12-02 00:01:17 +00:00
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 ](#resourcename )]
2015-12-04 05:07:19 +00:00
version_group | The version group this version belongs to | [[APIResource ](#apiresource ) ([VersionGroup](#version-groups))]
2015-12-02 00:01:17 +00:00
## Version Groups
```
api/v2/version-group/{id or name}
```
2015-12-04 05:07:19 +00:00
Version groups categorize highly similar versions of the games.
2015-12-02 00:01:17 +00:00
2015-12-02 05:05:16 +00:00
###### example response
```json
2015-12-04 05:07:19 +00:00
{
"id": 1,
"name": "red-blue",
"order": 1,
"generation": {
"name": "generation-i",
"url": "http://localhost:8000/api/v2/generation/1/"
},
"move_learn_methods": [{
"name": "level-up",
"url": "http://localhost:8000/api/v2/move-learn-method/1/"
}],
"pokedexes": [{
"name": "kanto",
"url": "http://localhost:8000/api/v2/pokedex/2/"
}],
"regions": [{
"name": "kanto",
"url": "http://localhost:8000/api/v2/region/1/"
}],
"versions": [{
"name": "red",
"url": "http://localhost:8000/api/v2/version/1/"
}]
}
2015-12-02 05:05:16 +00:00
```
###### response models
#### VersionGroup
2015-12-02 00:01:17 +00:00
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 ](#apiresource ) ([Generation](#generations))]
2015-12-04 05:07:19 +00:00
move_learn_methods | A list of methods in which pokemon can learn moves in this version group | [[APIResource ](#apiresource ) ([MoveLearnMethod](#move-learn-methods))]
2015-12-02 00:01:17 +00:00
names | The name of this version group listed in different languages | [[Name ](#resourcename )]
pokedexes | A list of pokedexes introduces in this version group | [[APIResource ](#apiresource ) ([Pokedex](#pokedexes))]
regions | A list of regions that can be visited in this version group | [[APIResource ](#apiresource ) ([Region](#regions))]
versions | The versions this version group owns | [[APIResource ](#apiresource ) ([Version](#versions))]
2015-11-28 14:30:55 +00:00
## Common Models
#### APIResource
Name | Description | Data Type
---- | ----------- | ---------
name | The name of the referenced resource | string
2015-12-01 18:47:46 +00:00
url | The url of the referenced resource | string
2015-11-28 14:30:55 +00:00
#### Description
Name | Description | Data Type
---- | ----------- | ---------
description | The localized description for an api resource in a specific language | string
2015-12-01 18:47:46 +00:00
language | The language this name is in | [APIResource ](#apiresource ) ([Language](#languages))
2015-11-28 14:30:55 +00:00
#### Effect
Name | Description | Data Type
---- | ----------- | ---------
2015-11-29 23:39:38 +00:00
effect | The localized effect text for an api resource in a specific language | string
language | The language this effect is in | [APIResource ](#apiresource ) ([Language](#language))
2015-11-28 14:30:55 +00:00
2015-12-01 18:47:46 +00:00
#### 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
2015-12-04 14:05:49 +00:00
condition_values | A list of condition values that must be in effect for this encounter to occur | [[APIResource ](#apiresource ) ([EncounterConditionValue](#encounter-condition-values))]
2015-12-01 18:47:46 +00:00
chance | percent chance that this encounter will occur | integer
2015-12-04 14:05:49 +00:00
method | The method by which this encounter happens | [APIResource ](#apiresource ) ([EncounterMethod](#encounter-methods))
2015-12-01 18:47:46 +00:00
2015-11-28 14:30:55 +00:00
#### FlavorText
Name | Description | Data Type
---- | ----------- | ---------
flavor_text | The localized name for an api resource in a specific language | string
2015-12-04 14:05:49 +00:00
language | The language this name is in | [APIResource ](#apiresource ) ([Language](#languages))
2015-11-29 23:39:38 +00:00
#### GenerationGameIndex
Name | Description | Data Type
---- | ----------- | ---------
game_index | The internal id of an api resource within game data | integer
2015-12-04 14:05:49 +00:00
generation | The generation relevent to this game index | [APIResource ](#apiresource ) ([Generation](#generations))
2015-11-28 14:30:55 +00:00
2015-11-28 16:35:53 +00:00
#### <a name="resourcename"></a>Name
2015-11-28 14:30:55 +00:00
Name | Description | Data Type
---- | ----------- | ---------
name | The localized name for an api resource in a specific language | string
2015-12-04 14:05:49 +00:00
language | The language this name is in | [APIResource ](#apiresource ) ([Language](#languages))
2015-11-28 14:30:55 +00:00
#### VerboseEffect
Name | Description | Data Type
---- | ----------- | ---------
2015-11-29 23:39:38 +00:00
effect | The localized effect text for an api resource in a specific language | string
short_effect | The localized effect text in brief | string
2015-12-04 14:05:49 +00:00
language | The language this effect is in | [APIResource ](#apiresource ) ([Language](#languages))
2015-11-29 23:39:38 +00:00
2015-12-04 05:07:19 +00:00
#### VersionEncounterDetail
Name | Description | Data Type
---- | ----------- | ---------
2015-12-04 14:05:49 +00:00
version | The game version this encounter happens in | [APIResource ](#apiresource ) ([Version](#versions))
2015-12-04 05:07:19 +00:00
max_chance | The total percentage of all encounter potential | integer
encounter_details | A list of encounters and their specifics | [[Encounter ](#encounters )]
2015-11-29 23:39:38 +00:00
#### VersionGameIndex
2015-12-04 05:07:19 +00:00
Name | Description | Data Type
---- | ----------- | ---------
2015-11-29 23:39:38 +00:00
game_index | The internal id of an api resource within game data | integer
2015-12-04 14:05:49 +00:00
version | The version relevent to this game index | [APIResource ](#apiresource ) ([Version](#versions))
2015-11-28 14:30:55 +00:00
2015-12-04 05:07:19 +00:00
#### VersionGroupFlavorText
Name | Description | Data Type
---- | ----------- | ---------
text | The localized name for an api resource in a specific language | string
2015-12-04 14:05:49 +00:00
language | The language this name is in | [APIResource ](#apiresource ) ([Language](#languages))
2015-12-04 05:07:19 +00:00
version_group | The version group which uses this flavor text | [APIResource ](#apiresource ) ([VersionGroup](#version-groups))
2015-11-29 23:39:38 +00:00