Skip to content
Modrinth Documentation

Get a version given a version number or ID

GET
/project/{id|slug}/version/{id|number}

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

Parameters

Path Parameters

id|slug
required
string
[
  "AABBCCDD",
  "my_project"
]

The ID or slug of the project

id|number
required
string
[
  "IIJJKKLL"
]

The version ID or version number

Responses

200

Expected response to a valid request

object
name

The name of this version

string
Version 1.0.0
version_number

The version number. Ideally will follow semantic versioning

string
1.0.0
changelog

The changelog for this version

string
nullable 
List of changes in this version: ...
dependencies

A list of specific versions of projects that this version depends on

Array<object>
object
version_id

The ID of the version that this version depends on

string
nullable 
IIJJKKLL
project_id

The ID of the project that this version depends on

string
nullable 
QQRRSSTT
file_name

The file name of the dependency, mostly used for showing external dependencies on modpacks

string
nullable 
sodium-fabric-mc1.19-0.4.2+build.16.jar
dependency_type
required

The type of dependency that this version has

string
Allowed values: required optional incompatible embedded 
required
game_versions

A list of versions of Minecraft that this version supports

Array<string>
[
  "1.16.5",
  "1.17.1"
]
version_type

The release channel for this version

string
Allowed values: release beta alpha 
release
loaders

The mod loaders that this version supports. In case of resource packs, use “minecraft”

Array<string>
[
  "fabric",
  "forge",
  "minecraft"
]
featured

Whether the version is featured or not

boolean
true
status
string
Allowed values: listed archived draft unlisted scheduled unknown 
listed
requested_status
string
nullable
Allowed values: listed archived draft unlisted
id
required

The ID of the version, encoded as a base62 string

string
IIJJKKLL
project_id
required

The ID of the project this version is for

string
AABBCCDD
author_id
required

The ID of the author who published this version

string
EEFFGGHH
date_published
required
string format: ISO-8601
downloads
required

The number of times this version has been downloaded

integer
changelog_url

A link to the changelog for this version. Always null, only kept for legacy compatibility.

string
nullable
files
required

A list of files available for download for this version

Array<object>
object
hashes
required

A map of hashes of the file. The key is the hashing algorithm and the value is the string version of the hash.

object
sha512
string
93ecf5fe02914fb53d94aa3d28c1fb562e23985f8e4d48b9038422798618761fe208a31ca9b723667a4e05de0d91a3f86bcd8d018f6a686c39550e21b198d96f
sha1
string
c84dd4b3580c02b79958a0590afd5783d80ef504
url
required

A direct link to the file

string
https://cdn.modrinth.com/data/AABBCCDD/versions/1.0.0/my_file.jar
filename
required

The name of the file

string
my_file.jar
primary
required

Whether this file is the primary one for its version. Only a maximum of one file per version will have this set to true. If there are not any primary files, it can be inferred that the first file is the primary one.

boolean
size
required

The size of the file in bytes

integer
1097270
file_type

The type of the additional file, used mainly for adding resource packs to datapacks

string
nullable
Allowed values: required-resource-pack optional-resource-pack 
required-resource-pack

404

The requested item(s) were not found or no authorization to access the requested item(s)