List generations | PokéAPI unofficial

3 parameters

limitintegeroptional

The number of results to return per page.

offsetintegeroptional

The index of the first result to return.

qstringoptional

A case-insensitive search applied to the name property; available only on local deployments.

1 status code

200Returns the total result count, an array of generation references, and next and previous page URLs when available.

countintegerrequired

nextstringoptional

previousstringoptional

resultsarray<object>required

Error handling

limit controls the number of results per page, and offset sets the starting index. Use q to filter by name with a case-insensitive search; this parameter is available only on local deployments.

import { Client } from "pokéapi";

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

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