PokeAPI/pokeapi

这是什么？

核心功能

• 01在 /api/v2/ 下提供宝可梦数据的 REST 接口。
• 02提供 Beta 版 GraphQL 接口及示例查询。
• 03通过 data/v2/csv 中的 CSV 文件构建数据库。
• 04接口响应中包含图片和叫声资源的 URL。
• 05支持使用 Docker Compose 本地运行或部署到 Kubernetes。

适用场景

• 开发展示宝可梦属性和图片的图鉴或伴侣应用。
• 作为教学案例，讲解如何调用公开的 REST 或 GraphQL 接口。
• 在无需自建数据集的情况下，为游戏或机器人原型提供宝可梦数据。
• 搭建私有的 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 与 GraphQL 公共 API。 PokeAPI 是一个免费公开的 Web API，提供宝可梦系列的详细数据，包括宝可梦、物种、招式、特性、属性、游戏，以及图片和叫声等资源。开发者可以通过 HTTP 请求获取这些数据，用于构建应用、游戏、机器人或教学材料，而无需自行维护数据集。

pokeapi 可以免费使用吗？用的什么许可证？

pokeapi 以 BSD-3-Clause 许可证开源。用于商业产品前，请先确认许可证条款。

pokeapi 还在维护吗？

活跃维护中。pokeapi 最近一次提交是在 2026年11月5日。

pokeapi 适合用来做什么？

开发展示宝可梦属性和图片的图鉴或伴侣应用。 作为教学案例，讲解如何调用公开的 REST 或 GraphQL 接口。 在无需自建数据集的情况下，为游戏或机器人原型提供宝可梦数据。 搭建私有的 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