All the Pokémon data you'll ever need in one place, easily accessible through a modern free open-source RESTful API.
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.
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 and other PokéAPI contributors around the world. Pokémon and Pokémon character names are trademarks of Nintendo.
Find out more here: https://pokeapi.co/docs/v2
The SDK relies on Node.js and npm (to resolve dependencies). It also requires Typescript version >=4.1. You can download and install Node.js and npm from the official Node.js website.
NOTE: npm is installed by default when Node.js is installed.
Run the following commands in the command prompt or shell of your choice to check if Node.js and npm are successfully installed:
-
Node.js:
node --version -
npm:
npm --version
- To resolve all dependencies, go to the SDK root directory and run the following command with npm:
npm install- This will install all dependencies in the node_modules folder.
The following section explains how to use the generated library in a new project.
-
Open an IDE/text editor for JavaScript like Visual Studio Code. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.
-
Click on File and select Open Folder. Select an empty folder of your project, the folder will become visible in the sidebar on the left.
- To initialize the Node project, click on Terminal and select New Terminal. Execute the following command in the terminal:
npm init --y- The created project manages its dependencies using its
package.jsonfile. In order to add a dependency on the PokéAPILib client library, double click on thepackage.jsonfile in the bar on the left and add the dependency to the package in it.
- To install the package in the project, run the following command in the terminal:
npm installNote: Documentation for the client can be found here.
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
|---|---|---|
| timeout | number |
Timeout for API calls. Default: 30000 |
| httpClientOptions | Partial<HttpClientOptions> |
Stable configurable http client options. |
| unstableHttpClientOptions | any |
Unstable configurable http client options. |
| logging | PartialLoggingOptions |
Logging Configuration to enable logging |
The API client can be initialized as follows:
import { Client, LogLevel } from 'pok-apilib';
const client = new Client({
timeout: 30000,
logging: {
logLevel: LogLevel.Info,
logRequest: {
logBody: true
},
logResponse: {
logHeaders: true
}
},
});import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'pok-apilib';
// Provide absolute path for the configuration file
const absolutePath = path.resolve('./config.json');
// Read the configuration file content
const fileContent = fs.readFileSync(absolutePath, 'utf-8');
// Initialize client from JSON configuration content
const client = Client.fromJsonConfig(fileContent);See the Configuration-Based Client Initialization section for details.
import * as dotenv from 'dotenv';
import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'pok-apilib';
// Optional - Provide absolute path for the .env file
const absolutePath = path.resolve('./.env');
if (fs.existsSync(absolutePath)) {
// Load environment variables from .env file
dotenv.config({ path: absolutePath, override: true });
}
// Initialize client using environment variables
const client = Client.fromEnvironment(process.env);See the Environment-Based Client Initialization section for details.