Interface Project

Represents a project on Modrinth.

interface Project {
    additional_categories: string[];
    approved: null | string;
    body: string;
    body_url: null | string;
    categories: string[];
    client_side: string;
    color: null | number;
    description: string;
    discord_url: null | string;
    donation_urls: DonationUrl[];
    downloads: number;
    followers: number;
    gallery: GalleryItem[];
    game_versions: string[];
    icon_url: null | string;
    id: string;
    issues_url: null | string;
    license: License;
    loaders: string[];
    moderator_message: null | string;
    monetization_status: "monetized" | "demonetized" | "force-demonetized";
    project_type: string;
    published: string;
    queued: null | string;
    requested_status: null | string;
    server_side: string;
    slug: string;
    source_url: null | string;
    status: string;
    team: string;
    thread_id: string;
    title: string;
    updated: string;
    versions: string[];
    wiki_url: null | string;
}

Properties

additional_categories: string[]

A list of categories that are searchable but non-primary.

approved: null | string

The date the project’s status was set to an approved status.

body: string

A long-form description of the project.

body_url: null | string

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

Use body instead.

categories: string[]

A list of the categories that the project has.

client_side: string

The client-side support of the project.

color: null | number

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

description: string

A short description of the project.

discord_url: null | string

An optional invite link to the project’s Discord.

donation_urls: DonationUrl[]

A list of donation links for the project.

downloads: number

The total number of downloads of the project.

followers: number

The total number of users following the project.

gallery: GalleryItem[]

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

game_versions: string[]

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

icon_url: null | string

The URL of the project’s icon.

id: string

The ID of the project, encoded as a base62 string.

issues_url: null | string

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

license: License

The license of the project.

loaders: string[]

A list of all of the loaders supported by the project.

moderator_message: null | string

A message that a moderator sent regarding the project.

monetization_status: "monetized" | "demonetized" | "force-demonetized"

The monetization status of the project.

project_type: string

The project type of the project.

published: string

The date the project was published.

queued: null | string

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

requested_status: null | string

The requested status when submitting for review or scheduling the project for release.

server_side: string

The server-side support of the project.

slug: string

The slug of a project, used for vanity URLs.

source_url: null | string

An optional link to the source code of the project.

status: string

The status of the project.

team: string

The ID of the team that has ownership of this project.

thread_id: string

The ID of the moderation thread associated with this project.

title: string

The title or name of the project.

updated: string

The date the project was last updated.

versions: string[]

A list of the version IDs of the project (will never be empty unless draft status).

wiki_url: null | string

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