List Pokédex records | PokéAPI unofficial

3 parameters

limitintegeroptional

The number of results to return per page.

offsetintegeroptional

The initial result index from which to return results.

qstringoptional

Case-insensitive search applied to the Pokédex name; available only in local deployments.

1 status code

200Returns a paginated response containing the total result count, links to the next and previous pages when available, and an array of Pokédex name and URL objects.

countintegerrequired

nextstringoptional

previousstringoptional

resultsarray<object>required

Error handling

limit controls the number of results per page, and offset sets the starting result index. q searches names case-insensitively and is available only in local deployments.

import { Client } from "pokéapi";

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

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