Get a location area | PokéAPI unofficial

1 parameter

idintegerrequired

The unique integer identifier of the location area to retrieve.

1 status code

200Returns the location area object, including its name, location, game index, encounter method rates, and Pokémon encounters.

idintegerrequired

namestringrequired

game_indexintegerrequired

encounter_method_ratesarray<object>required

locationobjectrequired

namesarray<object>required

pokemon_encountersarray<object>required

Error handling

The id path parameter must be an integer identifying the location area to retrieve.

import { Client } from "pokéapi";

const client = new Client({
  baseUrl: "https://pokeapi.co",
});

const result = await client.locationArea.get({ id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Example Name",
  "game_index": 1,
  "encounter_method_rates": [
    {
      "encounter_method": {
        "name": "Example Name",
        "url": "https://example.com"
      },
      "version_details": [
        {
          "rate": 1,
          "version": {
            "name": "Example Name",
            "url": "https://example.com"
          }
        }
      ]
    }
  ],
  "location": {
    "name": "Example Name",
    "url": "https://example.com"
  },
  "names": [
    {
      "name": "Example Name",
      "language": {
        "name": "Example Name",
        "url": "https://example.com"
      }
    }
  ],
  "pokemon_encounters": [
    {
      "pokemon": {
        "name": "Example Name",
        "url": "https://example.com"
      },
      "version_details": [
        {
          "version": {
            "name": "Example Name",
            "url": "https://example.com"
          },
          "max_chance": 1,
          "encounter_details": [
            {
              "min_level": null,
              "max_level": null,
              "chance": null,
              "method": null,
              "condition_values": null,
              "pokemon_details": null
            }
          ]
        }
      ]
    }
  ]
}

Request

Response

Errors