List contest effects | 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 query matched against the name property; available only locally, not on pokeapi.co.

1 status code

200Returns a paginated response containing the total result count, next and previous page URLs when available, and references to contest effects.

countintegerrequired

nextstringoptional

previousstringoptional

resultsarray<object>required

Error handling

Use limit and offset as integer pagination controls. The q query performs a case-insensitive match against the name property and is available only locally, not on pokeapi.co.

import { Client } from "pokéapi";

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

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