Locations
Location
Locations that can be visited within the games. Locations make up sizable portions of regions, like cities or routes.
| Property | Type | Required | Description |
|---|
id | number | Yes | The identifier for this resource |
name | string | Yes | The name for this resource |
names | Array<Name> | Yes | The name of this resource listed in different languages |
region | NamedAPIResource or null | Yes | The region this location can be found in |
games_indices | Array<GenerationGameIndex> | Yes | A list of game indices relevent to this location by generation |
areas | Array<NamedAPIResource> | Yes | Areas that can be found within this location |
LocationArea
Location areas are sections of areas, such as floors in a building or cave. Each area has its own set of possible Pokémon encounters.
| Property | Type | Required | Description |
|---|
id | number | Yes | The identifier for this resource |
name | string | Yes | The name for this resource |
names | Array<Name> | Yes | The name of this resource listed in different languages |
location | NamedAPIResource | Yes | The region this location area can be found in. |
encounter_method_rates | Array<EncounterMethodRate> | Yes | A list of methods in which Pokémon may be encountered in this area and how likely the method will occur depending on the version of the game |
pokemon_encounters | Array<PokemonEncounter> | Yes | A list of Pokémon that can be encountered in this area along with version specific details about the encounter |
EncounterMethodRate
| Property | Type | Required | Description |
|---|
encounter_method | NamedAPIResource | Yes | The method in which Pokémon may be encountered in an area |
version_details | EncounterVersionDetail | Yes | The chance of the encounter to occur on a version of the game |
EncounterVersionDetail
| Property | Type | Required | Description |
|---|
rate | number | Yes | The method in which Pokémon may be encountered in an area |
version | NamedAPIResource | Yes | The chance of the encounter to occur on a version of the game |
PokemonEncounter
| Property | Type | Required | Description |
|---|
pokemon | NamedAPIResource | Yes | The Pokémon being encountered |
version_details | VersionEncounterDetail | Yes | A list of versions and encounters with Pokémon that might happen in the referenced location area |
PalParkArea
Areas used for grouping Pokémon encounters in Pal Park. They're like habitats that are specific to Pal Park.
| Property | Type | Required | Description |
|---|
id | number | Yes | The identifier for this resource |
name | string | Yes | The name for this resource |
names | Array<Name> | Yes | The name of this resource listed in different languages |
pokemon_encounters | PalParkEncounterSpecie | Yes | A list of Pokémon encountered in this pal park area along with details. |
PalParkEncounterSpecie
| Property | Type | Required | Description |
|---|
base_score | number | Yes | The base score given to the player when this Pokémon is caught during a pal park run |
rate | number | Yes | The base rate for encountering this Pokémon in this pal park area |
pokemon_species | NamedAPIResource | Yes | The Pokémon species being encountered |
Region
A region is an organized area of the Pokémon world. Most often, the main difference between regions is the species of Pokémon that can be encountered within them.
| Property | Type | Required | Description |
|---|
id | number | Yes | The identifier for this resource |
name | string | Yes | The name for this resource |
names | Array<Name> | Yes | The name of this resource listed in different languages |
main_generation | NamedAPIResource | Yes | The generation this region was introduced in |
locations | Array<NamedAPIResource> | Yes | A list of locations that can be found in this region |
pokedexes | Array<NamedAPIResource> | Yes | A list of pokédexes that catalogue Pokémon in this region |
version_groups | Array<NamedAPIResource> | Yes | A list of version groups where this region can be visited |