TypeScript SDK for pokeapi.co API

GraphQL client for the
pokeapi.co API

All the Pokémon data you'll ever need in one place.

This SDK was created from the pokeapi.co GraphQL API with Genql.

This library is fully type safe and thanks to TypeScript auto completion you can discover fields and methods very easily.

How to install

Use a package manager to install the API client

bash
npm install @genql/pokeapi

Using the client

Use a package manager to install the API client

typescript
import { createClient } from '@genql/pokeapi'
const client = createClient()

Passing headers

You can use the headers options to pass credentials or other headers

typescript
import { createClient } from '@genql/pokeapi'
const client = createClient({
    headers: {
        Authorization: `Bearer ${Token}`
    }
})

Example queries

This SDK is generated from the pokeapi.co GraphQL API so the client has a structure similar to the one used by GraphQL queries.

To fetch fields you need to explicitly pass field: true, you can also pass __args to fetch all scalar fields on a type.

Notice that to pass arguments you can use __args

typescript
import { createClient } from '@genql/pokeapi'
const client = createClient()


// query variables
let distinct_on
let limit = 3

client
  .query({
    pokemon_v2_ability: {
      __args: {
        distinct_on: distinct_on,
        limit: limit,
      },
      generation_id: true,
      id: true,
      is_main_series: true,
    },
  })
  .then((x) => console.log(JSON.stringify(x, null, 4)))



// query variables
let columns
let distinct = false
let distinct_on
let limit = 3

client
  .query({
    pokemon_v2_ability_aggregate: {
      __args: {
        distinct_on: distinct_on,
        limit: limit,
      },
      aggregate: {
        count: {
          __args: {
            columns: columns,
            distinct: distinct,
          },
        },
      },
      nodes: {
        generation_id: true,
        id: true,
        is_main_series: true,
      },
    },
  })
  .then((x) => console.log(JSON.stringify(x, null, 4)))

More usage examples

This SDK was created using Genql so you can find more usage examples in the main Genql website and docs

Other API clients

sourcegraph.com SDK opencollective.com SDK See all SDK available