Skip to content

Interface Project

🏷️ Properties

body

ts
body: string

A long form description of the mod.

Defined in: packages/modrinth/types.ts:84

body_url

ts
body_url: string

DEPRECATED The link to the long description of the mod

Defined in: packages/modrinth/types.ts:88

categories

ts
categories: string[]

A list of the categories that the mod is in

Defined in: packages/modrinth/types.ts:122

client_side

ts
client_side: string

The support range for the client mod - required, optional, unsupported, or unknown

Defined in: packages/modrinth/types.ts:108

description

ts
description: string

A short description of the mod

Defined in: packages/modrinth/types.ts:80

discord_url

ts
discord_url: string

An optional link to the mod's discord

Defined in: packages/modrinth/types.ts:147

donation_urls

ts
donation_urls: DonationLink[]

An optional list of all donation links the mod has

Defined in: packages/modrinth/types.ts:151

downloads

ts
downloads: number

The total number of downloads the mod has

Defined in: packages/modrinth/types.ts:116

followers

ts
followers: number

Defined in: packages/modrinth/types.ts:118

ts
gallery: ProjectGallery[]

Defined in: packages/modrinth/types.ts:155

icon_url

ts
icon_url: string

The URL of the icon of the mod

Defined in: packages/modrinth/types.ts:131

id

ts
id: string

The ID of the mod, encoded as a base62 string

Defined in: packages/modrinth/types.ts:64

issues_url

ts
issues_url: string

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

Defined in: packages/modrinth/types.ts:135

license

ts
license: License

The license of the mod

Defined in: packages/modrinth/types.ts:104

loaders

ts
loaders: string[]

Defined in: packages/modrinth/types.ts:127

project_type

ts
project_type: string

Defined in: packages/modrinth/types.ts:153

published

ts
published: string

The date at which the mod was first published

Defined in: packages/modrinth/types.ts:92

server_side

ts
server_side: string

The support range for the server mod - required, optional, unsupported, or unknown

Defined in: packages/modrinth/types.ts:112

slug

ts
slug: string

The slug of a mod, used for vanity URLs

Defined in: packages/modrinth/types.ts:68

source_url

ts
source_url: string

An optional link to the source code for the mod

Defined in: packages/modrinth/types.ts:139

status

ts
status: string

The status of the mod - approved, rejected, draft, unlisted, processing, or unknown

Defined in: packages/modrinth/types.ts:100

team

ts
team: string

The id of the team that has ownership of this mod

Defined in: packages/modrinth/types.ts:72

title

ts
title: string

The title or name of the mod

Defined in: packages/modrinth/types.ts:76

updated

ts
updated: string

The date at which the mod was updated

Defined in: packages/modrinth/types.ts:96

versions

ts
versions: string[]

A list of ids for versions of the mod

Defined in: packages/modrinth/types.ts:126

wiki_url

ts
wiki_url: string

An optional link to the mod's wiki page or other relevant information

Defined in: packages/modrinth/types.ts:143

Released under the MIT License.