List characteristics | PokéAPI unofficial

3 parameters

limitintegeroptional

Number of characteristic results to return per page.

offsetintegeroptional

Zero-based index of the first characteristic to return.

qstringoptional

Case-insensitive search applied to the characteristic name; available only on local instances, not on pokeapi.co.

1 status code

200Returns a paginated result object containing the total count and result entries with URLs, plus next and previous page URLs when available.

countintegerrequired

nextstringoptional

previousstringoptional

resultsarray<object>required

Error handling

limit controls the number of results and offset sets the starting index; both must be integers. q is a case-insensitive name query and is available only on local instances, not on pokeapi.co.

import { Client } from "pokéapi";

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

const result = await client.characteristic.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": [
    {
      "url": "https://example.com"
    }
  ]
}

Request

Response

Errors