Get all of a project's dependencies

GET

/project/{id|slug}/dependencies

• Production server
• Staging server

Parameters

Path Parameters

id|slug

required

string

[
  "AABBCCDD",
  "my_project"
]

The ID or slug of the project

Responses

200

Expected response to a valid request

object

projects

Projects that the project depends upon

Array<object>

object

id

required

The ID of the project, encoded as a base62 string

string

AABBCCDD

team

required

The ID of the team that has ownership of this project

string

MMNNOOPP

title

required

The title or name of the project

string

description

required

A short sentence summarizing the project, no more than a sentence or two.

string

body

required

A long form description of the project

string

A long body describing my project in detail

status

required

The status of the project

string

Allowed values: approved archived rejected draft unlisted processing withheld scheduled private unknown

approved

project_type

required

The project type of the project

string

Allowed values: mod modpack resourcepack shader

mod

categories

required

A list of the featured categories that the project has.

Array<string>

[
  "technology",
  "adventure",
  "fabric"
]

additional_categories

required

A list of additional categories that the project also has. These are supplementary to the featured categories, and does not include them again.

Array<string>

[
  "technology",
  "adventure",
  "fabric"
]

environment

required

All the environments that versions of this project support. Not in any particular order, we recommend using the environment information on a version instead. For an explanation of each environment, see the blog post here: https://modrinth.com/news/article/new-environments/#new-system

Array<string>

Allowed values: client_and_server client_only client_only_server_optional singleplayer_only server_only server_only_client_optional dedicated_server_only client_or_server client_or_server_prefers_both unknown

[
  "client_and_server"
]

game_versions

required

A list of all of the game versions supported by the project

Array<string>

[
  "1.19",
  "1.19.1",
  "1.19.2",
  "1.19.3"
]

loaders

required

A list of all of the loaders supported by the project. These vary based on project type.

Array<string>

[
  "neoforge",
  "fabric"
]

versions

required

A list of the version IDs of the project

Array<string>

[
  "IIJJKKLL",
  "QQRRSSTT"
]

license

required

The license of the project

object

id

The SPDX license ID of a project

string

LGPL-3.0-or-later

name

The long name of a license

string

GNU Lesser General Public License v3 or later

url

The URL to this license

string

nullable

published

required

The date the project was created

string format: ISO-8601

updated

required

The date the latest version of the project was created

string format: ISO-8601

downloads

required

The total number of downloads of the project

integer

followers

required

The total number of users following the project

integer

gallery

required

A list of images that have been uploaded to the project’s gallery

Array<object>

object

url

required

The URL of the gallery image

string

https://cdn.modrinth.com/data/AABBCCDD/images/009b7d8d6e8bf04968a29421117c59b3efe2351a.png

featured

required

Whether the image is featured in the gallery

boolean

true

title

The title of the gallery image

string

nullable

My awesome screenshot!

description

The description of the gallery image

string

nullable

This awesome screenshot shows all of the blocks in my mod!

created

required

The date and time the gallery image was created

string format: ISO-8601

ordering

The order of the gallery image. Gallery images are sorted by this field and then alphabetically by title.

integer

0

thread_id

required

The ID of the moderation thread associated with this project

string

TTUUVVWW

monetization_status

required

string

Allowed values: monetized demonetized force-demonetized

slug

The slug of a project, used for vanity URLs. Regex: ^[\w!@$()`.+,"\-']{3,64}$

string

nullable

my_project

organization

The ID of the organization that owns this project

string

nullable

AABBCCDD

requested_status

The requested status when submitting for review or scheduling the project for release. Approved status refers to “Public” visibility.

string

nullable

Allowed values: approved archived unlisted private draft

approved

The date the project was first published

string format: ISO-8601

nullable

queued

The date the project’s status was submitted to moderators for review

string format: ISO-8601

nullable

icon_url

The URL of the project’s icon

string

nullable

https://cdn.modrinth.com/data/AABBCCDD/b46513nd83hb4792a9a0e1fn28fgi6090c1842639.png

raw_icon_url

The URL of the project’s icon without CDN transforms applied

string

nullable

https://cdn.modrinth.com/data/AABBCCDD/b46513nd83hb4792a9a0e1fn28fgi6090c1842639-raw.png

color

The RGB color of the project, automatically generated from the project icon

integer

nullable

8703084

issues_url

An optional link to where to submit bugs or issues with the project

string

nullable

https://github.com/modrinth/code/issues

source_url

An optional link to the source code of the project

string

nullable

https://github.com/modrinth/code

wiki_url

An optional link to the project’s wiki page or other relevant information

string

nullable

https://github.com/modrinth/code/wiki

discord_url

An optional invite link to the project’s discord.

string

nullable

https://discord.gg/modrinth

donation_urls

A list of donation links for the project

Array<object>

nullable

object

id

The ID of the donation platform

string

patreon

platform

The donation platform this link is to

string

Patreon

url

The URL of the donation platform and user

string

https://www.patreon.com/my_user

client_side

required

Deprecated - use environment instead.

string

Allowed values: required optional unsupported unknown

required

server_side

required

Deprecated - use environment instead.

string

Allowed values: required optional unsupported unknown

optional

body_url

Deprecated - The link to the long description of the project. Always null, only kept for legacy compatibility.

string

nullable

moderator_message

Deprecated - A message that a moderator sent regarding the project

object

message

The message that a moderator has left for the project

string

body

The longer body of the message that a moderator has left for the project

string

nullable

versions

Versions that the project depends upon

Array

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

environment

required

The environment a project or version supports. For an explanation of each environment, see the blog post here: https://modrinth.com/news/article/new-environments/#new-system

string

Allowed values: client_and_server client_only client_only_server_optional singleplayer_only server_only server_only_client_optional dedicated_server_only client_or_server client_or_server_prefers_both unknown

client_and_server

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

string

Allowed values: required-resource-pack optional-resource-pack sources-jar dev-jar javadoc-jar unknown signature

nullable

404

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