接口参考

所有接口的 Base URL 是 https://mod.mcimirror.top · 字段结构与在线试用请看上游的 Swagger 页面

CurseForge

GET/curseforge/ Root endpoint for the Curseforge API

参数

无参数

响应

状态码	说明	结构
`200`	Curseforge Message

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/curseforge/'

在 Swagger 中查看

GET/curseforge/v1/categories Curseforge Get Categories by GameId and ClassId

参数

名称	位置	类型	必填	说明
`gameId`	查询	integer	是	ID of the game to filter categories by
`classId`	查询	integer	否	ID of the class to filter categories by (optional)
`classesOnly`	查询	boolean	否	Whether to return only classes (optional)

响应

状态码	说明	结构
`200`	Categories found	`CategoriesResponse`
`500`	Internal server error

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/curseforge/v1/categories?gameId=432'

在 Swagger 中查看

POST/curseforge/v1/fingerprints Curseforge Get Fingerprints by Fingerprints

参数

无参数

请求体

FingerprintsBody

响应

状态码	说明	结构
`200`	Fingerprints found	`FingerprintResult`
`400`	Bad request
`500`	Internal server error

示例请求

改上面的值，命令会跟着变

curl -X POST 'https://mod.mcimirror.top/curseforge/v1/fingerprints' \
  -H 'Content-Type: application/json' \
  -d '{"fingerprints":[510490952]}'

在 Swagger 中查看

POST/curseforge/v1/fingerprints/{game_id} Curseforge Get Fingerprints by GameId and Fingerprints

参数

名称	位置	类型	必填	说明	值
`game_id`	路径	integer	是	ID of the game to filter fingerprints by

请求体

FingerprintsBody

响应

状态码	说明	结构
`200`	Fingerprints found	`FingerprintResult`
`400`	Bad request
`500`	Internal server error

示例请求

改上面的值，命令会跟着变

curl -X POST 'https://mod.mcimirror.top/curseforge/v1/fingerprints/432' \
  -H 'Content-Type: application/json' \
  -d '{"fingerprints":[510490952]}'

在 Swagger 中查看

POST/curseforge/v1/mods Curseforge Get Mods by ModIds

参数

无参数

请求体

ModsBody

响应

状态码	说明	结构
`200`	Mods found	`ModResponse[]`
`400`	Bad request
`500`	Internal server error

示例请求

改上面的值，命令会跟着变

curl -X POST 'https://mod.mcimirror.top/curseforge/v1/mods' \
  -H 'Content-Type: application/json' \
  -d '{"modIds":[238222]}'

在 Swagger 中查看

POST/curseforge/v1/mods/files Curseforge Get Files by FileIds

参数

无参数

请求体

FileIdsBody

响应

状态码	说明	结构
`200`	Files found	`FileResponse[]`
`400`	Bad request
`500`	Internal server error

示例请求

改上面的值，命令会跟着变

curl -X POST 'https://mod.mcimirror.top/curseforge/v1/mods/files' \
  -H 'Content-Type: application/json' \
  -d '{"fileIds":[6614392]}'

在 Swagger 中查看

GET/curseforge/v1/mods/search Curseforge Search

参数

名称	位置	类型	必填	说明
`gameId`	查询	integer	是	ID of the game to filter mods by (optional)
`classId`	查询	integer	否	ID of the class to filter mods by (optional)
`categoryId`	查询	integer	否	ID of the category to filter mods by (optional)
`categoryIds`	查询	string	否	Comma-separated list of category IDs to filter mods by (optional)
`gameVersion`	查询	string	否	Game version filter (optional)
`gameVersions`	查询	string	否	Comma-separated list of game versions to filter mods by (optional)
`searchFilter`	查询	string	否	Search filter for mod names (optional)
`sortField`	查询	string	否	Field to sort results by (optional)
`sortOrder`	查询	string	否	Order to sort results in (asc/desc) (optional)
`modLoaderType`	查询	string	否	Mod loader type filter (optional)
`modLoaderTypes`	查询	string	否	Comma-separated list of mod loader types to filter mods by (optional)
`gameVersionTypeId`	查询	integer	否	Game version type ID filter (optional)
`authorId`	查询	integer	否	ID of the author to filter mods by (optional)
`primaryAuthorId`	查询	integer	否	ID of the primary author to filter mods by (optional)
`slug`	查询	string	否	Slug of the mod to retrieve (optional)
`index`	查询	integer	否	Zero-based index of the first item to include in the response. The limit is: (index + pageSize <= 10,000).
`pageSize`	查询	integer	否	Number of items to include in the response. The default/maximum value is 50.

响应

状态码	说明	结构
`200`	Search Result found	`SearchResponse`
`500`	Internal server error

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/curseforge/v1/mods/search?gameId=432&index=0&pageSize=50'

在 Swagger 中查看

GET/curseforge/v1/mods/{mod_id} Curseforge Get Mod by ModId

参数

名称	位置	类型	必填	说明	值
`mod_id`	路径	integer	是	ID of the mod to retrieve

响应

状态码	说明	结构
`200`	Mod found	`ModResponse`
`404`	Mod not found
`500`	Internal server error

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/curseforge/v1/mods/238222'

在 Swagger 中查看

GET/curseforge/v1/mods/{mod_id}/files Curseforge Get Mod Files by ModId

参数

名称	位置	类型	必填	说明
`mod_id`	路径	integer	是	ID of the mod to retrieve files for
`gameVersion`	查询	string	否	Game version filter (optional)
`modLoaderType`	查询	string	否	Mod loader type filter (optional)
`index`	查询	integer	否	Index for pagination (optional)
`pageSize`	查询	integer	否	Page size for pagination (optional)

响应

状态码	说明	结构
`200`	Files found	`FileResponse[]`
`404`	Mod not found
`500`	Internal server error

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/curseforge/v1/mods/238222/files?index=0&pageSize=50'

在 Swagger 中查看

GET/curseforge/v1/mods/{mod_id}/files/{file_id} Curseforge Get File by ModId and FileId

参数

名称	位置	类型	必填	说明	值
`mod_id`	路径	integer	是	ID of the mod to which the file belongs
`file_id`	路径	integer	是	ID of the file to retrieve

响应

状态码	说明	结构
`200`	File found	`FileResponse`
`404`	File not found
`500`	Internal server error

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/curseforge/v1/mods/238222/files/8937628'

在 Swagger 中查看

GET/curseforge/v1/mods/{mod_id}/files/{file_id}/download-url Curseforge Get File Download URL by ModId and FileId

参数

名称	位置	类型	必填	说明	值
`mod_id`	路径	integer	是	ID of the mod
`file_id`	路径	integer	是	ID of the file to retrieve download URL for

响应

状态码	说明	结构
`200`	Download URL found	`DownloadUrlResponse`
`404`	File not found
`500`	Internal server error

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/curseforge/v1/mods/238222/files/8937628/download-url'

在 Swagger 中查看

Modrinth

GET/modrinth/ Root endpoint for the Modrinth API

参数

无参数

响应

状态码	说明	结构
`200`	Modrinth Message

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/modrinth/'

在 Swagger 中查看

GET/modrinth/v2/project/{project_id} Get a project by its project_id or slug

参数

名称	位置	类型	必填	说明	值
`project_id`	路径	string	是	ID of the game to filter project

响应

状态码	说明	结构
`200`	Project found	`Project`

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/modrinth/v2/project/sodium'

在 Swagger 中查看

GET/modrinth/v2/project/{project_id}/version Get all versions of a project by its project_id or slug

参数

名称	位置	类型	必填	说明	值
`project_id`	路径	string	是	ID or slug of the project

响应

状态码	说明	结构
`200`	Project versions found	`Version[]`

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/modrinth/v2/project/sodium/version'

在 Swagger 中查看

GET/modrinth/v2/projects Get multiple projects by their project_ids or slugs

参数

名称	位置	类型	必填	说明	值
`ids`	查询	string	是	The IDs and/or slugs of the projects

响应

状态码	说明	结构
`200`	Projects Found	`Project[]`

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/modrinth/v2/projects?ids=%5B%22sodium%22%2C%20%22fabric-api%22%5D'

在 Swagger 中查看

GET/modrinth/v2/search Modrinth Search for projects

参数

名称	位置	类型	必填	说明
`query`	查询	string	否	Search query
`facets`	查询	string	否	Facets to filter results
`offset`	查询	integer	否	Offset for pagination
`limit`	查询	integer	否	Limit for pagination
`index`	查询	string	否	Index to sort

响应

状态码	说明	结构
`200`	Search results found	`SearchResponse`

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/modrinth/v2/search?query=sodium&facets=%5B%5B%22categories%3Aforge%22%5D%2C%5B%22versions%3A1.17.1%22%5D%2C%5B%22project_type%3Amod%22%5D%2C%5B%22license%3Amit%22%5D%5D&offset=0&limit=10&index=relevance'

在 Swagger 中查看

GET/modrinth/v2/tag/category Get all categories

参数

无参数

响应

状态码	说明	结构
`200`	Categories found	`Category[]`

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/modrinth/v2/tag/category'

在 Swagger 中查看

GET/modrinth/v2/tag/game_version Get all game versions

参数

无参数

响应

状态码	说明	结构
`200`	Game versions found	`GameVersion[]`

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/modrinth/v2/tag/game_version'

在 Swagger 中查看

GET/modrinth/v2/tag/loader Get all loaders

参数

无参数

响应

状态码	说明	结构
`200`	Loaders found	`Loader[]`

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/modrinth/v2/tag/loader'

在 Swagger 中查看

GET/modrinth/v2/version/{version_id} Get a specific version by version_id

参数

名称	位置	类型	必填	说明	值
`version_id`	路径	string	是	ID of the version

响应

状态码	说明	结构
`200`	Version found	`Version`

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/modrinth/v2/version/ygf8cVZg'

在 Swagger 中查看

GET/modrinth/v2/version_file/{hash} Get a version file by its hash

参数

名称	位置	类型	必填	说明	值
`hash`	路径	string	是	Hash of the file, sha1 or sha512
`algorithm`	查询	string	是	Hash algorithm used, sha1 or sha512

响应

状态码	说明	结构
`200`	File found	`Version`

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/modrinth/v2/version_file/d67e66ea4bb2409997b636dae4203d33764cdcc8?algorithm=sha1'

在 Swagger 中查看

POST/modrinth/v2/version_file/{hash}/update Update a version file by its hash with new loaders and game versions

参数

名称	位置	类型	必填	说明	值
`hash`	路径	string	是	Hash of the file, sha1 or sha512
`algorithm`	查询	string	是	Hash algorithm used, sha1 or sha512

请求体

UpdateItems

响应

状态码	说明	结构
`200`	File updated	`Version`

示例请求

改上面的值，命令会跟着变

curl -X POST 'https://mod.mcimirror.top/modrinth/v2/version_file/d67e66ea4bb2409997b636dae4203d33764cdcc8/update?algorithm=sha1' \
  -H 'Content-Type: application/json' \
  -d '{"loaders":["fabric"],"game_versions":["1.16.5"]}'

在 Swagger 中查看

POST/modrinth/v2/version_files Get multiple version files by their hashes

参数

无参数

请求体

HashesQuery

响应

状态码	说明	结构
`200`	Files found	`{string: Version}`

示例请求

改上面的值，命令会跟着变

curl -X POST 'https://mod.mcimirror.top/modrinth/v2/version_files' \
  -H 'Content-Type: application/json' \
  -d '{"hashes":["d67e66ea4bb2409997b636dae4203d33764cdcc8"],"algorithm":"sha1"}'

在 Swagger 中查看

POST/modrinth/v2/version_files/update Update multiple version files by their hashes with new loaders and game versions

参数

无参数

请求体

MultiUpdateItems

响应

状态码	说明	结构
`200`	Versions Found	`Version[]`

示例请求

改上面的值，命令会跟着变

curl -X POST 'https://mod.mcimirror.top/modrinth/v2/version_files/update' \
  -H 'Content-Type: application/json' \
  -d '{"hashes":["d67e66ea4bb2409997b636dae4203d33764cdcc8"],"algorithm":"sha1","loaders":["fabric"],"game_versions":["1.16.5"]}'

在 Swagger 中查看

GET/modrinth/v2/versions Get multiple versions by their version_ids

参数

名称	位置	类型	必填	说明	值
`ids`	查询	string	是	The IDs of the versions

响应

状态码	说明	结构
`200`	Versions found	`Version[]`

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/modrinth/v2/versions?ids=%5B%22RncWhTxD%22%2C%20%22ygf8cVZg%22%5D'

在 Swagger 中查看

Translate

GET/translate/curseforge已废弃 Get CurseForge translation by mod ID

参数

名称	位置	类型	必填	说明	值
`modId`	查询	integer	是	Mod ID of the CurseForge mod

响应

状态码	说明	结构
`200`	Translation found	`CurseForgeTranslationResponse`
`404`	Translation not found
`500`	Internal server error

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/translate/curseforge?modId=238222'

在 Swagger 中查看

POST/translate/curseforge Get CurseForge translations in batch by mod IDs

参数

无参数

请求体

CurseForgeTranslationRequest

响应

状态码	说明	结构
`200`	Translations found	`CurseForgeTranslationResponse[]`
`500`	Internal server error

示例请求

改上面的值，命令会跟着变

curl -X POST 'https://mod.mcimirror.top/translate/curseforge' \
  -H 'Content-Type: application/json' \
  -d '{"modids":[238222]}'

在 Swagger 中查看

GET/translate/curseforge/{mod_id} Get CurseForge translation by mod ID

参数

名称	位置	类型	必填	说明	值
`mod_id`	路径	integer	是	Mod ID of the CurseForge mod

响应

状态码	说明	结构
`200`	Translation found	`CurseForgeTranslationResponse`
`404`	Translation not found
`500`	Internal server error

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/translate/curseforge/238222'

在 Swagger 中查看

GET/translate/modrinth已废弃 Get Modrinth translation by project ID

参数

名称	位置	类型	必填	说明	值
`project_id`	查询	string	是	Project ID of the Modrinth project

响应

状态码	说明	结构
`200`	Translation found	`ModrinthTranslationResponse`
`404`	Translation not found
`500`	Internal server error

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/translate/modrinth?project_id=P7dR8mSH'

在 Swagger 中查看

POST/translate/modrinth Get Modrinth translations in batch by project IDs

参数

无参数

请求体

ModrinthTranslationRequest

响应

状态码	说明	结构
`200`	Translations found	`ModrinthTranslationResponse[]`
`500`	Internal server error

示例请求

改上面的值，命令会跟着变

curl -X POST 'https://mod.mcimirror.top/translate/modrinth' \
  -H 'Content-Type: application/json' \
  -d '{"project_ids":["P7dR8mSH"]}'

在 Swagger 中查看

GET/translate/modrinth/{project_id} Get Modrinth translation by project ID

参数

名称	位置	类型	必填	说明	值
`project_id`	路径	string	是	Project ID of the Modrinth project

响应

状态码	说明	结构
`200`	Translation found	`ModrinthTranslationResponse`
`404`	Translation not found
`500`	Internal server error

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/translate/modrinth/P7dR8mSH'

在 Swagger 中查看

File CDN

GET/avatars/thumbnails/{modid1}/{modid2}/{w}/{h}/{file_name} Curseforge Avatar CDN endpoint (thumbnails)

参数

名称	位置	类型	必填	说明
`modid1`	路径	string	是	ModId segment 1
`modid2`	路径	string	是	ModId segment 2
`w`	路径	string	是	Thumbnail width
`h`	路径	string	是	Thumbnail height
`file_name`	路径	string	是	Thumbnail file name

响应

状态码	说明	结构
`302`	Curseforge Avatar Thumbnail Redirect
`500`	Internal server error

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/avatars/thumbnails/29/69/256/256/635838945588716414.jpeg'

在 Swagger 中查看

GET/avatars/{modid1}/{modid2}/{file_name} Curseforge Avatar CDN endpoint (flat)

参数

名称	位置	类型	必填	说明
`modid1`	路径	string	是	ModId segment 1 of avatar path
`modid2`	路径	string	是	ModId segment 2 of avatar path
`file_name`	路径	string	是	Avatar file name

响应

状态码	说明	结构
`302`	Curseforge Avatar Redirect
`500`	Internal server error

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/avatars/29/69/635838945588716414.jpeg'

在 Swagger 中查看

GET/data/{project_id}/versions/{version_id}/{file_name} Modrinth File CDN endpoint

参数

名称	位置	类型	必填	说明
`project_id`	路径	string	是	Project ID of the Modrinth project
`version_id`	路径	string	是	Version ID of the Modrinth project
`file_name`	路径	string	是	Name of the file to be downloaded

响应

状态码	说明	结构
`302`	Modrinth File Redirect
`500`	Internal server error

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/data/AANobbMI/versions/ygf8cVZg/sodium-fabric-0.5.11+mc1.20.1.jar'

在 Swagger 中查看

GET/data/{project_id}/{file_name} Modrinth Icon CDN

参数

名称	位置	类型	必填	说明	值
`project_id`	路径	string	是	Project ID of the Modrinth project
`file_name`	路径	string	是	Icon file name

响应

状态码	说明	结构
`302`	Modrinth Icon Redirect
`500`	Internal server error

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/data/AANobbMI/295862f4724dc3f78df3447ad6072b2dcd3ef0c9_96.webp'

在 Swagger 中查看

GET/files/{file_id1}/{file_id2}/{file_name} Curseforge File CDN endpoint

参数

名称	位置	类型	必填	说明
`file_id1`	路径	integer	是	First part of the Curseforge file ID
`file_id2`	路径	integer	是	Second part of the Curseforge file ID
`file_name`	路径	string	是	Name of the file to be downloaded

响应

状态码	说明	结构
`302`	Curseforge File Redirect
`500`	Internal server error

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/files/8937/628/jei-26.1.2-neoforge-29.40.0.101.jar'

在 Swagger 中查看

Common

GET/healthz Health check endpoint for the MCIM API

参数

无参数

响应

状态码	说明	结构
`200`	Health check message

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/healthz'

在 Swagger 中查看

GET/statistics Get statistics for CurseForge and Modrinth

参数

名称	位置	类型	必填	说明
`curseforge`	查询	boolean	否	Include CurseForge statistics
`modrinth`	查询	boolean	否	Include Modrinth statistics
`translate`	查询	boolean	否	Include translation statistics

响应

状态码	说明	结构
`200`	Statistics retrieved successfully	`StatisticsResponse`
`500`	Internal server error

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/statistics'

在 Swagger 中查看

Root

GET/ Root endpoint for the MCIM API

参数

无参数

响应

状态码	说明	结构
`200`	Welcome message

示例请求

改上面的值，命令会跟着变

curl 'https://mod.mcimirror.top/'

在 Swagger 中查看