ModReleaser/docs/curseforge/index.md

CurseForge REST API 文档

来源：https://docs.curseforge.com/rest-api/

API 基础地址：https://api.curseforge.com，认证方式：Header x-api-key: <token>

---

通用说明

• 分页上限：最大 pageSize 为 50，总结果上限 10,000（index + pageSize <= 10,000）
• 除非特别说明，所有 int32 响应均为无符号整数

---

端点总览

Games

方法	路径	说明	详见
GET	/v1/games	获取所有可用游戏	—
GET	/v1/games/{gameId}	获取单个游戏	—
GET	/v1/games/{gameId}/versions	获取游戏的所有版本（V1）	—
GET	/v2/games/{gameId}/versions	获取游戏的所有版本（V2）	—
GET	/v1/games/{gameId}/version-types	获取游戏的版本类型	—

Categories

方法	路径	说明	详见
GET	/v1/categories	获取分类（class/category）	—

Mods

方法	路径	说明	详见
GET	/v1/mods/search	搜索项目	—
GET	/v1/mods/{modId}	获取单个项目	get-mod.md
POST	/v1/mods	批量获取项目	—
POST	/v1/mods/featured	获取精选/热门/最近更新	—
GET	/v1/mods/{modId}/description	获取项目描述（HTML）	—

Files

方法	路径	说明	详见
GET	/v1/mods/{modId}/files/{fileId}	获取单个文件	—
GET	/v1/mods/{modId}/files	获取项目的所有文件	get.md
POST	/v1/mods/files	批量获取文件	—
GET	/v1/mods/{modId}/files/{fileId}/changelog	获取文件更新日志（HTML）	—
GET	/v1/mods/{modId}/files/{fileId}/download-url	获取文件下载链接	—

Fingerprints

方法	路径	说明	详见
POST	/v1/fingerprints/{gameId}	精确指纹匹配（按游戏）	—
POST	/v1/fingerprints	精确指纹匹配	—
POST	/v1/fingerprints/fuzzy/{gameId}	模糊指纹匹配（按游戏）	—
POST	/v1/fingerprints/fuzzy	模糊指纹匹配	—

Minecraft

方法	路径	说明	详见
GET	/v1/minecraft/version	获取 Minecraft 版本列表	get-meta.md
GET	/v1/minecraft/version/{versionString}	获取特定 Minecraft 版本	—
GET	/v1/minecraft/modloader	获取 ModLoader 列表	—
GET	/v1/minecraft/modloader/{name}	获取特定 ModLoader	—

---

文件说明

本目录下各文件用途：

文件	说明
index.md	总览页面，列出所有 REST API 端点及本文档的文件索引
all-schemas.md	所有 REST API 涉及的 Schema 定义和枚举值完整列表。一般不需要读——大多数 Schema 已在各端点文档中内联
get-mod.md	GET /v1/mods/{modId} 端点详解，包含请求示例、响应字段及子类型说明
get.md	GET /v1/mods/{modId}/files 端点详解，包含 File Schema、枚举值及分页响应
get-meta.md	GET /v1/minecraft/version 端点详解，获取 Minecraft 版本列表
upload.md	上传相关 API（base URL 为 https://minecraft.curseforge.com），包括 Game Version Types、Game Versions、文件上传/更新及 Maven 端点