From b4f5680b424dac7de6b996cf25ec10d894b3b26f Mon Sep 17 00:00:00 2001 From: Adickes Date: Tue, 8 Dec 2015 12:55:48 -0500 Subject: [PATCH] added aditional get methods for each resource and corrected a few things --- pokemon_v2/README.md | 822 +++++++++++++++++++++++++++++-------------- 1 file changed, 552 insertions(+), 270 deletions(-) diff --git a/pokemon_v2/README.md b/pokemon_v2/README.md index 68b6faae..74957dd5 100644 --- a/pokemon_v2/README.md +++ b/pokemon_v2/README.md @@ -69,13 +69,66 @@ +## 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 +```json +{ + "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](#apiresource) + + +###### example response for named resources +```json +{ + "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](#namedapiresource) + + ## Abilities -``` -api/v2/ability/{id or name} -``` Abilities provide passive effects for pokemon in battle or in the overworld. Pokemon have mutiple possible abilities but can have only one ability at a time. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Ability) for greater detail. +``` +GET api/v2/ability +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/ability/{id or name} +``` + ###### example response ```json { @@ -145,7 +198,7 @@ Name | Description | Data Type id | The identifier for this ability resource | integer name | The name for this ability resource | string is_main_series | Whether or not this ability originated in the main series of the video games | boolean -generation | The generation this ability originated in | [APIResource](#apiresource) ([Generation](#generations)) +generation | The generation this ability originated in | [NamedAPIResource](#namedapiresource) ([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)] @@ -157,15 +210,15 @@ pokemon | A list of pokemon that could potentially have this ability Name | Description | Data Type ---- | ----------- | --------- effect_entries | The previous effect of this ability listed in different languages | [Effect](#effect) -version_group | The version group in which the previous effect of this ability originated | [APIResource](#apiresource) ([VersionGroup](#versiongroups)) +version_group | The version group in which the previous effect of this ability originated | [NamedAPIResource](#namedapiresource) ([VersionGroup](#versiongroups)) #### 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)) +language | The language this name is in | [NamedAPIResource](#namedapiresource) ([Language](#languages)) +version_group | The version group that uses this flavor text | [NamedAPIResource](#namedapiresource) ([VersionGroup](#version-groups)) #### AbilityPokemon @@ -173,15 +226,20 @@ Name | Description | Data Type ---- | ----------- | --------- is_hidden | Whether or not this a hidden ability for the referenced pokemon | boolean slot | Pokemon have 3 ability 'slots' which hold references to possible abilities they could have. This is the slot of this ability for the referenced pokemon. | integer -pokemon | The pokemon this ability could belong to | [APIResource](#apiresource) ([Pokemon](#pokemon)) +pokemon | The pokemon this ability could belong to | [NamedAPIResource](#namedapiresource) ([Pokemon](#pokemon)) ## Berries -``` -api/v2/berry/{id or name} -``` Berries are small fruits that can provide HP and status condition restoration, stat enhancement, and even damage negation when eaten by pokemon. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Berry) for greater detail. +``` +GET api/v2/berry +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/berry/{id or name} +``` + ###### example response ```json @@ -231,17 +289,17 @@ natural_gift_power | The power of the move "Natural Gift" when used with this Be 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)) +firmness | The firmness of this berry, used in making Pokéblocks or Poffins | [NamedAPIResource](#namedapiresource) ([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)) +item | Berries are actually items. This is a reference to the item specific data for this berry. | [NamedAPIResource](#namedapiresource) ([Item](#items)) +natural_gift_type | The Type the move "Natural Gift" has when used with this Berry | [NamedAPIResource](#namedapiresource) ([Type](#types)) #### BerryFlavorMap Name | Description | Data Type ---- | ----------- | --------- potency | How powerful the referenced flavor is for this berry | integer -flavor | The referenced berry flavor | [APIResource](#apiresource) ([BerryFlavor](#berry-flavors)) +flavor | The referenced berry flavor | [NamedAPIResource](#namedapiresource) ([BerryFlavor](#berry-flavors)) ## Berry Firmnesses @@ -279,18 +337,21 @@ Name | Description | Data Type ---- | ----------- | --------- id | The identifier for this berry firmness resource | integer name | The name for this berry firmness resource | string -berries | A list of the berries with this firmness | [[APIResource](#apiresource) ([Berry](#berries))] +berries | A list of the berries with this firmness | [[NamedAPIResource](#namedapiresource) ([Berry](#berries))] names | The name of this berry firmness listed in different languages | [[Name](#resourcename)] ## Berry Flavors -``` -api/v2/berry-flavor/{id or name} -``` - Flavors determine whether a pokemon will benefit or suffer from eating a berry based on their [nature](#natures). Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Flavor) for greater detail. +``` +GET api/v2/berry-flavor +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/berry-flavor/{id or name} +``` ###### example response ```json @@ -328,7 +389,7 @@ 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](#flavorberrymap)] -contest_type | The contest type that correlates with this berry flavor | [APIResource](#apiresource) ([ContestType](#contest-types)) +contest_type | The contest type that correlates with this berry flavor | [NamedAPIResource](#namedapiresource) ([ContestType](#contest-types)) names | The name of this berry flavor listed in different languages | [[Name](#resourcename)] #### FlavorBerryMap @@ -336,15 +397,20 @@ names | The name of this berry flavor listed in different languages | [[N 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)) +berry | The berry with the referenced flavor | [NamedAPIResource](#namedapiresource) ([Berry](#berry)) ## Characteristics -``` -api/v2/characteristic/{id} -``` Characteristics indicate which stat contains a Pokémon's highest IV. A Pokémon's Characteristic is determined by the remainder of its highest IV divided by 5 (gene_modulo). Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Characteristic) for greater detail. +``` +GET api/v2/characteristic +``` +returns a paginated list of [APIResource](#apiresource)s +``` +GET api/v2/characteristic/{id} +``` + ###### example response ```json @@ -381,11 +447,15 @@ descriptions | The descriptions of this characteristic listed in different la ## Contest Types -``` -api/v2/contest-type/{id or name} -``` Contest types are categories judges used to weigh a pokemons condition in pokemon contests. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Contest_condition) for greater detail. +``` +GET api/v2/contest-type +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/contest-type/{id or name} +``` ###### example response ```json @@ -416,17 +486,22 @@ Name | Description | Data Type ---- | ----------- | --------- id | The identifier for this contest type resource | integer name | The name for this contest type resource | string -berry_flavor | The berry flavor that correlates with this contest type | [APIResource](#apiresource) ([BerryFlavor](#berry-flavors)) +berry_flavor | The berry flavor that correlates with this contest type | [NamedAPIResource](#namedapiresource) ([BerryFlavor](#berry-flavors)) names | The name of this contest type listed in different languages | [[Name](#resourcename)] ## Contest Effects -``` -api/v2/contest-effect/{id or name} -``` Contest effects refer to the effects of moves when used in contests. +``` +GET api/v2/contest-effect +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/contest-effect/{id or name} +``` + ###### example response ```json @@ -467,11 +542,16 @@ flavor_text_entries | The flavor text of this contest effect listed in different ## Egg Groups -``` -api/v2/egg-group/{id or name} -``` Egg Groups are categories which determine which Pokémon are able to interbreed. Pokémon may belong to either one or two Egg Groups. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Egg_Group) for greater detail. +``` +GET api/v2/egg-group +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/egg-group/{id or name} +``` + ###### example response ```json @@ -502,16 +582,21 @@ 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](#resourcename)] -pokemon_species | A list of all pokemon species that are members of this egg group | [APIResource](#apiresource) ([PokemonSpecies](#pokemon-species)) +pokemon_species | A list of all pokemon species that are members of this egg group | [NamedAPIResource](#namedapiresource) ([PokemonSpecies](#pokemon-species)) ## Encounter Methods -``` -api/v2/encounter-method/{id or name} -``` 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. +``` +GET api/v2/encounter-method +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/encounter-method/{id or name} +``` + ###### example response ```json @@ -544,11 +629,16 @@ names | The name of this encounter method listed in different languages | [[Name ## Encounter Conditions -``` -api/v2/encounter-condition/{id or name} -``` 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 [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/encounter-condition/{id or name} +``` + ###### example response ```json @@ -582,16 +672,21 @@ 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](#resourcename)] -values | A list of possible values for this encounter condition | [[APIResource](#apiresource) ([EncounterConditionValue](#encounter-condition-values))] +values | A list of possible values for this encounter condition | [[NamedAPIResource](#namedapiresource) ([EncounterConditionValue](#encounter-condition-values))] ## Encounter Condition Values -``` -api/v2/encounter-condition-value/{id or name} -``` 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 [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/encounter-condition-value/{id or name} +``` + ###### example response ```json @@ -621,17 +716,22 @@ 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 | [[APIResource](#apiresource) ([EncounterCondition](#encounter-conditions))] +condition | The condition this encounter condition value pertains to | [[NamedAPIResource](#namedapiresource) ([EncounterCondition](#encounter-conditions))] names | The name of this encounter condition value listed in different languages | [[Name](#resourcename)] ## Evolution Chains -``` -api/v2/evolution-chain/{id} -``` 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 [APIResource](#apiresource)s +``` +GET api/v2/evolution-chain/{id} +``` + ###### example response ```json @@ -687,7 +787,7 @@ Evolution chains are essentially family trees. They start with the lowest stage 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 | [APIResource](#apiresource) ([Item](#items)) +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](#namedapiresource) ([Item](#items)) 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) #### ChainLink @@ -695,7 +795,7 @@ chain | The base chain link object. Each link contains evolution det 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 | [APIResource](#apiresource) ([PokemonSpecies](#pokemon-species)) +species | The pokemon species at this point in the evolution chain | [NamedAPIResource](#namedapiresource) ([PokemonSpecies](#pokemon-species)) evolution_details | All details regarding the specific details of the referenced pokemon species evolution | [EvolutionDetail](#evolutiondetail) evolves_to | A List of chain objects. | [ChainLink](#chainlink) @@ -703,32 +803,37 @@ evolves_to | A List of chain objects. Name | Description | Data Type ---- | ----------- | --------- -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)) +item | The item required to cause evolution this into pokemon species | [NamedAPIResource](#namedapiresource) ([Item](#items)) +trigger | The type of event that triggers evolution into this pokemon species | [NamedAPIResource](#namedapiresource) ([EvolutionTrigger](#evolution-triggers)) +gender | The gender the evolving pokemon species must be in order to evolve into this pokemon species | [NamedAPIResource](#namedapiresource) ([Gender](#genders)) +held_item | The item the evolving pokemon species must be holding during the evolution trigger event to evolve into this pokemon species | [NamedAPIResource](#namedapiresource) ([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 | [NamedAPIResource](#namedapiresource) ([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 | [NamedAPIResource](#namedapiresource) ([Type](#types)) +location | The location the evolution must be triggered at. | [NamedAPIResource](#namedapiresource) ([Location](#locations)) 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 | [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)) +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](#namedapiresource) ([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 | [NamedAPIResource](#namedapiresource) ([Type](#types)) 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. | [APIResource](#apiresource) ([Pokemon Species](#pokemon-species)) +trade_species | Pokemon species for which this one must be traded. | [NamedAPIResource](#namedapiresource) ([Pokemon Species](#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 -``` -api/v2/evolution-trigger/{id or name} -``` 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. +``` +GET api/v2/evolution-trigger +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/evolution-trigger/{id or name} +``` + ###### example response ```json @@ -759,15 +864,20 @@ 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)] -pokemon_species | A list of pokemon species that result from this evolution trigger | [[APIResource](#apiresource) ([PokemonSpecies](#pokemon-species))] +pokemon_species | A list of pokemon species that result from this evolution trigger | [[NamedAPIResource](#namedapiresource) ([PokemonSpecies](#pokemon-species))] ## Generations -``` -api/v2/generation/{id or name} -``` 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 [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/generation/{id or name} +``` + ###### example response ```json @@ -814,21 +924,26 @@ 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 | [[APIResource](#apiresource) ([Ability](#abilities))] +abilities | A list of abilities that were introduced in this generation | [[NamedAPIResource](#namedapiresource) ([Ability](#abilities))] names | The name of this generation listed in different languages | [[Name](#resourcename)] -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))] +main_region | The main region travelled in this generation | [NamedAPIResource](#namedapiresource) ([Region](#regions)) +moves | A list of moves that were introduced in this generation | [[NamedAPIResource](#namedapiresource) ([Move](#moves))] +pokemon_species | A list of pokemon species that were introduced in this generation | [[NamedAPIResource](#namedapiresource) ([PokemonSpecies](#pokemon-species))] +types | A list of types that were introduced in this generation | [[NamedAPIResource](#namedapiresource) ([Type](#types))] +version_groups | A list of version groups that were introduced in this generation | [[NamedAPIResource](#namedapiresource) ([VersionGroup](#version-groups))] ## Genders -``` -api/v2/gender/{id or name} -``` 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. +``` +GET api/v2/gender +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/gender/{id or name} +``` + ###### example response ```json @@ -859,7 +974,7 @@ 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](#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))] +required_for_evolution | A list of pokemon species that required this gender in order for a pokemon to evolve into them | [[NamedAPIResource](#namedapiresource) ([PokemonSpecies](#pokemon-species))] #### PokemonSpeciesGender @@ -867,15 +982,20 @@ required_for_evolution | A list of pokemon species that required this gender in 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 | [APIResource](#apiresource) ([PokemonSpecies](#pokemon-species)) +pokemon_species | A pokemon species that can be the referenced gender | [NamedAPIResource](#namedapiresource) ([PokemonSpecies](#pokemon-species)) ## Growth Rates -``` -api/v2/growth-rate/{id or name} -``` Growth rates are the speed with which pokemon gain levels through experience. Check out [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Experience) for greater detail. +``` +GET api/v2/growth-rate +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/growth-rate/{id or name} +``` + ###### example response ```json @@ -912,7 +1032,7 @@ name | The name for this gender resource 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)] -pokemon_species | A list of pokemon species that gain levels at this growth rate | [[APIResource](#apiresource) ([PokemonSpecies](#pokemon-species))] +pokemon_species | A list of pokemon species that gain levels at this growth rate | [[NamedAPIResource](#namedapiresource) ([PokemonSpecies](#pokemon-species))] #### GrowthRateExperienceLevel @@ -923,11 +1043,16 @@ experience | The amount of experience required to reach the referenced level | i ## Items -``` -api/v2/item/{id or name} -``` 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 [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/item/{id or name} +``` + ###### example response ```json @@ -1011,22 +1136,27 @@ name | The name for this item resource 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](#item-fling-effects) -attributes | A list of attributes this item has | [[APIResource](#apiresource) ([ItemAttribute](#item-attributes))] +attributes | A list of attributes this item has | [[NamedAPIResource](#namedapiresource) ([ItemAttribute](#item-attributes))] category | The category of items this item falls into | [ItemCategory](#item-categories) effect_entries | The effect of this ability listed in different languages | [[VerboseEffect](#verboseeffect)] flavor_text_entries | The flavor text of this ability listed in different languages | [[VersionGroupFlavorText](#versiongroupflavortext)] 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)] -held_by_pokemon | A list of pokemon that might be found in the wild holding this item | [[APIResource](#apiresource) ([Pokemon](#pokemon))] +held_by_pokemon | A list of pokemon that might be found in the wild holding this item | [[NamedAPIResource](#namedapiresource) ([Pokemon](#pokemon))] baby_trigger_for | An evolution chain this item requires to produce a bay during mating | [[APIResource](#apiresource) ([EvolutionChain](#evolution-chains))] ## Item Fling Effects -``` -api/v2/item-fling-effect/{id or name} -``` The various effects of the move "Fling" when used with different items. +``` +GET api/v2/item-fling-effect +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/item-fling-effect/{id or name} +``` + ###### example response ```json @@ -1056,15 +1186,20 @@ 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)] -items | A list of items that have this fling effect | [[APIResource](#apiresource) ([Item](#items))] +items | A list of items that have this fling effect | [[NamedAPIResource](#namedapiresource) ([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". +``` +GET api/v2/item-attribute +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/item-attribute/{id or name} +``` + ###### example response ```json @@ -1106,11 +1241,16 @@ descriptions | The description of this item attribute listed in different langua ## Item Categories -``` -api/v2/item-category/{id or name} -``` Item categories determine where items will be placed in the players bag. +``` +GET api/v2/item-category +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/item-category/{id or name} +``` + ###### example response ```json @@ -1145,15 +1285,20 @@ 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](#items)] names | The name of this item category listed in different languages | [[Name](#resourcename)] -pocket | The pocket items in this category would be put in | [[APIResource](#apiresource) ([ItemPocket](#item-pockets))] +pocket | The pocket items in this category would be put in | [[NamedAPIResource](#namedapiresource) ([ItemPocket](#item-pockets))] ## Item Pockets -``` -api/v2/item-pocket/{id or name} -``` Pockets within the players bag used for storing items by category. +``` +GET api/v2/item-pocket +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/item-pocket/{id or name} +``` + ###### example response ```json @@ -1187,11 +1332,16 @@ names | The name of this item pocket listed in different languages | [ ## Languages -``` -api/v2/language/{id or name} -``` Languages for translations of api resource information. +``` +GET api/v2/language +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/language/{id or name} +``` + ###### example response ```json @@ -1226,11 +1376,16 @@ names | The name of this language listed in different languages ## Locations -``` -api/v2/location/{id or name} -``` 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 [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/location/{id or name} +``` + ###### example response ```json @@ -1270,18 +1425,23 @@ 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 | [APIResource](#apiresource) ([Region](#regions)) +region | The region this location can be found in | [NamedAPIResource](#namedapiresource) ([Region](#regions)) 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)] areas | Areas that can be found within this location | [APIResource](#apiresource) ([LocationArea](#location-areas)) ## Location Areas -``` -api/v2/location-area/{id} -``` 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 [APIResource](#apiresource)s +``` +GET api/v2/location-area/{id} +``` + ###### example response ```json @@ -1349,7 +1509,7 @@ id | The identifier for this location resource 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)] -location | The region this location can be found in | [APIResource](#apiresource) ([Region](#regions)) +location | The region this location can be found in | [NamedAPIResource](#namedapiresource) ([Region](#regions)) names | The name of this location area listed in different languages | [[Name](#resourcename)] pokemon_encounters | A list of pokemon that can be encountered in this area along with version specific details about the encounter | [[PokemonEncounter](#pokemonencounter)] @@ -1357,16 +1517,21 @@ pokemon_encounters | A list of pokemon that can be encountered in this area Name | Description | Data Type ---- | ----------- | --------- -pokemon | The pokemon being encountered | [APIResource](#apiresource) ([Pokemon](#pokemon)) +pokemon | The pokemon being encountered | [NamedAPIResource](#namedapiresource) ([Pokemon](#pokemon)) version_details | A list of versions and encounters with pokemon that might happen in the referenced location area | [[VersionEncounterDetail](#versionencounterdetail)] ## Moves -``` -api/v2/move/{id or name} -``` 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 [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/move/{id or name} +``` + ###### example response ```json @@ -1478,17 +1643,17 @@ pp | Power points. The number of times this move can be used 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)] -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)) +contest_type | The type of appeal this move gives a pokemon when used in a contest | [NamedAPIResource](#namedapiresource) ([ContestType](#contest-types)) +contest_effect | The effect the move has when used in a contest | [NamedAPIResource](#namedapiresource) ([ContestEffect](#contest-effects)) +damage_class | The type of damage the move inflicts on the target, e.g. physical | [NamedAPIResource](#namedapiresource) ([MoveDamageClass](#move-damage-classes)) 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)] -generation | The generation in which this move was introduced | [APIResource](#apiresource) ([Generation](#generations)) +generation | The generation in which this move was introduced | [NamedAPIResource](#namedapiresource) ([Generation](#generations)) meta | Meta data about this move | [MoveMetaData](#movemetadata) names | The name of this move listed in different languages | [[Name](#resourcename)] past_values | A list of move resource value changes across ersion groups of the game | [[PastMoveStatValues](#pastmovestatvalues)] stat_changes | A list of stats this moves effects and how much it effects them | [[MoveStatChange](#movestatchange)] -contest_effect | The effect the move has when used in a super contest | [APIResource](#apiresource) ([ContestEffect](#contest-effects)) +contest_effect | The effect the move has when used in a super contest | [NamedAPIResource](#namedapiresource) ([ContestEffect](#contest-effects)) target | The type of target that will recieve the effects of the attack | [MoveTarget](#move-targets) type | The elemental type of this move | [Type](#types) @@ -1503,15 +1668,15 @@ super | A detail of moves this move can be used before or after, granting addit Name | Description | Data Type ---- | ----------- | --------- -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))] +use_before | A list of moves to use before this move | [[NamedAPIResource](#namedapiresource) ([Move](#moves))] +use_after | A list of moves to use after this move | [[NamedAPIResource](#namedapiresource) ([Move](#moves))] #### MoveMetaData Name | Description | Data Type ---- | ----------- | --------- -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)) +ailment | The status ailment this move inflicts on its target | [NamedAPIResource](#namedapiresource) ([MoveAilment](#move-ailments)) +category | The category of move this move falls under, e.g. damage or ailment | [NamedAPIResource](#namedapiresource) ([Move](#moves)) 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 @@ -1528,7 +1693,7 @@ stat_chance | The likelyhood this attack will cause a stat change in the targ Name | Description | Data Type ---- | ----------- | --------- change | The amount of change | integer -stat | The stat being affected | [APIResource](#apiresource) [Stat](#stats) +stat | The stat being affected | [NamedAPIResource](#namedapiresource) [Stat](#stats) #### PastMoveStatValues @@ -1540,15 +1705,20 @@ power | The base power of this move with a value of 0 if it does not ha 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) -version group | The version group in which these move stat values were in effect | [APIResource](#apiresource) ([VersionGroup](#version-groups)) +version group | The version group in which these move stat values were in effect | [NamedAPIResource](#namedapiresource) ([VersionGroup](#version-groups)) ## Move Ailments -``` -api/v2/move-ailment/{id or name} -``` 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. +``` +GET api/v2/move-ailment +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/move-ailment/{id or name} +``` + ###### example response ```json @@ -1577,16 +1747,21 @@ 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 | [[APIResource](#apiresource) ([Move](#moves))] +moves | A list of moves that cause this ailment | [[NamedAPIResource](#namedapiresource) ([Move](#moves))] names | The name of this move ailment listed in different languages | [[Name](#resourcename)] ## Move Battle Styles -``` -api/v2/move-battle-style/{id or name} -``` Styles of moves when used in the Battle Palace. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Battle_Frontier_(Generation_III)) for greater detail. +``` +GET api/v2/move-battle-style +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/move-battle-style/{id or name} +``` + ###### example response ```json @@ -1615,11 +1790,16 @@ names | The name of this move battle style listed in different languages | [[Nam ## Move Categories -``` -api/v2/move-category/{id or name} -``` Very general categories that loosely group move effects. +``` +GET api/v2/move-category +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/move-category/{id or name} +``` + ###### example response ```json @@ -1648,16 +1828,21 @@ 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 | [[APIResource](#apiresource) ([Move](#moves))] +moves | A list of moves that fall into this category | [[NamedAPIResource](#namedapiresource) ([Move](#moves))] descriptions | The description of this move ailment listed in different languages | [[Description](#description)] ## Move Damage Classes -``` -api/v2/move-damage-class/{id or name} -``` Damage classes moves can have, e.g. physical, special, or non-damaging. +``` +GET api/v2/move-damage-class +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/move-damage-class/{id or name} +``` + ###### example response ```json @@ -1687,16 +1872,21 @@ 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)] -moves | A list of moves that fall into this damage class | [[APIResource](#apiresource) ([Move](#moves))] +moves | A list of moves that fall into this damage class | [[NamedAPIResource](#namedapiresource) ([Move](#moves))] names | The name of this move damage class listed in different languages | [[Name](#resourcename)] ## Move Learn Methods -``` -api/v2/move-learn-method/{id or name} -``` Methods by which pokemon can learn moves. +``` +GET api/v2/move-learn-method +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/move-learn-method/{id or name} +``` + ###### example response ```json @@ -1734,15 +1924,20 @@ id | The identifier for this move learn method resource 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)] -version_groups | A list of version groups where moves can be learned through this method | [[APIResource](#apiresource) ([VersionGroup](#version-groups))] +version_groups | A list of version groups where moves can be learned through this method | [[NamedAPIResource](#namedapiresource) ([VersionGroup](#version-groups))] ## Move Targets -``` -api/v2/move-target/{id or name} -``` 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 [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/move-target/{id or name} +``` + ###### example response ```json @@ -1779,16 +1974,21 @@ 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)] -moves | A list of moves that that are directed at this target | [[APIResource](#apiresource) ([Move](#moves))] +moves | A list of moves that that are directed at this target | [[NamedAPIResource](#namedapiresource) ([Move](#moves))] names | The name of this move target listed in different languages | [[Name](#resourcename)] ## Natures -``` -api/v2/nature/{id or name} -``` Natures influence how a pokemon's stats grow. See [Bulbapedia](http://bulbapedia.bulbagarden.net/wiki/Nature) for greater detail. +``` +GET api/v2/nature +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/nature/{id or name} +``` + ###### example response ```json @@ -1844,10 +2044,10 @@ 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 | [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)) +decreased_stat | The stat decreased by 10% in pokemon with this nature | [NamedAPIResource](#namedapiresource) ([Stat](#stats)) +increased_stat | The stat increased by 10% in pokemon with this nature | [NamedAPIResource](#namedapiresource) ([Stat](#stats)) +hates_flavor | The flavor hated by pokemon with this nature | [NamedAPIResource](#namedapiresource) ([BerryFlavor](#berry-flavors)) +likes_flavor | The flavor liked by pokemon with this nature | [NamedAPIResource](#namedapiresource) ([BerryFlavor](#berry-flavors)) 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)] @@ -1857,7 +2057,7 @@ names | The name of this nature listed in different lang Name | Description | Data Type ---- | ----------- | --------- change | The amount of change | integer -stat | The stat being affected | [APIResource](#apiresource) ([PokeathlonStat](#pokeathlon-stats)) +stat | The stat being affected | [NamedAPIResource](#namedapiresource) ([PokeathlonStat](#pokeathlon-stats)) #### MoveBattleStylePreference @@ -1865,12 +2065,17 @@ 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 | [APIResource](#apiresource) ([MoveBattleStyle](#move-battle-styles)) +move_battle_style | The move battle style | [NamedAPIResource](#namedapiresource) ([MoveBattleStyle](#move-battle-styles)) ## Pal Park Areas +Areas used for grouping pokemon encounters in Pal Park. They're like habitats that are specific to Pal Park. ``` -api/v2/pal-park-area/{id or name} +GET api/v2/pal-park-area +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/pal-park-area/{id or name} ``` ###### example response @@ -1914,15 +2119,20 @@ 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)) +pokemon_species | The pokemon species being encountered | [NamedAPIResource](#namedapiresource) ([PokemonSpecies](#pokemonspecies)) ## Pokedexes -``` -api/v2/pokedex/{id or name} -``` 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. +``` +GET api/v2/pokedex +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/pokedex/{id or name} +``` + ###### example response ```json @@ -1974,23 +2184,28 @@ is_main_series | Whether or not this pokedex originated in the main series of t 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)] -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)) +region | The region this pokedex catalogues pokemon for | [NamedAPIResource](#namedapiresource) ([Region](#regions)) +version_groups | A list of version groups this pokedex is relevent to | [NamedAPIResource](#namedapiresource) ([VersionGroup](#version-groups)) #### 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 | [APIResource](#apiresource) ([PokemonSpecies](#pokemon-species)) +pokemon_species | The pokemon species being encountered | [NamedAPIResource](#namedapiresource) ([PokemonSpecies](#pokemon-species)) ## Pokemon -``` -api/v2/pokemon/{id or name} -``` 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. +``` +GET api/v2/pokemon +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/pokemon/{id or name} +``` + ###### example response ```json @@ -2113,13 +2328,13 @@ is_default | Set for exactly one pokemon used as the default for e 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))] +forms | A list of forms this pokemon can take on | [[NamedAPIResource](#namedapiresource) ([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))] +held_items | A list of items this pokemon may be holding when encountered | [[NamedAPIResource](#namedapiresource) ([Item](#items))] 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)) -stats | A list of base stat values for this pokemon | [[APIResource](#apiresource) ([Stat](#stats))] +moves | A list of moves along with learn methods and level details pertaining to specific version groups | [NamedAPIResource](#namedapiresource) (Move](#moves)) +species | The species this pokemon belongs to | [NamedAPIResource](#namedapiresource) (PokemonSpecies](#pokemon-species)) +stats | A list of base stat values for this pokemon | [[NamedAPIResource](#namedapiresource) ([Stat](#stats))] types | A list of details showing types this pokemon has | [[PokemonType](#pokemontype)] #### PokemonAbility @@ -2128,7 +2343,7 @@ 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)) +ability | The ability the pokemon may have | [NamedAPIResource](#namedapiresource) ([Ability](#abilities)) #### PokemonType @@ -2141,16 +2356,21 @@ type | The type the referenced pokemon has | string Name | Description | Data Type ---- | ----------- | --------- -location_area | The location area the referenced pokemon can be encountered in | [APIResource](#apiresource) ([Pokemon](#pokemon)) +location_area | The location area the referenced pokemon can be encountered in | [APIResource](#apiresource) ([LocationArea](#location-areas)) version_details | A list of versions and encounters with the referenced pokemon that might happen | [[VersionEncounterDetail](#versionencounterdetail)] ## Pokemon Colors -``` -api/v2/pokemon-color/{id or name} -``` 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 [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/pokemon-color/{id or name} +``` + ###### example response ```json @@ -2180,15 +2400,20 @@ 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)] -pokemon_species | A list of the pokemon species that have this color | [[APIResource](#apiresource) ([PokemonSpecies](#pokemon-species))] +pokemon_species | A list of the pokemon species that have this color | [[NamedAPIResource](#namedapiresource) ([PokemonSpecies](#pokemon-species))] ## Pokemon Forms -``` -api/v2/pokemon-form/{id or name} -``` 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 [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/pokemon-form/{id or name} +``` + ###### example response ```json @@ -2226,16 +2451,21 @@ is_default | True for exactly one form used as the default for each pokemon 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)) -version_group | The version group this pokemon form was introduced in | [APIResource](#apiresource) ([VersionGroup](#version-groups)) +pokemon | The pokemon that can take on this form | [NamedAPIResource](#namedapiresource) ([Pokemon](#pokemon)) +version_group | The version group this pokemon form was introduced in | [NamedAPIResource](#namedapiresource) ([VersionGroup](#version-groups)) ## Pokemon Habitats -``` -api/v2/pokemon-habitat/{id or name} -``` 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 [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/pokemon-habitat/{id or name} +``` + ###### example response ```json @@ -2251,15 +2481,20 @@ 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)] -pokemon_species | A list of the pokemon species that can be found in this habitat | [[APIResource](#apiresource) ([PokemonSpecies](#pokemon-species))] +pokemon_species | A list of the pokemon species that can be found in this habitat | [[NamedAPIResource](#namedapiresource) ([PokemonSpecies](#pokemon-species))] ## Pokemon Shapes -``` -api/v2/pokemon-shape/{id or name} -``` Shapes used for sorting pokemon in a pokedex. +``` +GET api/v2/pokemon-shape +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/pokemon-shape/{id or name} +``` + ###### example response ```json @@ -2276,22 +2511,27 @@ id | The identifier for this pokemon shape resource 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)] -pokemon_species | A list of the pokemon species that have this shape | [[APIResource](#apiresource) ([PokemonSpecies](#pokemon-species))] +pokemon_species | A list of the pokemon species that have this shape | [[NamedAPIResource](#namedapiresource) ([PokemonSpecies](#pokemon-species))] #### 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)) +language | The language this "scientific" name is in | [NamedAPIResource](#namedapiresource) ([Language](#languages)) ## Pokemon Species -``` -api/v2/pokemon-species/{id or name} -``` 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 [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/pokemon-species/{id or name} +``` + ###### example response ```json @@ -2388,34 +2628,34 @@ is_baby | Whether or not this is a baby pokemon hatch_counter | Initial hatch counter: one must walk 255 × (hatch_counter + 1) steps before this Pokémon's egg hatches, unless utilizing bonuses like Flame Body's | integer has_gender_differences | Whether or not this pokemon can have different genders | boolean forms_switchable | Whether or not this pokemon has multiple forms and can switch between them | boolean -growth_rate | The rate at which this pokemon species gains levels | [APIResource](#apiresource) ([GrowthRate](#growth-rates)) +growth_rate | The rate at which this pokemon species gains levels | [NamedAPIResource](#namedapiresource) ([GrowthRate](#growth-rates)) pokedex_numbers | A list of pokedexes and the indexes reserved within them for this pokemon species | [[PokemonSpeciesDexEntry](#pokemonspeciesdexentry)] -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)) +egg_groups | A list of egg groups this pokemon species is a member of | [[NamedAPIResource](#namedapiresource) ([EggGroup](#egg-groups))] +color | The color of this pokemon for gimmicky pokedex search | [[NamedAPIResource](#namedapiresource) ([PokemonColor](#pokemon-colors))] +shape | The shape of this pokemon for gimmicky pokedex search | [[NamedAPIResource](#namedapiresource) ([PokemonShape](#pokemon-shapes))] +evolves_from_species | The pokemon species that evolves into this pokemon_species | [NamedAPIResource](#namedapiresource) ([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)) -generation | The generation this pokemon species was introduced in | [APIResource](#apiresource) ([Generation](#generations)) +habitat | The habitat this pokemon species can be encountered in | [NamedAPIResource](#namedapiresource) ([PokemonHabitat](#pokemon-habitats)) +generation | The generation this pokemon species was introduced in | [NamedAPIResource](#namedapiresource) ([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)] form_descriptions | Descriptions of different forms pokemon take on within the pokemon species | [[Description](#description)] 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))] +varieties | A list of the pokemon that exist within this pokemon species | [[NamedAPIResource](#namedapiresource) ([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)) +language | The language this genus is in | [NamedAPIResource](#namedapiresource) ([Language](#languages)) #### PokemonSpeciesDexEntry Name | Description | Data Type ---- | ----------- | --------- entry_number | The index number within the pokedex | integer -name | The pokdex the referenced pokemon species can be found in | [APIResource](#apiresource) ([Pokedex](#pokedexes)) +name | The pokdex the referenced pokemon species can be found in | [NamedAPIResource](#namedapiresource) ([Pokedex](#pokedexes)) #### PalParkEncounterArea @@ -2423,15 +2663,20 @@ Name | Description | Data Type ---- | ----------- | --------- base_score | The base score given to the player when the referenced pokemon is caught during a pal park run | integer rate | The base rate for encountering the referenced pokemon in this pal park area | integer -area | The pal park area where this encounter happens | [APIResource](#apiresource) ([PalParkArea](#pal-park-areas)) +area | The pal park area where this encounter happens | [NamedAPIResource](#namedapiresource) ([PalParkArea](#pal-park-areas)) ## Pokeathlon Stats -``` -api/v2/pokeathlon-stat/{id or name} -``` 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. +``` +GET api/v2/pokeathlon-stat +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/pokeathlon-stat/{id or name} +``` + ###### example response ```json @@ -2487,15 +2732,20 @@ decrease | A list of natures and how they change the referenced pokeathlon stat 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)) +nature | The nature causing the change | [NamedAPIResource](#namedapiresource) ([Nature](#natures)) ## Regions -``` -api/v2/region/{id or name} -``` 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 [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/region/{id or name} +``` + ###### example response ```json @@ -2536,19 +2786,24 @@ 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)) +locations | A list of locations that can be found in this region | [NamedAPIResource](#namedapiresource) ([Location](#locations)) +main_generation | The generation this region was introduced in | [NamedAPIResource](#namedapiresource) ([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)) -version_groups | A list of version groups where this region can be visited | [APIResource](#apiresource) ([VersionGroup](#version-groups)) +pokedexes | A list of pokedexes that catalogue pokemon in this region | [NamedAPIResource](#namedapiresource) ([Pokedex](#pokedexes)) +version_groups | A list of version groups where this region can be visited | [NamedAPIResource](#namedapiresource) ([VersionGroup](#version-groups)) ## Stats -``` -api/v2/stat/{id or name} -``` 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 [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/stat/{id or name} +``` + ###### example response ```json @@ -2613,7 +2868,7 @@ is_battle_only | Whether this stat only exists within a battle 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))] -move_damage_class | The class of damage this stat is directly related to | [APIResource](#apiresource) ([MoveDamageClass](#move-damage-classes)) +move_damage_class | The class of damage this stat is directly related to | [NamedAPIResource](#namedapiresource) ([MoveDamageClass](#move-damage-classes)) names | The name of this region listed in different languages | [[Name](#resourcename)] #### MoveStatAffectSets @@ -2628,7 +2883,7 @@ decrease | A list of moves and how they change the referenced stat | [[MoveStatA 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)) +move | The move causing the change | [NamedAPIResource](#namedapiresource) ([Move](#moves)) #### NatureStatAffectSets @@ -2642,15 +2897,20 @@ decrease | A list of nature sand how they change the referenced stat | [[NatureS 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)) +nature | The nature causing the change | [NamedAPIResource](#namedapiresource) ([Nature](#natures)) ## Super Contest Effects -``` -api/v2/super-contest-effect/{id or name} -``` 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 [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/super-contest-effect/{id or name} +``` + ###### example response ```json @@ -2680,15 +2940,20 @@ 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))] +moves | A list of moves that have the effect when used in super contests | [[NamedAPIResource](#namedapiresource) ([Move](#moves))] ## Types -``` -api/v2/types/{id or name} -``` 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 [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/type/{id or name} +``` + ###### example response ```json @@ -2767,36 +3032,41 @@ id | The identifier for this type resource 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)] -generation | The generation this type was introduced in | [APIResource](#apiresource) ([Generation](#generations)) -move_damage_class | The class of damage inflicted by this type | [APIResource](#apiresource) ([MoveDamageClass](#move-damage-classes)) +generation | The generation this type was introduced in | [NamedAPIResource](#namedapiresource) ([Generation](#generations)) +move_damage_class | The class of damage inflicted by this type | [NamedAPIResource](#namedapiresource) ([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))] +moves | A list of moves that have this type | [[NamedAPIResource](#namedapiresource) ([Move](#moves))] #### TypePokemon Name | Description | Data Type ---- | ----------- | --------- slot | The order the pokemons types are listed in | integer -pokemon | The pokemon that has the referenced type | [APIResource](#apiresource) ([Pokemon](#pokemon)) +pokemon | The pokemon that has the referenced type | [NamedAPIResource](#namedapiresource) ([Pokemon](#pokemon)) #### 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))] +no_damage_to | A list of types this type has no effect on | [[NamedAPIResource](#namedapiresource) ([Type](#types))] +half_damage_to | A list of types this type is not very effect against | [[NamedAPIResource](#namedapiresource) ([Type](#types))] +double_damage_to | A list of types this type is very effect against | [[NamedAPIResource](#namedapiresource) ([Type](#types))] +no_damage_from | A list of types that have no effect on this type | [[NamedAPIResource](#namedapiresource) ([Type](#types))] +half_damage_from | A list of types that are not very effective against this type | [[NamedAPIResource](#namedapiresource) ([Type](#types))] +double_damage_from | A list of types that are very effective against this type | [[NamedAPIResource](#namedapiresource) ([Type](#types))] ## Versions -``` -api/v2/version/{id or name} -``` Versions of the games, e.g., Red, Blue or Yellow. +``` +GET api/v2/version +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/version/{id or name} +``` + ###### example response ```json @@ -2827,15 +3097,20 @@ 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)] -version_group | The version group this version belongs to | [[APIResource](#apiresource) ([VersionGroup](#version-groups))] +version_group | The version group this version belongs to | [[NamedAPIResource](#namedapiresource) ([VersionGroup](#version-groups))] ## Version Groups -``` -api/v2/version-group/{id or name} -``` Version groups categorize highly similar versions of the games. +``` +GET api/v2/version-group +``` +returns a paginated list of [NamedAPIResource](#namedapiresource)s +``` +GET api/v2/version-group/{id or name} +``` + ###### example response ```json @@ -2875,12 +3150,12 @@ 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))] -move_learn_methods | A list of methods in which pokemon can learn moves in this version group | [[APIResource](#apiresource) ([MoveLearnMethod](#move-learn-methods))] +generation | The generation this version was introduced in | [[NamedAPIResource](#namedapiresource) ([Generation](#generations))] +move_learn_methods | A list of methods in which pokemon can learn moves in this version group | [[NamedAPIResource](#namedapiresource) ([MoveLearnMethod](#move-learn-methods))] 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))] +pokedexes | A list of pokedexes introduces in this version group | [[NamedAPIResource](#namedapiresource) ([Pokedex](#pokedexes))] +regions | A list of regions that can be visited in this version group | [[NamedAPIResource](#namedapiresource) ([Region](#regions))] +versions | The versions this version group owns | [[NamedAPIResource](#namedapiresource) ([Version](#versions))] @@ -2890,7 +3165,6 @@ versions | The versions this version group owns Name | Description | Data Type ---- | ----------- | --------- -name | The name of the referenced resource | string url | The url of the referenced resource | string @@ -2899,7 +3173,7 @@ url | The url of the referenced resource | string Name | Description | Data Type ---- | ----------- | --------- description | The localized description for an api resource in a specific language | string -language | The language this name is in | [APIResource](#apiresource) ([Language](#languages)) +language | The language this name is in | [NamedAPIResource](#namedapiresource) ([Language](#languages)) #### Effect @@ -2907,7 +3181,7 @@ language | The language this name is in Name | Description | Data Type ---- | ----------- | --------- effect | The localized effect text for an api resource in a specific language | string -language | The language this effect is in | [APIResource](#apiresource) ([Language](#language)) +language | The language this effect is in | [NamedAPIResource](#namedapiresource) ([Language](#language)) #### Encounter @@ -2916,9 +3190,9 @@ Name | Description | Data Type ---- | ----------- | --------- min_level | The lowest level the pokemon could be encountered at | integer max_level | The highest level the pokemon could be encountered at | integer -condition_values | A list of condition values that must be in effect for this encounter to occur | [[APIResource](#apiresource) ([EncounterConditionValue](#encounter-condition-values))] +condition_values | A list of condition values that must be in effect for this encounter to occur | [[NamedAPIResource](#namedapiresource) ([EncounterConditionValue](#encounter-condition-values))] chance | percent chance that this encounter will occur | integer -method | The method by which this encounter happens | [APIResource](#apiresource) ([EncounterMethod](#encounter-methods)) +method | The method by which this encounter happens | [NamedAPIResource](#namedapiresource) ([EncounterMethod](#encounter-methods)) #### FlavorText @@ -2926,7 +3200,7 @@ method | The method by which this encounter happens 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)) +language | The language this name is in | [NamedAPIResource](#namedapiresource) ([Language](#languages)) #### GenerationGameIndex @@ -2934,7 +3208,7 @@ language | The language this name is in | [A Name | Description | Data Type ---- | ----------- | --------- game_index | The internal id of an api resource within game data | integer -generation | The generation relevent to this game index | [APIResource](#apiresource) ([Generation](#generations)) +generation | The generation relevent to this game index | [NamedAPIResource](#namedapiresource) ([Generation](#generations)) #### Name @@ -2942,7 +3216,15 @@ generation | The generation relevent to this game index | [APIResource] Name | Description | Data Type ---- | ----------- | --------- name | The localized name for an api resource in a specific language | string -language | The language this name is in | [APIResource](#apiresource) ([Language](#languages)) +language | The language this name is in | [NamedAPIResource](#namedapiresource) ([Language](#languages)) + + +#### NamedAPIResource + +Name | Description | Data Type +---- | ----------- | --------- +name | The name of the referenced resource | string +url | The url of the referenced resource | string #### VerboseEffect @@ -2951,14 +3233,14 @@ Name | Description | Data Type ---- | ----------- | --------- effect | The localized effect text for an api resource in a specific language | string short_effect | The localized effect text in brief | string -language | The language this effect is in | [APIResource](#apiresource) ([Language](#languages)) +language | The language this effect is in | [NamedAPIResource](#namedapiresource) ([Language](#languages)) #### VersionEncounterDetail Name | Description | Data Type ---- | ----------- | --------- -version | The game version this encounter happens in | [APIResource](#apiresource) ([Version](#versions)) +version | The game version this encounter happens in | [NamedAPIResource](#namedapiresource) ([Version](#versions)) max_chance | The total percentage of all encounter potential | integer encounter_details | A list of encounters and their specifics | [[Encounter](#encounters)] @@ -2968,7 +3250,7 @@ encounter_details | A list of encounters and their specifics | [[Encounte Name | Description | Data Type ---- | ----------- | --------- game_index | The internal id of an api resource within game data | integer -version | The version relevent to this game index | [APIResource](#apiresource) ([Version](#versions)) +version | The version relevent to this game index | [NamedAPIResource](#namedapiresource) ([Version](#versions)) #### VersionGroupFlavorText @@ -2976,7 +3258,7 @@ version | The version relevent to this game index | [APIResource] Name | Description | Data Type ---- | ----------- | --------- 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 which uses this flavor text | [APIResource](#apiresource) ([VersionGroup](#version-groups)) +language | The language this name is in | [NamedAPIResource](#namedapiresource) ([Language](#languages)) +version_group | The version group which uses this flavor text | [NamedAPIResource](#namedapiresource) ([VersionGroup](#version-groups))