A RESTful API for Pokémon - pokeapi.co
Beta GraphQL support is rolling out! Check out the GraphQL paragraph for more info.
Download this source code into a working directory, be sure to use the flag
--recurse-submodulesto 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:
Run the server using the following command:
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:80/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.
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:
There is also a multi-container setup, managed by Docker Compose. This setup allows you to deploy a production-like environment, with separate containers for each services and is recommended if you need to simply spin up PokéAPI.
Start everything by
If you don't have
make on your machine you can use the following commands
docker-compose up -d docker-compose exec -T app python manage.py migrate --settings=config.docker-compose docker-compose exec -T app sh -c 'echo "from data.v2.build import build_all; build_all()" | python manage.py shell --settings=config.docker-compose'
When you start PokéAPI with the above docker-compose setup, an Hasura Engine server is started as well. It's possible to track all the PokeAPI tables and foreign keys by simply
# hasura cli needs to be installed and available in your $PATH: https://hasura.io/docs/latest/graphql/core/hasura-cli/install-hasura-cli.html # hasura cli's version has to be v2.0.0-alpha.5 make hasura-apply
A set of examples are provided in the directory /graphql/examples of this repository.
Kustomize files are provided in the folder https://github.com/PokeAPI/pokeapi/tree/master/Resources/k8s/kustomize/base/. Create and change your secrets:
cp Resources/k8s/kustomize/base/secrets/postgres.env.sample Resources/k8s/kustomize/base/secrets/postgres.env cp Resources/k8s/kustomize/base/secrets/graphql.env.sample Resources/k8s/kustomize/base/secrets/graphql.env cp Resources/k8s/kustomize/base/config/pokeapi.env.sample Resources/k8s/kustomize/base/config/pokeapi.env # Edit the newly created files
kubectl to point to a cluster and then run the following commands to start a PokéAPI service.
kubectl apply -k Resources/k8s/kustomize/base/ kubectl config set-context --current --namespace pokeapi # (Optional) Set pokeapi ns as the working ns # Wait for the cluster to spin up kubectl exec --namespace pokeapi deployment/pokeapi -- python manage.py migrate --settings=config.docker-compose # Migrate the DB kubectl exec --namespace pokeapi deployment/pokeapi -- sh -c 'echo "from data.v2.build import build_all; build_all()" | python manage.py shell --settings=config.docker-compose' # Build the db kubectl wait --namespace pokeapi --timeout=120s --for=condition=complete job/load-graphql # Wait for Graphql configuration job to finish
This k8s setup creates all k8s resources inside the Namespace
kubectl delete namespace pokeapi to delete them. It also creates a Service of type
LoadBalancer which is exposed on port
443. Data is persisted on
|Node server-side||PokeAPI/pokedex-promise-v2||Auto caching|
|Browser client-side||PokeAPI/pokeapi-js-wrapper||Auto caching, Image caching|
|Python 2/3||PokeAPI/pokepy||Auto caching|
|Python 3||PokeAPI/pokebase||Auto caching, Image caching|
|PHP||lmerotta/phpokeapi||Auto caching, lazy loading|
|.Net Standard||mtrdp642/PokeApiNet||Auto caching|
|Spring Boot||dlfigueira/spring-pokeapi||Auto caching|
|Typescript server-side/client-side||Gabb-c/Pokenode-ts||Auto caching|
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 60 million requests a month!
Thank you to all our backers! Become a backer
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
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:
Download the forked project using git clone:
git clone --recurse-submodules firstname.lastname@example.org:<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.
As of October 2018, the v1 API has been removed from PokéAPI. For more information, see pokeapi.co/docs/v1.html.