List locations | PokéAPI unofficial

3 parameters

limitintegeroptional

Number of results to return per page; supply an integer.

offsetintegeroptional

Index of the first result to return; supply an integer.

qstringoptional

Case-insensitive filter applied to the name; available only on local deployments.

1 status code

200Returns a paginated response with the total result count, links to the next and previous pages when available, and an array of location references.

countintegerrequired

nextstringoptional

previousstringoptional

resultsarray<object>required

Error handling

Use integer values for limit and offset to control the number of results and the starting index. q searches the name case-insensitively and is available only on local deployments.

import { Client } from "pokéapi";

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

const result = await client.location.list({
  limit: 20,
  offset: 0,
  q: "keyword",
});

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "name": "Example Name",
      "url": "https://example.com"
    }
  ]
}

Request

Response

Errors