pokeapi/pokemon_v2
2015-12-28 00:00:14 -05:00
..
migrations updated data with all of latest veekun updates 2015-12-28 00:00:14 -05:00
__init__.py initial commit 2014-12-04 11:11:46 +00:00
admin.py tests covering all endpoints. working on adding some convenience attributes to api resources to help connect them two way style. tests will probably need some small tweaks 2015-11-15 22:29:30 -05:00
models.py updated data with all of latest veekun updates 2015-12-28 00:00:14 -05:00
README.md identify a few arrays 2015-12-08 13:04:15 -05:00
serializers.py scrub out some unnecessary changes 2015-12-04 09:35:31 -05:00
test_models.py Start on Ability api 2015-09-05 21:22:06 -04:00
tests.py start docs 2015-11-28 09:30:55 -05:00
views.py tests now handling all convenience attributes in all apis 2015-11-26 02:18:35 +01:00

Pokeapi V2 API Reference

API Endpoints

Resource Lists

Calling any api endpoint without a resource id or name will return a paginated list of available resources for that api. By default, a list 'page' will contain up to 20 resources. If you would like to change this just add a 'limit' query param, e.g. limit=60.

example response for non-named resources
{
	"count": 365,
	"next": "http://localhost:8000/api/v2/evolution-chain/?limit=20&offset=20",
	"previous": null,
	"results": [{
		"url": "http://localhost:8000/api/v2/evolution-chain/1/"
	}]
}
response model
Name Description Data Type
count The total number of resources abailable from this api integer
next The url for the next 'page' in the list string
previous The url for the previous page in the list boolean
results I list of non-named api resources [APIResource]
example response for named resources
{
	"count": 248,
	"next": "http://localhost:8000/api/v2/ability/?limit=20&offset=20",
	"previous": null,
	"results": [{
		"name": "stench",
		"url": "http://localhost:8000/api/v2/ability/1/"
	}]
}
response model
Name Description Data Type
count The total number of resources abailable from this api integer
next The url for the next 'page' in the list string
previous The url for the previous page in the list boolean
results I list of named api resources [NamedAPIResource]

Abilities

Abilities provide passive effects for pokemon in battle or in the overworld. Pokemon have mutiple possible abilities but can have only one ability at a time. Check out Bulbapedia for greater detail.

GET api/v2/ability

returns a paginated list of NamedAPIResources

GET api/v2/ability/{id or name}
example response
{
	"id": 1,
	"name": "stench",
	"is_main_series": true,
	"generation": {
		"name": "generation-iii",
		"url": "http://localhost:8000/api/v2/generation/3/"
	},
	"names": [{
		"name": "Stench",
		"language": {
			"name": "en",
			"url": "http://localhost:8000/api/v2/language/9/"
		}
	}],
	"effect_entries": [{
		"effect": "This Pokémon's damaging moves have a 10% chance to make the target [flinch]{mechanic:flinch} with each hit if they do not already cause flinching as a secondary effect.\n\nThis ability does not stack with a held item.\n\nOverworld: The wild encounter rate is halved while this Pokémon is first in the party.",
		"short_effect": "Has a 10% chance of making target Pokémon [flinch]{mechanic:flinch} with each hit.",
		"language": {
			"name": "en",
			"url": "http://localhost:8000/api/v2/language/9/"
		}
	}],
	"effect_changes": [{
		"version_group": {
			"name": "black-white",
			"url": "http://localhost:8000/api/v2/version-group/11/"
		},
		"effect_entries": [{
			"effect": "Has no effect in battle.",
			"language": {
				"name": "en",
				"url": "http://localhost:8000/api/v2/language/9/"
			}
		}]
	}],
	"flavor_text_entries": [{
		"flavor_text": "臭くて 相手が\nひãã€ã€€ã“とがããã€",
		"language": {
			"name": "ja-kanji",
			"url": "http://localhost:8000/api/v2/language/11/"
		},
		"version_group": {
			"name": "x-y",
			"url": "http://localhost:8000/api/v2/version-group/15/"
		}
	}],
	"pokemon": [{
		"is_hidden": true,
		"slot": 3,
		"pokemon": {
			"name": "gloom",
			"url": "http://localhost:8000/api/v2/pokemon/44/"
		}
	}]
}
response models

Ability

Name Description Data Type
id The identifier for this ability resource integer
name The name for this ability resource string
is_main_series Whether or not this ability originated in the main series of the video games boolean
generation The generation this ability originated in NamedAPIResource (Generation)
names The name of this ability listed in different languages [Name]
effect_entries The effect of this ability listed in different languages [VerboseEffect]
effect_changes The list of previous effects this ability has had across version groups [AbilityEffectChange]
flavor_text_entries The flavor text of this ability listed in different languages [VersionGroupFlavorText]
pokemon A list of pokemon that could potentially have this ability [AbilityPokemon]

AbilityEffectChange

Name Description Data Type
effect_entries The previous effect of this ability listed in different languages Effect
version_group The version group in which the previous effect of this ability originated NamedAPIResource (VersionGroup)

AbilityFlavorText

Name Description Data Type
flavor_text The localized name for an api resource in a specific language string
language The language this name is in NamedAPIResource (Language)
version_group The version group that uses this flavor text NamedAPIResource (VersionGroup)

AbilityPokemon

Name Description Data Type
is_hidden Whether or not this a hidden ability for the referenced pokemon boolean
slot Pokemon have 3 ability 'slots' which hold references to possible abilities they could have. This is the slot of this ability for the referenced pokemon. integer
pokemon The pokemon this ability could belong to NamedAPIResource (Pokemon)

Berries

Berries are small fruits that can provide HP and status condition restoration, stat enhancement, and even damage negation when eaten by pokemon. Check out Bulbapedia for greater detail.

GET api/v2/berry

returns a paginated list of NamedAPIResources

GET api/v2/berry/{id or name}
example response
{
	"id": 1,
	"name": "cheri",
	"growth_time": 3,
	"max_harvest": 5,
	"natural_gift_power": 60,
	"size": 20,
	"smoothness": 25,
	"soil_dryness": 15,
	"firmness": {
		"name": "soft",
		"url": "http://localhost:8000/api/v2/berry-firmness/2/"
	},
	"flavors": [{
		"potency": 10,
		"flavor": {
			"name": "spicy",
			"url": "http://localhost:8000/api/v2/berry-flavor/1/"
		}
	}],
	"item": {
		"name": "cheri-berry",
		"url": "http://localhost:8000/api/v2/item/126/"
	},
	"natural_gift_type": {
		"name": "fire",
		"url": "http://localhost:8000/api/v2/type/10/"
	}
}

response models

Berry

Name Description Data Type
id The identifier for this berry resource integer
name The name for this berry resource string
growth_time Time it takes the tree to grow one stage, in hours. Berry trees go through four of these growth stages before they can be picked. integer
max_harvest The maximum number of these berries that can grow on one tree in Generation IV integer
natural_gift_power The power of the move "Natural Gift" when used with this Berry integer
size The size of this Berry, in millimeters integer
smoothness The smoothness of this Berry, used in making Pokéblocks or Poffins integer
soil_dryness The speed at which this Berry dries out the soil as it grows. A higher rate means the soil dries more quickly. integer
firmness The firmness of this berry, used in making Pokéblocks or Poffins NamedAPIResource (BerryFirmness)
flavors A list of references to each flavor a berry can have and the potency of each of those flavors in regard to this berry [BerryFlavorMap]
item Berries are actually items. This is a reference to the item specific data for this berry. NamedAPIResource (Item)
natural_gift_type The Type the move "Natural Gift" has when used with this Berry NamedAPIResource (Type)

BerryFlavorMap

Name Description Data Type
potency How powerful the referenced flavor is for this berry integer
flavor The referenced berry flavor NamedAPIResource (BerryFlavor)

Berry Firmnesses

api/v2/berry-firmness/{id or name}

Berry firmness is a fairly extraneous attribute that effects the outcome of Pokéblocks or Poffins. Check out Bulbapedia for greater detail.

example response
{
	"id": 1,
	"name": "very-soft",
	"berries": [{
		"name": "pecha",
		"url": "http://localhost:8000/api/v2/berry/3/"
	}],
	"names": [{
		"name": "Very Soft",
		"language": {
			"name": "en",
			"url": "http://localhost:8000/api/v2/language/9/"
		}
	}]
}

response models

BerryFirmness

Name Description Data Type
id The identifier for this berry firmness resource integer
name The name for this berry firmness resource string
berries A list of the berries with this firmness [NamedAPIResource (Berry)]
names The name of this berry firmness listed in different languages [Name]

Berry Flavors

Flavors determine whether a pokemon will benefit or suffer from eating a berry based on their nature. Check out Bulbapedia for greater detail.

GET api/v2/berry-flavor

returns a paginated list of NamedAPIResources

GET api/v2/berry-flavor/{id or name}
example response
{
	"id": 1,
	"name": "spicy",
	"berries": [{
		"potency": 10,
		"berry": {
			"name": "rowap",
			"url": "http://localhost:8000/api/v2/berry/64/"
		}
	}],
	"contest_type": {
		"name": "cool",
		"url": "http://localhost:8000/api/v2/contest-type/1/"
	},
	"names": [{
		"name": "Spicy",
		"language": {
			"name": "en",
			"url": "http://localhost:8000/api/v2/language/9/"
		}
	}]
}

response models

BerryFlavor

Name Description Data Type
id The identifier for this berry flavor resource integer
name The name for this berry flavor resource string
berries A list of the berries with this flavor [FlavorBerryMap]
contest_type The contest type that correlates with this berry flavor NamedAPIResource (ContestType)
names The name of this berry flavor listed in different languages [Name]

FlavorBerryMap

Name Description Data Type
potency How powerful the referenced flavor is for this berry integer
berry The berry with the referenced flavor NamedAPIResource (Berry)

Characteristics

Characteristics indicate which stat contains a Pokémon's highest IV. A Pokémon's Characteristic is determined by the remainder of its highest IV divided by 5 (gene_modulo). Check out Bulbapedia for greater detail.

GET api/v2/characteristic

returns a paginated list of APIResources

GET api/v2/characteristic/{id}
example response
{
	"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/"
		}
	}]
}

response models

Characteristic

Name Description Data Type
id The identifier for this characteristic resource integer
gene_modulo The remainder of the highest stat/IV divided by 5 integer
possible_values The possible values of the highest stat that would result in a pokemon recieving this characteristic when divided by 5 [integer]
descriptions The descriptions of this characteristic listed in different languages [Description]

Contest Types

Contest types are categories judges used to weigh a pokemons condition in pokemon contests. Check out Bulbapedia for greater detail.

GET api/v2/contest-type

returns a paginated list of NamedAPIResources

GET api/v2/contest-type/{id or name}
example response
{
	"id": 1,
	"name": "cool",
	"berry_flavor": {
		"name": "spicy",
		"url": "http://localhost:8000/api/v2/berry-flavor/1/"
	},
	"names": [{
		"name": "Cool",
		"color": "Red",
		"language": {
			"name": "en",
			"url": "http://localhost:8000/api/v2/language/9/"
		}
	}]
}

response models

ContestType

Name Description Data Type
id The identifier for this contest type resource integer
name The name for this contest type resource string
berry_flavor The berry flavor that correlates with this contest type NamedAPIResource (BerryFlavor)
names The name of this contest type listed in different languages [Name]

Contest Effects

Contest effects refer to the effects of moves when used in contests.

GET api/v2/contest-effect

returns a paginated list of NamedAPIResources

GET api/v2/contest-effect/{id or name}
example response
{
	"id": 1,
	"appeal": 4,
	"jam": 0,
	"effect_entries": [{
		"effect": "Gives a high number of appeal points wth no other effects.",
		"language": {
			"name": "en",
			"url": "http://localhost:8000/api/v2/language/9/"
		}
	}],
	"flavor_text_entries": [{
		"flavor_text": "A highly appealing move.",
		"language": {
			"name": "en",
			"url": "http://localhost:8000/api/v2/language/9/"
		}
	}]
}

response models

ContestEffect

Name Description Data Type
id The identifier for this contest type resource integer
appeal The base number of hearts the user of this move gets string
jam The base number of hearts the user's opponent loses integer
effect_entries The result of this contest effect listed in different languages [Effect]
flavor_text_entries The flavor text of this contest effect listed in different languages [FlavorText]

Egg Groups

Egg Groups are categories which determine which Pokémon are able to interbreed. Pokémon may belong to either one or two Egg Groups. Check out Bulbapedia for greater detail.

GET api/v2/egg-group

returns a paginated list of NamedAPIResources

GET api/v2/egg-group/{id or name}
example response
{
	"id": 1,
	"name": "monster",
	"names": [{
		"name": "かいじゅう",
		"language": {
			"name": "ja",
			"url": "http://localhost:8000/api/v2/language/1/"
		}
	}],
	"pokemon_species": [{
		"name": "bulbasaur",
		"url": "http://localhost:8000/api/v2/pokemon-species/1/"
	}]
}

response models

EggGroup

Name Description Data Type
id The identifier for this egg group resource integer
name The name for this egg group resource string
names The name of this egg group listed in different languages [Name]
pokemon_species A list of all pokemon species that are members of this egg group NamedAPIResource (PokemonSpecies)

Encounter Methods

Methods by which the player might can encounter pokemon in the wild, e.g., walking in tall grass. Check out Bulbapedia for greater detail.

GET api/v2/encounter-method

returns a paginated list of NamedAPIResources

GET api/v2/encounter-method/{id or name}
example response
{
	"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/"
		}
	}]
}

response models

EncounterMethod

Name Description Data Type
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]

Encounter Conditions

Conditions which affect what pokemon might appear in the wild, e.g., day or night.

GET api/v2/encounter-condition

returns a paginated list of NamedAPIResources

GET api/v2/encounter-condition/{id or name}
example response
{
	"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/"
		}
	}]
}

response models

EncounterCondition

Name Description Data Type
id The identifier for this encounter condition resource integer
name The name for this encounter condition resource string
names The name of this encounter method listed in different languages [Name]
values A list of possible values for this encounter condition [NamedAPIResource (EncounterConditionValue)]

Encounter Condition Values

Encounter condition values are the various states that an encounter condition can have, i.e., Time of day can be either day or night.

GET api/v2/encounter-condition-value

returns a paginated list of NamedAPIResources

GET api/v2/encounter-condition-value/{id or name}
example response
{
	"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/"
		}
	}]
}

response models

EncounterConditionValue

Name Description Data Type
id The identifier for this encounter condition value resource integer
name The name for this encounter condition value resource string
condition The condition this encounter condition value pertains to [NamedAPIResource (EncounterCondition)]
names The name of this encounter condition value listed in different languages [Name]

Evolution Chains

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.

GET api/v2/evolution-chain

returns a paginated list of APIResources

GET api/v2/evolution-chain/{id}
example response
{
	"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": []
		}]
	}
}
response models

EvolutionChain

Name Description Data Type
id The identifier for this evolution chain resource integer
baby_trigger_item The item that a pokemon would be holding when mating that would trigger the egg hatching a baby pokemon rather than a basic pokemon NamedAPIResource (Item)
chain The base chain link object. Each link contains evolution details for a pokemon in the chain. Each link references the next pokemon in the natural evolution order. ChainLink
Name Description Data Type
is_baby Whether or not this link is for a baby pokemon. This would only ever be true on the base link. boolean
species The pokemon species at this point in the evolution chain NamedAPIResource (PokemonSpecies)
evolution_details All details regarding the specific details of the referenced pokemon species evolution EvolutionDetail
evolves_to A List of chain objects. ChainLink

EvolutionDetail

Name Description Data Type
item The item required to cause evolution this into pokemon species NamedAPIResource (Item)
trigger The type of event that triggers evolution into this pokemon species NamedAPIResource (EvolutionTrigger)
gender The gender the evolving pokemon species must be in order to evolve into this pokemon species NamedAPIResource (Gender)
held_item The item the evolving pokemon species must be holding during the evolution trigger event to evolve into this pokemon species NamedAPIResource (Item)
known_move The move that must be known by the evolving pokemon species during the evolution trigger event in order to evolve into this pokemon species NamedAPIResource (Move)
known_move_type The evolving pokemon species must know a move with this type during the evolution trigger event in order to evolve into this pokemon species NamedAPIResource (Type)
location The location the evolution must be triggered at. NamedAPIResource (Location)
min_level The minimum required level of the evolving pokemon species to evolve into this pokemon species integer
min_hapiness The minimum required level of happiness the evolving pokemon species to evolve into this pokemon species integer
min_beauty The minimum required level of beauty the evolving pokemon species to evolve into this pokemon species integer
min_affection The minimum required level of affection the evolving pokemon species to evolve into this pokemon species integer
needs_overworld_rain Whether or not it must be raining in the overworld to cause evolution this pokemon species boolean
party_species The pokemon species that must be in the players party in order for the evolving pokemon species to evolve into this pokemon species NamedAPIResource (PokemonSpecies)
party_type The player must have a pokemon of this type in their party during the evolution trigger event in order for the evolving pokemon species to evolve into this pokemon species NamedAPIResource (Type)
relative_physical_stats The required relation between the Pokémon's Attack and Defense stats. 1 means Attack > Defense. 0 means Attack = Defense. -1 means Attack < Defense. integer
time_of_day The required time of day. Day or night. string
trade_species Pokemon species for which this one must be traded. NamedAPIResource (Pokemon Species)
turn_upside_down Whether or not the 3DS needs to be turned upside-down as this Pokémon levels up. boolean

Evolution Triggers

Evolution triggers are the events and conditions that cause a pokemon to evolve. Check out Bulbapedia for greater detail.

GET api/v2/evolution-trigger

returns a paginated list of NamedAPIResources

GET api/v2/evolution-trigger/{id or name}
example response
{
	"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/"
	}]
}

response models

EvolutionTrigger

Name Description Data Type
id The identifier for this evolution trigger resource integer
name The name for this evolution trigger resource string
names The name of this evolution trigger listed in different languages [Name]
pokemon_species A list of pokemon species that result from this evolution trigger [NamedAPIResource (PokemonSpecies)]

Generations

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.

GET api/v2/generation

returns a paginated list of NamedAPIResources

GET api/v2/generation/{id or name}
example response
{
	"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/"
	}]
}

response models

Generation

Name Description Data Type
id The identifier for this generation resource integer
name The name for this generation resource string
abilities A list of abilities that were introduced in this generation [NamedAPIResource (Ability)]
names The name of this generation listed in different languages [Name]
main_region The main region travelled in this generation NamedAPIResource (Region)
moves A list of moves that were introduced in this generation [NamedAPIResource (Move)]
pokemon_species A list of pokemon species that were introduced in this generation [NamedAPIResource (PokemonSpecies)]
types A list of types that were introduced in this generation [NamedAPIResource (Type)]
version_groups A list of version groups that were introduced in this generation [NamedAPIResource (VersionGroup)]

Genders

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 for greater detail.

GET api/v2/gender

returns a paginated list of NamedAPIResources

GET api/v2/gender/{id or name}
example response
{
	"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/"
	}]
}

response models

Gender

Name Description Data Type
id The identifier for this gender resource integer
name The name for this gender resource string
pokemon_species_details A list of pokemon species that can be this gender and how likely it is that they will be [PokemonSpeciesGender]
required_for_evolution A list of pokemon species that required this gender in order for a pokemon to evolve into them [NamedAPIResource (PokemonSpecies)]

PokemonSpeciesGender

Name Description Data Type
rate The chance of this Pokémon being female, in eighths; or -1 for genderless integer
pokemon_species A pokemon species that can be the referenced gender NamedAPIResource (PokemonSpecies)

Growth Rates

Growth rates are the speed with which pokemon gain levels through experience. Check out Bulbapedia for greater detail.

GET api/v2/growth-rate

returns a paginated list of NamedAPIResources

GET api/v2/growth-rate/{id or name}
example response
{
	"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/"
	}]
}
response models

Growth Rate

Name Description Data Type
id The identifier for this gender resource integer
name The name for this gender resource string
formula The formula used to calculate the rate at which the pokemon species gains level string
descriptions The descriptions of this characteristic listed in different languages [Description]
levels A list of levels and the amount of experienced needed to atain them based on this growth rate [GrowthRateExperienceLevel]
pokemon_species A list of pokemon species that gain levels at this growth rate [NamedAPIResource (PokemonSpecies)]

GrowthRateExperienceLevel

Name Description Data Type
level The level gained integer
experience The amount of experience required to reach the referenced level integer

Items

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.

GET api/v2/item

returns a paginated list of NamedAPIResources

GET api/v2/item/{id or name}
example response
{
	"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/"
	}
}
response models

Item

Name Description Data Type
id The identifier for this item resource integer
name The name for this item resource string
cost The price of this item in stores integer
fling_power The power of the move Fling when used with this item. integer
fling_effect The effect of the move Fling when used with this item ItemFlingEffect
attributes A list of attributes this item has [NamedAPIResource (ItemAttribute)]
category The category of items this item falls into ItemCategory
effect_entries The effect of this ability listed in different languages [VerboseEffect]
flavor_text_entries The flavor text of this ability listed in different languages [VersionGroupFlavorText]
game_indices A list of game indices relevent to this item by generation [GenerationGameIndex]
names The name of this item listed in different languages [Name]
held_by_pokemon A list of pokemon that might be found in the wild holding this item [NamedAPIResource (Pokemon)]
baby_trigger_for An evolution chain this item requires to produce a bay during mating [APIResource (EvolutionChain)]

Item Fling Effects

The various effects of the move "Fling" when used with different items.

GET api/v2/item-fling-effect

returns a paginated list of NamedAPIResources

GET api/v2/item-fling-effect/{id or name}
example response
{
	"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/"
	}]
}
response models

ItemFlingEffect

Name Description Data Type
id The identifier for this fling effect resource integer
name The name for this fling effect resource string
effect_entries The result of this fling effect listed in different languages [Effect]
items A list of items that have this fling effect [NamedAPIResource (Item)]

Item Attributes

Item attributes define particular aspects of items, e.g. "usable in battle" or "consumable".

GET api/v2/item-attribute

returns a paginated list of NamedAPIResources

GET api/v2/item-attribute/{id or name}
example response
{
	"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]
names The name of this item attribute listed in different languages [Name]
descriptions The description of this item attribute listed in different languages [Description]

Item Categories

Item categories determine where items will be placed in the players bag.

GET api/v2/item-category

returns a paginated list of NamedAPIResources

GET api/v2/item-category/{id or name}
example response
{
	"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/"
	}
}
response models

ItemCategory

Name Description Data Type
id The identifier for this item category resource integer
name The name for this item category resource string
items A list of items that are a part of this category [Item]
names The name of this item category listed in different languages [Name]
pocket The pocket items in this category would be put in [NamedAPIResource (ItemPocket)]

Item Pockets

Pockets within the players bag used for storing items by category.

GET api/v2/item-pocket

returns a paginated list of NamedAPIResources

GET api/v2/item-pocket/{id or name}
example response
{
	"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/"
		}
	}]
}
response models

ItemPocket

Name Description Data Type
id The identifier for this item pocket resource integer
name The name for this item pocket resource string
categories A list of item categories that are relevent to this item pocket [ItemCategory]
names The name of this item pocket listed in different languages [Name]

Languages

Languages for translations of api resource information.

GET api/v2/language

returns a paginated list of NamedAPIResources

GET api/v2/language/{id or name}
example response
{
	"id": 1,
	"name": "ja",
	"official": true,
	"iso639": "ja",
	"iso3166": "jp",
	"names": [{
		"name": "Japanese",
		"language": {
			"name": "en",
			"url": "http://localhost:8000/api/v2/language/9/"
		}
	}]
}
response models

Language

Name Description Data Type
id The identifier for this language resource integer
name The name for this language resource string
official Whether or not the games are published in this language boolean
is639 The two-letter code of the country where this language is spoken. Note that it is not unique. string
iso3166 The two-letter code of the language. Note that it is not unique. string
names The name of this language listed in different languages [Name]

Locations

Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes.

GET api/v2/location

returns a paginated list of NamedAPIResources

GET api/v2/location/{id or name}
example response
{
	"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/"
	}]
}
response models

Location

Name Description Data Type
id The identifier for this location resource integer
name The name for this location resource string
region The region this location can be found in NamedAPIResource (Region)
names The name of this language listed in different languages [Name]
game_indices A list of game indices relevent to this location by generation [GenerationGameIndex]
areas Areas that can be found within this location APIResource (LocationArea)

Location Areas

Location areas are sections of areas, such as floors in a building or cave. Each area has its own set of possible pokemon encounters.

GET api/v2/location-area

returns a paginated list of APIResources

GET api/v2/location-area/{id}
example response
{
	"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/"
				}
			}]
		}]
	}]
}
response models

LocationArea

Name Description Data Type
id The identifier for this location resource integer
name The name for this location resource string
game_index The internal id of an api resource within game data integer
encounter_method_rates A list of methods in which pokemon may be encountered in this area and how likely the method will occur depending on the version of the game [EncounterMethodRate]
location The region this location can be found in NamedAPIResource (Region)
names The name of this location area listed in different languages [Name]
pokemon_encounters A list of pokemon that can be encountered in this area along with version specific details about the encounter [PokemonEncounter]

PokemonEncounter

Name Description Data Type
pokemon The pokemon being encountered NamedAPIResource (Pokemon)
version_details A list of versions and encounters with pokemon that might happen in the referenced location area [VersionEncounterDetail]

Moves

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.

GET api/v2/move

returns a paginated list of NamedAPIResources

GET api/v2/move/{id or name}
example response
{
	"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/"
	}
}
response models

Move

Name Description Data Type
id The identifier for this move resource integer
name The name for this move resource string
accuracy The percent value of how likely this move is to be successful integer
effect_chance The percent value of how likely it is this moves effect will happen integer
pp Power points. The number of times this move can be used integer
priority A value between -8 and 8. Sets the order in which moves are executed during battle. See Bulbapedia for greater detail. integer
power The base power of this move with a value of 0 if it does not have a base power integer
contest_combos A detail of normal and super contest combos that require this move [ContestComboSets]
contest_type The type of appeal this move gives a pokemon when used in a contest NamedAPIResource (ContestType)
contest_effect The effect the move has when used in a contest NamedAPIResource (ContestEffect)
damage_class The type of damage the move inflicts on the target, e.g. physical NamedAPIResource (MoveDamageClass)
effect_entries The effect of this move listed in different languages [VerboseEffect]
effect_changes The list of previous effects this move has had across version groups of the games [AbilityEffectChange]
generation The generation in which this move was introduced NamedAPIResource (Generation)
meta Meta data about this move MoveMetaData
names The name of this move listed in different languages [Name]
past_values A list of move resource value changes across ersion groups of the game [PastMoveStatValues]
stat_changes A list of stats this moves effects and how much it effects them [MoveStatChange]
contest_effect The effect the move has when used in a super contest NamedAPIResource (ContestEffect)
target The type of target that will recieve the effects of the attack MoveTarget
type The elemental type of this move Type

ContestComboSets

Name Description Data Type
normal A detail of moves this move can be used before or after, granting additional appeal points in contests [ContestComboDetail]
super A detail of moves this move can be used before or after, granting additional appeal points in super contests [ContestComboDetail]

ContestComboDetail

Name Description Data Type
use_before A list of moves to use before this move [NamedAPIResource (Move)]
use_after A list of moves to use after this move [NamedAPIResource (Move)]

MoveMetaData

Name Description Data Type
ailment The status ailment this move inflicts on its target NamedAPIResource (MoveAilment)
category The category of move this move falls under, e.g. damage or ailment NamedAPIResource (Move)
min_hits The minimum number of times this move hits. Null if it always only hits once. integer
max_hits The maximum number of times this move hits. Null if it always only hits once. integer
min_turns The minimum number of turns this move continues to take effect. Null if it always only lasts one turn. integer
max_turns The maximum number of turns this move continues to take effect. Null if it always only lasts one turn. integer
drain HP drain (if positive) or Recoil damage (if negative), in percent of damage done integer
healing The amount of hp gained by the attacking pokemon, in percent of it's maximum HP integer
crit_rate Critical hit rate bonus integer
ailment_chance The likelyhood this attack will cause an ailment integer
flinch_chance The likelyhood this attack will cause the target pokemon to flinch integer
stat_chance The likelyhood this attack will cause a stat change in the target pokemon integer

MoveStatChange

Name Description Data Type
change The amount of change integer
stat The stat being affected NamedAPIResource Stat

PastMoveStatValues

Name Description Data Type
accuracy The percent value of how likely this move is to be successful integer
effect_chance The percent value of how likely it is this moves effect will take effect integer
power The base power of this move with a value of 0 if it does not have a base power integer
pp Power points. The number of times this move can be used integer
effect_entries The effect of this move listed in different languages [VerboseEffect]
type The elemental type of this move Type
version group The version group in which these move stat values were in effect NamedAPIResource (VersionGroup)

Move Ailments

Move Ailments are status conditions caused by moves used during battle. See Bulbapedia for greater detail.

GET api/v2/move-ailment

returns a paginated list of NamedAPIResources

GET api/v2/move-ailment/{id or name}
example response
{
	"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/"
		}
	}]
}
response models

Move Ailment

Name Description Data Type
id The identifier for this move ailment resource integer
name The name for this move ailment resource string
moves A list of moves that cause this ailment [NamedAPIResource (Move)]
names The name of this move ailment listed in different languages [Name]

Move Battle Styles

Styles of moves when used in the Battle Palace. See Bulbapedia for greater detail.

GET api/v2/move-battle-style

returns a paginated list of NamedAPIResources

GET api/v2/move-battle-style/{id or name}
example response
{
	"id": 1,
	"name": "attack",
	"names": [{
		"name": "Attack",
		"language": {
			"name": "en",
			"url": "http://localhost:8000/api/v2/language/9/"
		}
	}]
}
response models

Move Battle Style

Name Description Data Type
id The identifier for this move battle style resource integer
name The name for this move battle style resource string
names The name of this move battle style listed in different languages [Name]

Move Categories

Very general categories that loosely group move effects.

GET api/v2/move-category

returns a paginated list of NamedAPIResources

GET api/v2/move-category/{id or name}
example response
{
	"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/"
	}]
}
response models

Move Category

Name Description Data Type
id The identifier for this move category resource integer
name The name for this move category resource string
moves A list of moves that fall into this category [NamedAPIResource (Move)]
descriptions The description of this move ailment listed in different languages [Description]

Move Damage Classes

Damage classes moves can have, e.g. physical, special, or non-damaging.

GET api/v2/move-damage-class

returns a paginated list of NamedAPIResources

GET api/v2/move-damage-class/{id or name}
example response
{
	"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/"
	}]
}
response models

Move Damage Class

Name Description Data Type
id The identifier for this move damage class resource integer
name The name for this move damage class resource string
descriptions The description of this move damage class listed in different languages [Description]
moves A list of moves that fall into this damage class [NamedAPIResource (Move)]
names The name of this move damage class listed in different languages [Name]

Move Learn Methods

Methods by which pokemon can learn moves.

GET api/v2/move-learn-method

returns a paginated list of NamedAPIResources

GET api/v2/move-learn-method/{id or name}
example response
{
	"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/"
	}]
}
response models

Move Learn Method

Name Description Data Type
id The identifier for this move learn method resource integer
name The name for this move learn method resource string
descriptions The description of this move learn method listed in different languages [Description]
names The name of this move learn method listed in different languages [Name]
version_groups A list of version groups where moves can be learned through this method [NamedAPIResource (VersionGroup)]

Move Targets

Targets moves can be directed at during battle. Targets can be pokemon, environments or even other moves.

GET api/v2/move-target

returns a paginated list of NamedAPIResources

GET api/v2/move-target/{id or name}
example response
{
	"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/"
		}
	}]
}
response models

Move Target

Name Description Data Type
id The identifier for this move target resource integer
name The name for this move target resource string
descriptions The description of this move target listed in different languages [Description]
moves A list of moves that that are directed at this target [NamedAPIResource (Move)]
names The name of this move target listed in different languages [Name]

Natures

Natures influence how a pokemon's stats grow. See Bulbapedia for greater detail.

GET api/v2/nature

returns a paginated list of NamedAPIResources

GET api/v2/nature/{id or name}
example response
{
	"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/"
		}
	}]
}
response models

Nature

Name Description Data Type
id The identifier for this nature resource integer
name The name for this nature resource string
decreased_stat The stat decreased by 10% in pokemon with this nature NamedAPIResource (Stat)
increased_stat The stat increased by 10% in pokemon with this nature NamedAPIResource (Stat)
hates_flavor The flavor hated by pokemon with this nature NamedAPIResource (BerryFlavor)
likes_flavor The flavor liked by pokemon with this nature NamedAPIResource (BerryFlavor)
pokeathlon_stat_changes A list of pokeathlon stats this nature effects and how much it effects them [NatureStatChange]
move_battle_style_preferences A list of battle styles and how likely a pokemon with this nature is to use them in the Battle Palace or Battle Tent. [MoveBattleStylePreference]
names The name of this nature listed in different languages [Name]

NatureStatChange

Name Description Data Type
change The amount of change integer
stat The stat being affected NamedAPIResource (PokeathlonStat)

MoveBattleStylePreference

Name Description Data Type
low_hp_preference Chance of using the move, in percent, if HP is under one half integer
high_hp_preference Chance of using the move, in percent, if HP is over one half integer
move_battle_style The move battle style NamedAPIResource (MoveBattleStyle)

Pal Park Areas

Areas used for grouping pokemon encounters in Pal Park. They're like habitats that are specific to Pal Park. <<<<<<< HEAD

GET api/v2/pal-park-area

=======

GET api/v2/pal-park-area

7d25324ac0 returns a paginated list of NamedAPIResources

GET api/v2/pal-park-area/{id or name}
example response
{
	"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/"
		}
	}]
}
response models

PalParkArea

Name Description Data Type
id The identifier for this pal park area resource integer
name The name for this pal park area resource string
names The name of this pal park area listed in different languages [Name]
pokemon_encounters A list of pokemon encountered in thi pal park area along with details [PalParkEncounterSpecies]

PalParkEncounterSpecies

Name Description Data Type
base_score The base score given to the player when this pokemon is caught during a pal park run integer
rate The base rate for encountering this pokemon in this pal park area integer
pokemon_species The pokemon species being encountered NamedAPIResource (PokemonSpecies)

Pokedexes

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 for greater detail.

GET api/v2/pokedex

returns a paginated list of NamedAPIResources

GET api/v2/pokedex/{id or name}
example response
{
	"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/"
	}]
}
response models

Pokedex

Name Description Data Type
id The identifier for this pokedex resource integer
name The name for this pokedex resource string
is_main_series Whether or not this pokedex originated in the main series of the video games boolean
descriptions The description of this pokedex listed in different languages [Description]
names The name of this pokedex listed in different languages [Name]
pokemon_entries A list of pokemon catalogued in this pokedex and their indexes [PokemonEntry]
region The region this pokedex catalogues pokemon for NamedAPIResource (Region)
version_groups A list of version groups this pokedex is relevent to NamedAPIResource (VersionGroup)

PokemonEntry

Name Description Data Type
entry_number The index of this pokemon species entry within the pokedex integer
pokemon_species The pokemon species being encountered NamedAPIResource (PokemonSpecies)

Pokemon

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 for greater detail.

GET api/v2/pokemon

returns a paginated list of NamedAPIResources

GET api/v2/pokemon/{id or name}
example response
{
	"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/"
		}
	}]
}
response models

Pokemon

Name Description Data Type
id The identifier for this pokemon resource integer
name The name for this pokemon resource string
base_experience The base experience gained for defeating this pokemon integer
height The height of this pokemon integer
is_default Set for exactly one pokemon used as the default for each species boolean
order 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]
forms A list of forms this pokemon can take on [NamedAPIResource (PokemonForm)]
game_indices A list of game indices relevent to pokemon item by generation [VersionGameIndex]
held_items A list of items this pokemon may be holding when encountered [NamedAPIResource (Item)]
location_area_encounters A list of location areas as well as encounter details pertaining to specific versions [LocationAreaEncounter]
moves A list of moves along with learn methods and level details pertaining to specific version groups NamedAPIResource (Move](#moves))
species The species this pokemon belongs to NamedAPIResource (PokemonSpecies](#pokemon-species))
stats A list of base stat values for this pokemon [NamedAPIResource (Stat)]
types A list of details showing types this pokemon has [PokemonType]

PokemonAbility

Name Description Data Type
is_hidden Whether or not this is a hidden ability boolean
slot The slot this ability occupies in this pokemon species integer
ability The ability the pokemon may have NamedAPIResource (Ability)

PokemonType

Name Description Data Type
slot The order the pokemons types are listed in integer
type The type the referenced pokemon has string

LocationAreaEncounter

Name Description Data Type
location_area The location area the referenced pokemon can be encountered in APIResource (LocationArea)
version_details A list of versions and encounters with the referenced pokemon that might happen [VersionEncounterDetail]

Pokemon Colors

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.

GET api/v2/pokemon-color

returns a paginated list of NamedAPIResources

GET api/v2/pokemon-color/{id or name}
example response
{
	"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/"
	}]
}
response models

PokemonColor

Name Description Data Type
id The identifier for this pokemon color resource integer
name The name for this pokemon color resource string
names The name of this pokemon color listed in different languages [Name]
pokemon_species A list of the pokemon species that have this color [NamedAPIResource (PokemonSpecies)]

Pokemon Forms

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.

GET api/v2/pokemon-form

returns a paginated list of NamedAPIResources

GET api/v2/pokemon-form/{id or name}
example response
{
	"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/"
	}
}
response models

PokemonForm

Name Description Data Type
id The identifier for this pokemon color resource integer
name The name for this pokemon color resource string
order The order in which forms should be sorted within all forms. Multiple forms may have equal order, in which case they should fall back on sorting by name. integer
form_order The order in which forms should be sorted within a species' forms integer
is_default True for exactly one form used as the default for each pokemon boolean
is_battle_only Whether or not this form can only happen during battle boolean
is_mega Whether or not this form requires mega evolution boolean
form_name The name of this form string
pokemon The pokemon that can take on this form NamedAPIResource (Pokemon)
version_group The version group this pokemon form was introduced in NamedAPIResource (VersionGroup)

Pokemon Habitats

Habitats are generally different terrain pokemon can be found in but can also be areas designated for rare or legendary pokemon.

GET api/v2/pokemon-habitat

returns a paginated list of NamedAPIResources

GET api/v2/pokemon-habitat/{id or name}
example response

response models

PokemonHabitat

Name Description Data Type
id The identifier for this pokemon habitat resource integer
name The name for this pokemon habitat resource string
names The name of this pokemon habitat listed in different languages [Name]
pokemon_species A list of the pokemon species that can be found in this habitat [NamedAPIResource (PokemonSpecies)]

Pokemon Shapes

Shapes used for sorting pokemon in a pokedex.

GET api/v2/pokemon-shape

returns a paginated list of NamedAPIResources

GET api/v2/pokemon-shape/{id or name}
example response

response models

PokemonShape

Name Description Data Type
id The identifier for this pokemon shape resource integer
name The name for this pokemon shape resource string
awesome_names The "scientific" name of this pokemon shape listed in different languages [AwesomeName]
names The name of this pokemon shape listed in different languages [Name]
pokemon_species A list of the pokemon species that have this shape [NamedAPIResource (PokemonSpecies)]

AwesomeName

Name Description Data Type
awesome_name The localized "scientific" name for an api resource in a specific language string
language The language this "scientific" name is in NamedAPIResource (Language)

Pokemon Species

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.

GET api/v2/pokemon-species

returns a paginated list of NamedAPIResources

GET api/v2/pokemon-species/{id or name}
example response
{
	"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/"
		}
	}]
}
response models

PokemonSpecies

Name Description Data Type
id The identifier for this pokemon species resource integer
name The name for this pokemon species resource string
order The order in which species should be sorted. Based on National Dex order, except families are grouped together and sorted by stage. integer
gender_rate The chance of this Pokémon being female, in eighths; or -1 for genderless integer
capture_rate The base capture rate; up to 255. The higher the number, the easier the catch. integer
base_happiness The happiness when caught by a normal pokeball; up to 255. The higher the number, the happier the pokemon. integer
is_baby Whether or not this is a baby pokemon boolean
hatch_counter Initial hatch counter: one must walk 255 × (hatch_counter + 1) steps before this Pokémon's egg hatches, unless utilizing bonuses like Flame Body's integer
has_gender_differences Whether or not this pokemon can have different genders boolean
forms_switchable Whether or not this pokemon has multiple forms and can switch between them boolean
growth_rate The rate at which this pokemon species gains levels NamedAPIResource (GrowthRate)
pokedex_numbers A list of pokedexes and the indexes reserved within them for this pokemon species [PokemonSpeciesDexEntry]
egg_groups A list of egg groups this pokemon species is a member of [NamedAPIResource (EggGroup)]
color The color of this pokemon for gimmicky pokedex search [NamedAPIResource (PokemonColor)]
shape The shape of this pokemon for gimmicky pokedex search [NamedAPIResource (PokemonShape)]
evolves_from_species The pokemon species that evolves into this pokemon_species NamedAPIResource (PokemonSpecies)
evolution_chain The evolution chain this pokemon species is a member of APIResource (EvolutionChain)
habitat The habitat this pokemon species can be encountered in NamedAPIResource (PokemonHabitat)
generation The generation this pokemon species was introduced in NamedAPIResource (Generation)
names The name of this pokemon species listed in different languages [Name]
pal_park_encounters A list of encounters that can be had with this pokemon species in pal park [PalParkEncounterArea]
form_descriptions Descriptions of different forms pokemon take on within the pokemon species [Description]
genera The genus of this pokemon species listed in multiple languages Genus
varieties A list of the pokemon that exist within this pokemon species [NamedAPIResource (Pokemon)]

Genus

Name Description Data Type
genus The localized genus for the referenced pokemon species string
language The language this genus is in NamedAPIResource (Language)

PokemonSpeciesDexEntry

Name Description Data Type
entry_number The index number within the pokedex integer
name The pokdex the referenced pokemon species can be found in NamedAPIResource (Pokedex)

PalParkEncounterArea

Name Description Data Type
base_score The base score given to the player when the referenced pokemon is caught during a pal park run integer
rate The base rate for encountering the referenced pokemon in this pal park area integer
area The pal park area where this encounter happens NamedAPIResource (PalParkArea)

Pokeathlon Stats

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 for greater detail.

GET api/v2/pokeathlon-stat

returns a paginated list of NamedAPIResources

GET api/v2/pokeathlon-stat/{id or name}
example response
{
	"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/"
		}
	}]
}
response models

PokeathlonStat

Name Description Data Type
id The identifier for this pokeathlon stat resource integer
name The name for this pokeathlon stat resource string
names The name of this pokeathlon stat listed in different languages [Name]
affecting_natures A detail of natures which affect this pokeathlon stat positively or negatively NaturePokeathlonStatAffectSets

NaturePokeathlonStatAffectSets

Name Description Data Type
increase A list of natures and how they change the referenced pokeathlon stat [NaturePokeathlonStatAffect]
decrease A list of natures and how they change the referenced pokeathlon stat [NaturePokeathlonStatAffect]

NaturePokeathlonStatAffect

Name Description Data Type
max_change The maximum amount of change to the referenced pokeathlon stat integer
nature The nature causing the change NamedAPIResource (Nature)

Regions

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.

GET api/v2/region

returns a paginated list of NamedAPIResources

GET api/v2/region/{id or name}
example response
{
	"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/"
	}]
}
response models

Region

Name Description Data Type
id The identifier for this region resource integer
name The name for this region resource string
locations A list of locations that can be found in this region NamedAPIResource (Location)
main_generation The generation this region was introduced in NamedAPIResource (Generation)
names The name of this region listed in different languages [Name]
pokedexes A list of pokedexes that catalogue pokemon in this region NamedAPIResource (Pokedex)
version_groups A list of version groups where this region can be visited NamedAPIResource (VersionGroup)

Stats

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.

GET api/v2/stat

returns a paginated list of NamedAPIResources

GET api/v2/stat/{id or name}
example response
{
	"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/"
		}
	}]
}
response models

Stat

Name Description Data Type
id The identifier for this stat resource integer
name The name for this stat resource string
game_index ID the games use for this stat integer
is_battle_only Whether this stat only exists within a battle boolean
affecting_moves A detail of moves which affect this stat positively or negatively MoveStatAffectSets
affecting_natures A detail of natures which affect this stat positively or negatively NatureStatAffectSets
characteristics A list of characteristics that are set on a pokemon when its highest base stat is this stat [APIResource (Characteristic)]
move_damage_class The class of damage this stat is directly related to NamedAPIResource (MoveDamageClass)
names The name of this region listed in different languages [Name]

MoveStatAffectSets

Name Description Data Type
increase A list of moves and how they change the referenced stat [MoveStatAffect]
decrease A list of moves and how they change the referenced stat [MoveStatAffect]

MoveStatAffect

Name Description Data Type
max_change The maximum amount of change to the referenced stat integer
move The move causing the change NamedAPIResource (Move)

NatureStatAffectSets

Name Description Data Type
increase A list of natures and how they change the referenced stat [NatureStatAffect]
decrease A list of nature sand how they change the referenced stat [NatureStatAffect]

NatureStatAffect

Name Description Data Type
max_change The maximum amount of change to the referenced stat integer
nature The nature causing the change NamedAPIResource (Nature)

Super Contest Effects

Super contest effects refer to the effects of moves when used in super contests.

GET api/v2/super-contest-effect

returns a paginated list of NamedAPIResources

GET api/v2/super-contest-effect/{id or name}
example response
{
	"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/"
	}]
}
response models

SuperContestEffect

Name Description Data Type
id The identifier for this super contest effect resource integer
appeal The level of appeal this super contest effect has string
flavor_text_entries The flavor text of this super contest effect listed in different languages [FlavorText]
moves A list of moves that have the effect when used in super contests [NamedAPIResource (Move)]

Types

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.

GET api/v2/type

returns a paginated list of NamedAPIResources

GET api/v2/type/{id or name}
example response
{
	"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/"
	}]
}
response models

Type

Name Description Data Type
id The identifier for this type resource integer
name The name for this type resource string
damage_relations A detail of how effective this type is toward others and vice versa TypeRelations
game_indices A list of game indices relevent to this item by generation [GenerationGameIndex]
generation The generation this type was introduced in NamedAPIResource (Generation)
move_damage_class The class of damage inflicted by this type NamedAPIResource (MoveDamageClass)
names The name of this type listed in different languages [Name]
pokemon A list of details of pokemon that have this type TypePokemon
moves A list of moves that have this type [NamedAPIResource (Move)]

TypePokemon

Name Description Data Type
slot The order the pokemons types are listed in integer
pokemon The pokemon that has the referenced type NamedAPIResource (Pokemon)

TypeRelations

Name Description Data Type
no_damage_to A list of types this type has no effect on [NamedAPIResource (Type)]
half_damage_to A list of types this type is not very effect against [NamedAPIResource (Type)]
double_damage_to A list of types this type is very effect against [NamedAPIResource (Type)]
no_damage_from A list of types that have no effect on this type [NamedAPIResource (Type)]
half_damage_from A list of types that are not very effective against this type [NamedAPIResource (Type)]
double_damage_from A list of types that are very effective against this type [NamedAPIResource (Type)]

Versions

Versions of the games, e.g., Red, Blue or Yellow.

GET api/v2/version

returns a paginated list of NamedAPIResources

GET api/v2/version/{id or name}
example response

{
	"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/"
	}
}
response models

Version

Name Description Data Type
id The identifier for this version resource integer
name The name for this version resource string
names The name of this version listed in different languages [Name]
version_group The version group this version belongs to [NamedAPIResource (VersionGroup)]

Version Groups

Version groups categorize highly similar versions of the games.

GET api/v2/version-group

returns a paginated list of NamedAPIResources

GET api/v2/version-group/{id or name}
example response
{
	"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/"
	}]
}
response models

VersionGroup

Name Description Data Type
id The identifier for this version group resource integer
name The name for this version group resource string
order Order for sorting. Almost by date of release, except similar versions are grouped together. integer
generation The generation this version was introduced in [NamedAPIResource (Generation)]
move_learn_methods A list of methods in which pokemon can learn moves in this version group [NamedAPIResource (MoveLearnMethod)]
names The name of this version group listed in different languages [Name]
pokedexes A list of pokedexes introduces in this version group [NamedAPIResource (Pokedex)]
regions A list of regions that can be visited in this version group [NamedAPIResource (Region)]
versions The versions this version group owns [NamedAPIResource (Version)]

Common Models

APIResource

Name Description Data Type
url The url of the referenced resource string

Description

Name Description Data Type
description The localized description for an api resource in a specific language string
language The language this name is in NamedAPIResource (Language)

Effect

Name Description Data Type
effect The localized effect text for an api resource in a specific language string
language The language this effect is in NamedAPIResource (Language)

Encounter

Name Description Data Type
min_level The lowest level the pokemon could be encountered at integer
max_level The highest level the pokemon could be encountered at integer
condition_values A list of condition values that must be in effect for this encounter to occur [NamedAPIResource (EncounterConditionValue)]
chance percent chance that this encounter will occur integer
method The method by which this encounter happens NamedAPIResource (EncounterMethod)

FlavorText

Name Description Data Type
flavor_text The localized name for an api resource in a specific language string
language The language this name is in NamedAPIResource (Language)

GenerationGameIndex

Name Description Data Type
game_index The internal id of an api resource within game data integer
generation The generation relevent to this game index NamedAPIResource (Generation)

Name

Name Description Data Type
name The localized name for an api resource in a specific language string
language The language this name is in NamedAPIResource (Language)

NamedAPIResource

Name Description Data Type
name The name of the referenced resource string
url The url of the referenced resource string

VerboseEffect

Name Description Data Type
effect The localized effect text for an api resource in a specific language string
short_effect The localized effect text in brief string
language The language this effect is in NamedAPIResource (Language)

VersionEncounterDetail

Name Description Data Type
version The game version this encounter happens in NamedAPIResource (Version)
max_chance The total percentage of all encounter potential integer
encounter_details A list of encounters and their specifics [Encounter]

VersionGameIndex

Name Description Data Type
game_index The internal id of an api resource within game data integer
version The version relevent to this game index NamedAPIResource (Version)

VersionGroupFlavorText

Name Description Data Type
text The localized name for an api resource in a specific language string
language The language this name is in NamedAPIResource (Language)
version_group The version group which uses this flavor text NamedAPIResource (VersionGroup)