Get a location | PokéAPI unofficial

1 parameter

idstringrequired

The identifier of the location to retrieve; this value can be a string or an integer.

1 status code

200Returns the location object, including its name, region, localized names, game indices, and areas.

idintegerrequired

namestringrequired

regionobjectrequired

namesarray<object>required

game_indicesarray<object>required

areasarray<object>required

Error handling

The id path parameter can be a string or an integer and must identify the location to retrieve.

import { Client } from "pokéapi";

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

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

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Example Name",
  "region": {
    "name": "Example Name",
    "url": "https://example.com"
  },
  "names": [
    {
      "name": "Example Name",
      "language": {
        "name": "Example Name",
        "url": "https://example.com"
      }
    }
  ],
  "game_indices": [
    {
      "game_index": 1,
      "generation": {
        "name": "Example Name",
        "url": "https://example.com"
      }
    }
  ],
  "areas": [
    {
      "name": "Example Name",
      "url": "https://example.com"
    }
  ]
}

Request

Response

Errors