Get a contest effect | PokéAPI unofficial

1 parameter

idstringrequired

The contest effect identifier; you can provide it as a string or an integer.

1 status code

200Returns the contest effect object with its ID, appeal and jam values, effect entries, and localized flavor text entries.

idintegerrequired

appealintegerrequired

jamintegerrequired

effect_entriesarray<object>required

flavor_text_entriesarray<object>required

Error handling

The id path parameter accepts a string identifier or an integer and must identify an existing contest effect.

import { Client } from "pokéapi";

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

const result = await client.contestEffect.get({ id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "appeal": 1,
  "jam": 1,
  "effect_entries": [
    {
      "effect": "example_value",
      "language": {
        "name": "Example Name",
        "url": "https://example.com"
      }
    }
  ],
  "flavor_text_entries": [
    {
      "flavor_text": "example_value",
      "language": {
        "name": "Example Name",
        "url": "https://example.com"
      }
    }
  ]
}

Request

Response

Errors