npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

pokeapi-client

v2.0.0

Published

All the Pokémon data you'll ever need in one place, easily accessible through a modern free open-source RESTful API. ## What is this? This is a full RESTful API linked to an extensive database detailing everything about the Pokémon main game series. We

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

oapicfoapicf

Keywords

Readme

pokeapi-client

PokeapiClient - JavaScript client for pokeapi-client All the Pokémon data you'll ever need in one place, easily accessible through a modern free open-source RESTful API.

What is this?

This is a full RESTful API linked to an extensive database detailing everything about the Pokémon main game series.

We've covered everything from Pokémon to Berry Flavors.

Where do I start?

We have awesome documentation on how to use this API. It takes minutes to get started.

This API will always be publicly available and will never require any extensive setup process to consume.

Created by [Paul Hallett(]https://github.com/phalt) and other PokéAPI contributors* around the world. Pokémon and Pokémon character names are trademarks of Nintendo.

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: 2.7.0
  • Package version: 2.0.0
  • Generator version: 7.18.0
  • Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://github.com/oapicf/pokeapi-clients

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install pokeapi-client --save

Finally, you need to build the module:

npm run build
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your pokeapi-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/oapicf/pokeapi-clients then install it via:

    npm install oapicf/pokeapi-clients --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var PokeapiClient = require('pokeapi-client');

var defaultClient = PokeapiClient.ApiClient.instance;
// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'
// Configure API key authorization: cookieAuth
var cookieAuth = defaultClient.authentications['cookieAuth'];
cookieAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//cookieAuth.apiKeyPrefix['sessionid'] = "Token"

var api = new PokeapiClient.BerriesApi()
var opts = {
  'limit': 56, // {Number} Number of results to return per page.
  'offset': 56, // {Number} The initial index from which to return the results.
  'q': "q_example" // {String} > Only available locally and not at [pokeapi.co](https://pokeapi.co/docs/v2) Case-insensitive query applied on the `name` property. 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.berryFirmnessList(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://pokeapi.co

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- PokeapiClient.BerriesApi | berryFirmnessList | GET /api/v2/berry-firmness/ | List berry firmness PokeapiClient.BerriesApi | berryFirmnessRetrieve | GET /api/v2/berry-firmness/{id}/ | Get berry by firmness PokeapiClient.BerriesApi | berryFlavorList | GET /api/v2/berry-flavor/ | List berry flavors PokeapiClient.BerriesApi | berryFlavorRetrieve | GET /api/v2/berry-flavor/{id}/ | Get berries by flavor PokeapiClient.BerriesApi | berryList | GET /api/v2/berry/ | List berries PokeapiClient.BerriesApi | berryRetrieve | GET /api/v2/berry/{id}/ | Get a berry PokeapiClient.ContestsApi | contestEffectList | GET /api/v2/contest-effect/ | List contest effects PokeapiClient.ContestsApi | contestEffectRetrieve | GET /api/v2/contest-effect/{id}/ | Get contest effect PokeapiClient.ContestsApi | contestTypeList | GET /api/v2/contest-type/ | List contest types PokeapiClient.ContestsApi | contestTypeRetrieve | GET /api/v2/contest-type/{id}/ | Get contest type PokeapiClient.ContestsApi | superContestEffectList | GET /api/v2/super-contest-effect/ | List super contest effects PokeapiClient.ContestsApi | superContestEffectRetrieve | GET /api/v2/super-contest-effect/{id}/ | Get super contest effect PokeapiClient.EncountersApi | encounterConditionList | GET /api/v2/encounter-condition/ | List encounter conditions PokeapiClient.EncountersApi | encounterConditionRetrieve | GET /api/v2/encounter-condition/{id}/ | Get encounter condition PokeapiClient.EncountersApi | encounterConditionValueList | GET /api/v2/encounter-condition-value/ | List encounter condition values PokeapiClient.EncountersApi | encounterConditionValueRetrieve | GET /api/v2/encounter-condition-value/{id}/ | Get encounter condition value PokeapiClient.EncountersApi | encounterMethodList | GET /api/v2/encounter-method/ | List encounter methods PokeapiClient.EncountersApi | encounterMethodRetrieve | GET /api/v2/encounter-method/{id}/ | Get encounter method PokeapiClient.EvolutionApi | evolutionChainList | GET /api/v2/evolution-chain/ | List evolution chains PokeapiClient.EvolutionApi | evolutionChainRetrieve | GET /api/v2/evolution-chain/{id}/ | Get evolution chain PokeapiClient.EvolutionApi | evolutionTriggerList | GET /api/v2/evolution-trigger/ | List evolution triggers PokeapiClient.EvolutionApi | evolutionTriggerRetrieve | GET /api/v2/evolution-trigger/{id}/ | Get evolution trigger PokeapiClient.GamesApi | generationList | GET /api/v2/generation/ | List genrations PokeapiClient.GamesApi | generationRetrieve | GET /api/v2/generation/{id}/ | Get genration PokeapiClient.GamesApi | pokedexList | GET /api/v2/pokedex/ | List pokedex PokeapiClient.GamesApi | pokedexRetrieve | GET /api/v2/pokedex/{id}/ | Get pokedex PokeapiClient.GamesApi | versionGroupList | GET /api/v2/version-group/ | List version groups PokeapiClient.GamesApi | versionGroupRetrieve | GET /api/v2/version-group/{id}/ | Get version group PokeapiClient.GamesApi | versionList | GET /api/v2/version/ | List versions PokeapiClient.GamesApi | versionRetrieve | GET /api/v2/version/{id}/ | Get version PokeapiClient.ItemsApi | itemAttributeList | GET /api/v2/item-attribute/ | List item attributes PokeapiClient.ItemsApi | itemAttributeRetrieve | GET /api/v2/item-attribute/{id}/ | Get item attribute PokeapiClient.ItemsApi | itemCategoryList | GET /api/v2/item-category/ | List item categories PokeapiClient.ItemsApi | itemCategoryRetrieve | GET /api/v2/item-category/{id}/ | Get item category PokeapiClient.ItemsApi | itemFlingEffectList | GET /api/v2/item-fling-effect/ | List item fling effects PokeapiClient.ItemsApi | itemFlingEffectRetrieve | GET /api/v2/item-fling-effect/{id}/ | Get item fling effect PokeapiClient.ItemsApi | itemList | GET /api/v2/item/ | List items PokeapiClient.ItemsApi | itemPocketList | GET /api/v2/item-pocket/ | List item pockets PokeapiClient.ItemsApi | itemPocketRetrieve | GET /api/v2/item-pocket/{id}/ | Get item pocket PokeapiClient.ItemsApi | itemRetrieve | GET /api/v2/item/{id}/ | Get item PokeapiClient.LocationApi | locationAreaList | GET /api/v2/location-area/ | List location areas PokeapiClient.LocationApi | locationAreaRetrieve | GET /api/v2/location-area/{id}/ | Get location area PokeapiClient.LocationApi | locationList | GET /api/v2/location/ | List locations PokeapiClient.LocationApi | locationRetrieve | GET /api/v2/location/{id}/ | Get location PokeapiClient.LocationApi | palParkAreaList | GET /api/v2/pal-park-area/ | List pal park areas PokeapiClient.LocationApi | palParkAreaRetrieve | GET /api/v2/pal-park-area/{id}/ | Get pal park area PokeapiClient.LocationApi | regionList | GET /api/v2/region/ | List regions PokeapiClient.LocationApi | regionRetrieve | GET /api/v2/region/{id}/ | Get region PokeapiClient.MachinesApi | machineList | GET /api/v2/machine/ | List machines PokeapiClient.MachinesApi | machineRetrieve | GET /api/v2/machine/{id}/ | Get machine PokeapiClient.MovesApi | moveAilmentList | GET /api/v2/move-ailment/ | List move meta ailments PokeapiClient.MovesApi | moveAilmentRetrieve | GET /api/v2/move-ailment/{id}/ | Get move meta ailment PokeapiClient.MovesApi | moveBattleStyleList | GET /api/v2/move-battle-style/ | List move battle styles PokeapiClient.MovesApi | moveBattleStyleRetrieve | GET /api/v2/move-battle-style/{id}/ | Get move battle style PokeapiClient.MovesApi | moveCategoryList | GET /api/v2/move-category/ | List move meta categories PokeapiClient.MovesApi | moveCategoryRetrieve | GET /api/v2/move-category/{id}/ | Get move meta category PokeapiClient.MovesApi | moveLearnMethodList | GET /api/v2/move-learn-method/ | List move learn methods PokeapiClient.MovesApi | moveLearnMethodRetrieve | GET /api/v2/move-learn-method/{id}/ | Get move learn method PokeapiClient.MovesApi | moveList | GET /api/v2/move/ | List moves PokeapiClient.MovesApi | moveRetrieve | GET /api/v2/move/{id}/ | Get move PokeapiClient.MovesApi | moveTargetList | GET /api/v2/move-target/ | List move targets PokeapiClient.MovesApi | moveTargetRetrieve | GET /api/v2/move-target/{id}/ | Get move target PokeapiClient.PokemonApi | abilityList | GET /api/v2/ability/ | PokeapiClient.PokemonApi | abilityRetrieve | GET /api/v2/ability/{id}/ | PokeapiClient.PokemonApi | characteristicList | GET /api/v2/characteristic/ | List charecterictics PokeapiClient.PokemonApi | characteristicRetrieve | GET /api/v2/characteristic/{id}/ | Get characteristic PokeapiClient.PokemonApi | eggGroupList | GET /api/v2/egg-group/ | List egg groups PokeapiClient.PokemonApi | eggGroupRetrieve | GET /api/v2/egg-group/{id}/ | Get egg group PokeapiClient.PokemonApi | genderList | GET /api/v2/gender/ | List genders PokeapiClient.PokemonApi | genderRetrieve | GET /api/v2/gender/{id}/ | Get gender PokeapiClient.PokemonApi | growthRateList | GET /api/v2/growth-rate/ | List growth rates PokeapiClient.PokemonApi | growthRateRetrieve | GET /api/v2/growth-rate/{id}/ | Get growth rate PokeapiClient.PokemonApi | moveDamageClassList | GET /api/v2/move-damage-class/ | List move damage classes PokeapiClient.PokemonApi | moveDamageClassRetrieve | GET /api/v2/move-damage-class/{id}/ | Get move damage class PokeapiClient.PokemonApi | natureList | GET /api/v2/nature/ | List natures PokeapiClient.PokemonApi | natureRetrieve | GET /api/v2/nature/{id}/ | Get nature PokeapiClient.PokemonApi | pokeathlonStatList | GET /api/v2/pokeathlon-stat/ | List pokeathlon stats PokeapiClient.PokemonApi | pokeathlonStatRetrieve | GET /api/v2/pokeathlon-stat/{id}/ | Get pokeathlon stat PokeapiClient.PokemonApi | pokemonColorList | GET /api/v2/pokemon-color/ | List pokemon colors PokeapiClient.PokemonApi | pokemonColorRetrieve | GET /api/v2/pokemon-color/{id}/ | Get pokemon color PokeapiClient.PokemonApi | pokemonFormList | GET /api/v2/pokemon-form/ | List pokemon forms PokeapiClient.PokemonApi | pokemonFormRetrieve | GET /api/v2/pokemon-form/{id}/ | Get pokemon form PokeapiClient.PokemonApi | pokemonHabitatList | GET /api/v2/pokemon-habitat/ | List pokemom habitas PokeapiClient.PokemonApi | pokemonHabitatRetrieve | GET /api/v2/pokemon-habitat/{id}/ | Get pokemom habita PokeapiClient.PokemonApi | pokemonList | GET /api/v2/pokemon/ | List pokemon PokeapiClient.PokemonApi | pokemonRetrieve | GET /api/v2/pokemon/{id}/ | Get pokemon PokeapiClient.PokemonApi | pokemonShapeList | GET /api/v2/pokemon-shape/ | List pokemon shapes PokeapiClient.PokemonApi | pokemonShapeRetrieve | GET /api/v2/pokemon-shape/{id}/ | Get pokemon shape PokeapiClient.PokemonApi | pokemonSpeciesList | GET /api/v2/pokemon-species/ | List pokemon species PokeapiClient.PokemonApi | pokemonSpeciesRetrieve | GET /api/v2/pokemon-species/{id}/ | Get pokemon species PokeapiClient.PokemonApi | statList | GET /api/v2/stat/ | List stats PokeapiClient.PokemonApi | statRetrieve | GET /api/v2/stat/{id}/ | Get stat PokeapiClient.PokemonApi | typeList | GET /api/v2/type/ | List types PokeapiClient.PokemonApi | typeRetrieve | GET /api/v2/type/{id}/ | Get types PokeapiClient.UtilityApi | languageList | GET /api/v2/language/ | List languages PokeapiClient.UtilityApi | languageRetrieve | GET /api/v2/language/{id}/ | Get language

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

basicAuth

  • Type: HTTP basic authentication

cookieAuth

  • Type: API key
  • API key parameter name: sessionid
  • Location: