List regions | PokéAPI unofficial

3 parameters

limitintegeroptional

Number of regions to return per page.

offsetintegeroptional

Index of the first region to return.

qstringoptional

Case-insensitive filter applied to region names; available only on local installations.

1 status code

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

countintegerrequired

nextstringoptional

previousstringoptional

resultsarray<object>required

Error handling

limit and offset are integer query parameters, and q is a string query applied case-insensitively to region names. The q filter is available only on local installations.

import { Client } from "pokéapi";

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

const result = await client.region.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