Modrinth API

The new icon may be up to 256KiB in size. Mocked via Mockzilla.

Modrinth allows you to upload files of up to 5MiB to a project's gallery.

Please note that, if the version number provided matches multiple versions, only the oldest matching version will be returned.

This route creates a version on an existing project. There must be at least one file attached to each new version, unless the new version's status is draft. .mrpack, .jar, .zip, and .litemod files are accepted. The request is a multipart request with at least two form fields: one is data, which includes a JSON body with the version metadata as shown below, and at least one field containing an upload file. You can name the file parts anything you would like, but you must list each of the parts' names in file_parts, and optionally, provide one to use as the primary file in primary_file.

Project files are attached. .mrpack and .jar files are accepted.

This is the same as /version_file/{hash} except it accepts multiple hashes. Available as a Mockzilla mock endpoint.

This is the same as /version_file/{hash}/update except it accepts multiple hashes.

The new avatar may be up to 2MiB in size.

Warning: certain amounts get withheld for fees. Please do not call this API endpoint without first acknowledging the warnings on the corresponding frontend page.

Bring a project, user, or version to the attention of the moderators by reporting it.

Gets an array of categories, their icons, and applicable project types. Mockzilla mock: no signup, no API key.

Gets an array of loaders, their icons, and supported project types

Gets an array of game versions and information about them

Deprecated - simply use SPDX IDs.

Gets an array of donation platforms and information about them

Gets an array of valid report types. Served by the Mockzilla mock runtime.

Gets an array of valid project types

Gets an array of valid side types

If you're a Forge mod developer, your Modrinth mods have an automatically generated updates.json using the Forge Update Checker. The only setup is to insert the URL into the [[mods]] section of your mods.toml file as such: [[mods]] the other stuff here - ID, version, display name, etc. updateJSONURL = "https://api.modrinth.com/updates/{slug|ID}/forge_updates.json" Replace {slug|id} with the slug or ID of your project. Modrinth will handle the rest! When you update your mod, Forge will notify your users that their copy of your mod is out of date. Make sure that the version format you use for your Modrinth releases is the same as the version format you use in your mods.toml. If you use a format such as 1.2.3-forge or 1.2.3+1.19 with your Modrinth releases but your mods.toml only has 1.2.3, the update checker may not function properly.