PokeAPI/pokeapi

これは何？

主な機能

• 01/api/v2/以下でポケモンデータを提供するRESTエンドポイント。
• 02クエリ例付きのベータ版GraphQLエンドポイントを提供。
• 03data/v2/csv内のCSVファイルからデータベースを構築。
• 04レスポンスにスプライトや鳴き声のリソースURLを含む。
• 05Docker Composeを使ってローカルで実行でき、Kubernetesにデプロイすることも可能。

ユースケース

• ポケモンのステータスやスプライトを表示する図鑑アプリや関連アプリの開発。
• 公開REST APIやGraphQL APIの利用方法を学生に教える。
• 独自のデータセットを作成せずに、ポケモンデータを必要とするゲームやbotを試作する。
• 内部テスト用にAPIのプライベートな複製をホストする。

クイックスタート

1. 1

   リポジトリをクローンし、cries サブモジュールを初期化する

   git clone https://github.com/PokeAPI/pokeapi.git && cd pokeapi && git submodule update --init data/v2/cries
2. 2

   依存関係をインストールする（先に uv をインストールする必要があります）

   make install
3. 3

   ローカルの開発環境をセットアップする

   make setup
4. 4

   ポート 8000 でサーバーを起動する

   make serve

使う前に知っておきたいこと

• !ローカル環境のセットアップには uv ツールと Python 環境が必要なため、いくつか手動での作業が必要です。
• !API がデータを返す前に、CSV データからデータベースを構築する必要があります。
• !sprites サブモジュールをすべてクローンすると 10 GB を超えますが、これは任意です。

収録されている特集

トピック

よくある質問

pokeapi とは？

ポケモンの種族、わざ、タイプなどの構造化データを提供するRESTful APIおよびGraphQL API。 PokeAPIは、ポケモン、種族、わざ、とくせい、タイプ、ゲーム、スプライトや鳴き声のリソースなど、ポケモンシリーズに関する詳細なデータを提供する、無料で利用できる公開Web APIです。独自のデータセットを管理することなく、HTTP経由でデータを取得し、アプリやゲーム、bot、教材を作成できます。

pokeapi は無料で使えますか？ライセンスは？

pokeapi は BSD-3-Clause ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

pokeapi は今もメンテナンスされていますか？

活発にメンテナンス中。pokeapi の最終コミットは 2026年11月5日 です。

pokeapi は何に使えますか？

ポケモンのステータスやスプライトを表示する図鑑アプリや関連アプリの開発。 公開REST APIやGraphQL APIの利用方法を学生に教える。 独自のデータセットを作成せずに、ポケモンデータを必要とするゲームやbotを試作する。 内部テスト用にAPIのプライベートな複製をホストする。

pokeapi のインストール方法は？

リポジトリをクローンし、cries サブモジュールを初期化する: git clone https://github.com/PokeAPI/pokeapi.git && cd pokeapi && git submodule update --init data/v2/cries 依存関係をインストールする（先に uv をインストールする必要があります）: make install ローカルの開発環境をセットアップする: make setup ポート 8000 でサーバーを起動する: make serve

pokeapi はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/PokeAPI/pokeapi