the-mod-index (6.0.0)

Download OpenAPI specification:Download

License: AGPL-3.0

The Mod Index plans to be a source where anyone can refer to for Minecraft mods, bridging the gap between multiple major mod hosting sites. Get mod metadata, download links, and more.

The index does NOT host or redistribute mod files (e.g. jars), but instead provides links/information to the mod files.

Index Files

The index files to navigate "the-mod-index"

Get the index for all mod loaders.

Get the index for all mod loaders. Does not include similar mods from other mod loaders.

Responses

Response samples

200

Content type

application/json

{"indexVersion": "6.0.0",
"identifiers": ["fabric:modget:9da29a647bab8cf"
],
"eolEpochTime": "null",
"modLoaders": ["fabric"
]
}

Get the index for a specific mod loader.

Get the index for a specific mod loader. Does not include similar mods from other mod loaders.

path Parameters

modLoader

required

string^(?!index|indices)[a-z0-9\-_]+$

Example: fabric

The mod loader for which to get the index

Responses

Response samples

200

Content type

application/json

{"indexVersion": "6.0.0",
"identifiers": ["fabric:modget:9da29a647bab8cf"
],
"eolEpochTime": "null"
}

Manifest Files

The manifest files found in "the-mod-index"

Get the manifest for a specific mod.

Get the manifest for a specific mod. Only returns valid information for the mod loader specified in the path, not all information for the mod

For example, in a mod which has separate Fabric and Forge files, should {modLoader} be forge, only the Forge files will be reflected in the Forge manifest

path Parameters

modLoader required	string^(?!index\|indices)[a-z0-9\-_]+$ Example: fabric The mod loader for which to get the index
loaderModName required	string^[a-z0-9\-_]+$ Example: modget The given mod name for a mod in the index. Usually used in combination with the a `modLoader` to form a `genericIdentifier`

Responses

Response samples

200

Content type

application/json

{"indexVersion": "6.0.0",
"genericIdentifier": "fabric:modget",
"fancyName": "modget",
"authors": ["ReviversMC"
],
"license": {"spdxId": "AGPL-3.0"
},
"curseForgeId": "533960",
"modrinthId": "2NpFE0R3",
"links": {"issue": "https://github.com/ReviversMC/modget/issues/",
"sourceControl": "https://github.com/ReviversMC/modget/",
"others": [{"linkName": "Discord",
"url": "https://discord.gg/6bTGYFppfz"
}
]
},
"files": [{"fileName": "Modget 0.0.1 for MC 1.16",
"mcVersions": ["1.12.2, 22w24a"
],
"shortSha512Hash": "9da29a647bab8cf",
"downloadUrls": ["https://github.com/ReviversMC/modget-minecraft/releases/download/0.4.3/modget-minecraft-0.4.3+1.17.jar"
],
"curseDownloadAvailable": "true",
"relationsToOtherMods": {"required": ["fabric:modget"
],
"incompatible": ["fabric:modget"
]
}
}
],
"overrides": {"genericIdentifier": "fabric:modget",
"fancyName": "modget",
"authors": ["ReviversMC"
],
"license": {"spdxId": "AGPL-3.0"
},
"curseForgeId": "533960",
"modrinthId": "2NpFE0R3",
"links": {"issues": "https://github.com/ReviversMC/modget/issues/",
"sourceControl": "https://github.com/ReviversMC/modget/",
"others": {"add": [{"linkName": "Discord",
"url": "https://discord.gg/6bTGYFppfz"
}
],
"remove": [{"linkName": "Discord",
"url": "https://discord.gg/6bTGYFppfz"
}
],
"replace": [{"linkName": "Discord",
"url": "https://discord.gg/6bTGYFppfz"
}
]
}
},
"files": {"add": [{"fileName": "Modget 0.0.1 for MC 1.16",
"mcVersions": ["1.12.2, 22w24a"
],
"shortSha512Hash": "9da29a647bab8cf",
"downloadUrls": ["https://github.com/ReviversMC/modget-minecraft/releases/download/0.4.3/modget-minecraft-0.4.3+1.17.jar"
],
"curseDownloadAvailable": "true",
"relationsToOtherMods": {"required": ["fabric:modget"
],
"incompatible": ["fabric:modget"
]
}
}
],
"remove": [{"fileName": "Modget 0.0.1 for MC 1.16",
"mcVersions": ["1.12.2, 22w24a"
],
"shortSha512Hash": "9da29a647bab8cf",
"downloadUrls": ["https://github.com/ReviversMC/modget-minecraft/releases/download/0.4.3/modget-minecraft-0.4.3+1.17.jar"
],
"curseDownloadAvailable": "true",
"relationsToOtherMods": {"required": ["fabric:modget"
],
"incompatible": ["fabric:modget"
]
}
}
],
"replace": [{"fileName": "Modget 0.0.1 for MC 1.16",
"mcVersions": ["1.12.2, 22w24a"
],
"shortSha512Hash": "9da29a647bab8cf",
"downloadUrls": ["https://github.com/ReviversMC/modget-minecraft/releases/download/0.4.3/modget-minecraft-0.4.3+1.17.jar"
],
"curseDownloadAvailable": "true",
"relationsToOtherMods": {"required": ["fabric:modget"
],
"incompatible": ["fabric:modget"
]
}
}
]
}
}
}