A RESTful API for Pokémon - pokeapi.co

Join Us On Slack!

Have a question or just want to discuss new ideas and improvements? Hit us up on slack. Consider talking with us here before creating new issue. This way we can keep issues here a bit more organized and helpful in the long run. Be excellent to each other 😄

Sign up easily!

Once you've signed up visit PokéAPI on Slack

Official Wrappers

• Node server-side PokeAPI/pokedex-promise-v2 | Auto caching
• Browser client-side PokeAPI/pokeapi-js-wrapper | Auto caching
• Java/Kotlin PokeAPI/pokekotlin
• Python 3 GregHilmes/pokebase | Auto caching
• Python 2/3 PokeAPI/pokepy | Auto caching
• PHP lmerotta/phpokeapi | Auto caching, lazy loading
• Ruby rdavid1099/poke-api-v2
• .Net Standard mtrdp642/PokeApiNet | Auto caching
• Go mtslzr/pokeapi-go | Auto caching
• Dart prathanbomb/pokedart
• Rust lunik1/pokerust | Auto caching
• Spring Boot dlfigueira/spring-pokeapi | Auto caching
• Swift kinkofer/PokemonAPI

Setup

• Download this source code into a working directory, be sure to use the flag --recurse-submodules to clone also our submodules.

• Install the requirements using pip:

  make install
  # This will install all the required packages and libraries for using PokeAPI

• Set up the local development environment using the following command:

  make setup

• Run the server using the following command:

  make serve

Database setup

Start the Django shell by

python manage.py shell --settings=config.local

Run the build script with

from data.v2.build import build_all
build_all()

Visit localhost:8000/api/v2/ to see the running API!

Each time the build script is run, it will iterate over each table in the database, wipe it, and rewrite each row using the data found in data/v2/csv.

In informal tests on a Windows PC with a SSD and a 2.50 GHz processor, building against a PostgresQL database took approximately 6 minutes, and building against a SQLite database took about 7.5 minutes or longer, with some varying results.

The option to build individual portions of the database was removed in order to increase performance of the build script.

If you ever need to wipe the database use this command:

make wipe_db

Docker Compose

There is also a multi-container setup, managed by Docker Compose. This setup allow you to deploy a production-like environment, with separate containers for each services.

Start the process using

docker-compose up --build

You can specify the -d switch to start in detached mode. This will bind port 80 and 443. Unfortunately, unlike the docker command, there is no command line arguments to specify ports. If you want to change them, edit the docker-compose.yml file.

After that, start the migration process

docker-compose exec app python manage.py migrate --settings=config.docker-compose

And then, import the data using the shell

docker-compose exec app python manage.py shell --settings=config.docker-compose

Then use the build_all() method in the shell to populate the database.

from data.v2.build import build_all
build_all()

Browse localhost/api/v2/ or localhost/api/v2/pokemon/bulbasaur/

This setup doesn't allow you to use the scale command.

Donations

Help to keep PokéAPI running! If you're using PokéAPI as a teaching resource or for a project, consider sending us a $10 donation to help keep the service up. We get almost 20 million requests a month!

Thank you to all our backers! Become a backer

Contributing

This project exists thanks to all the people who contribute

All contributions are welcome: bug fixes, data contributions, recommendations.

Please see the issues on GitHub before you submit a pull request or raise an issue, someone else might have beat you to it.

To contribute to this repository:

• Fork the project to your own GitHub profile

• Download the forked project using git clone:

  git clone --recurse-submodules [email protected]:<YOUR_USERNAME>/pokeapi.git

• Create a new branch with a descriptive name:

  git checkout -b my_new_branch

• Write some code, fix something, and add a test to prove that it works. No pull request will be accepted without tests passing, or without new tests if new features are added.

• Commit your code and push it to GitHub

• Open a new pull request and describe the changes you have made.

• We'll accept your changes after review.

Simple!

Deprecation

As of October 2018, the v1 API has been removed from PokéAPI. For more information, see pokeapi.co/docs/v1.html.