Modrinth API

Base: https://api.modrinth.com/v2

Modrinth project search, details, and version listing.

Handler: ModrinthProvider
GET /search

Search Projects

Search Modrinth for mods

Parameter

Name Type Required Description
query string No Search keyword
facets string No Facets JSON e.g. [["project_type:mod"]]
limit integer No Results per page (default 10)
offset integer No Pagination offset

Response Example

{"hits":[{"slug":"fabric-api","title":"Fabric API","description":"Essential hooks for modding with Fabric","project_type":"mod","downloads":250000000,"icon_url":"https://cdn.modrinth.com/...","versions":["1.20.1","1.21"]}],"offset":0,"limit":10,"total_hits":1}

cURL

curl "https://api.modrinth.com/v2/search?query=fabric-api&facets=[[\"project_type:mod\"]]&limit=5"
GET /project/{id|slug}

Get Project

Get a single project by ID or slug

Parameter

Name Type Required Description
id|slug string Yes Project ID or slug

Response Example

{"slug":"fabric-api","title":"Fabric API","description":"Essential hooks...","downloads":250000000,"project_type":"mod","server_side":"required","loaders":["fabric","quilt"]}

cURL

curl "https://api.modrinth.com/v2/project/fabric-api"
GET /project/{id|slug}/version

List Versions

List all versions of a project

Parameter

Name Type Required Description
id|slug string Yes Project ID or slug
loaders string No JSON array e.g. ["fabric"]
game_versions string No JSON array e.g. ["1.20.1"]

Response Example

[{"id":"abcd1234","version_number":"0.91.0","game_versions":["1.20.1"],"loaders":["fabric"],"files":[{"url":"https://cdn.modrinth.com/...","filename":"fabric-api-0.91.0.jar","hashes":{"sha1":"..."}}],"dependencies":[]}]

cURL

curl "https://api.modrinth.com/v2/project/fabric-api/version?loaders=[\"fabric\"]&game_versions=[\"1.20.1\"]"