CurseForge API
Base: https://api.curseforge.com/v1
CurseForge Mods API — search, details, files, and descriptions via classId 9137.
Handler: CurseForgeProvider
GET
/mods/search
Search Mods
Search CurseForge mods by keyword
Parameter
| Name | Type | Required | Description |
|---|---|---|---|
x-api-key
|
string | Yes | Your CurseForge API key |
gameId
|
integer | Yes | Game ID (432=Minecraft, 70216=Hytale) |
classId
|
integer | No | Class ID (9137=Mods) |
searchFilter
|
string | No | Search keyword |
sortField
|
integer | No | 1=Featured 2=Popularity 3=LastUpdated 6=TotalDownloads |
sortOrder
|
string | No | asc or desc |
pageSize
|
integer | No | Results per page (max 50) |
index
|
integer | No | Pagination offset (0-based) |
gameVersion
|
string | No | MC version filter e.g. 1.20.1 |
modLoaderType
|
integer | No | 1=Forge 4=Fabric 5=Quilt 6=NeoForge |
Response Example
{"data":[{"id":238222,"gameId":432,"name":"Just Enough Items (JEI)","slug":"jei","links":{"websiteUrl":"https://www.curseforge.com/minecraft/mc-mods/jei"},"summary":"View Items and Recipes","downloadCount":195000000,"categories":[{"id":421}],"classId":9137,"authors":[{"name":"mezz"}]}],"pagination":{"index":0,"pageSize":20,"resultCount":1,"totalCount":1}}cURL
curl -H "x-api-key: YOUR_KEY" "https://api.curseforge.com/v1/mods/search?gameId=432&classId=9137&searchFilter=jei&pageSize=5"
GET
/mods/{modId}
Get Mod Details
Fetch full details for a single mod
Parameter
| Name | Type | Required | Description |
|---|---|---|---|
x-api-key
|
string | Yes | Your CurseForge API key |
modId
|
integer | Yes | CurseForge mod ID |
Response Example
{"data":{"id":238222,"name":"Just Enough Items (JEI)","slug":"jei","summary":"View Items and Recipes","downloadCount":195000000,"mainFileId":5000000,"latestFilesIndexes":[{"gameVersion":"1.20.1","fileId":5000000}]}}cURL
curl -H "x-api-key: YOUR_KEY" "https://api.curseforge.com/v1/mods/238222"
GET
/mods/{modId}/files
Get Mod Files
List all available file versions for a mod
Parameter
| Name | Type | Required | Description |
|---|---|---|---|
x-api-key
|
string | Yes | Your CurseForge API key |
modId
|
integer | Yes | CurseForge mod ID |
gameVersion
|
string | No | Filter by MC version |
modLoaderType
|
integer | No | 1=Forge 4=Fabric |
pageSize
|
integer | No | Results per page |
Response Example
{"data":[{"id":5000000,"displayName":"jei-1.20.1-15.2.0.27.jar","fileName":"jei-1.20.1-15.2.0.27.jar","releaseType":1,"downloadUrl":"https://edge.forgecdn.net/files/...","gameVersions":["1.20.1","Forge"],"dependencies":[]}]}cURL
curl -H "x-api-key: YOUR_KEY" "https://api.curseforge.com/v1/mods/238222/files?gameVersion=1.20.1"
GET
/mods/{modId}/description
Get Mod Description
Fetch full HTML description
Parameter
| Name | Type | Required | Description |
|---|---|---|---|
x-api-key
|
string | Yes | Your CurseForge API key |
modId
|
integer | Yes | CurseForge mod ID |
Response Example
{"data":"<h2>Just Enough Items</h2><p>JEI is an item and recipe viewing mod...</p>"}cURL
curl -H "x-api-key: YOUR_KEY" "https://api.curseforge.com/v1/mods/238222/description"