Interface SearchHit

Represents a search hit from the search endpoint.

interface SearchHit {
    author: string;
    categories: string[];
    client_side: string;
    color: null | number;
    date_created: string;
    date_modified: string;
    description: string;
    display_categories: string[];
    downloads: number;
    featured_gallery: null | string;
    follows: number;
    gallery: string[];
    icon_url: null | string;
    latest_version: string;
    license: string;
    monetization_status: "monetized" | "demonetized" | "force-demonetized";
    project_id: string;
    project_type: string;
    server_side: string;
    slug: string;
    thread_id: string;
    title: string;
    versions: string[];
}

Properties

author: string

The username of the project’s author

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

date_created: string

The date the project was added to search

date_modified: string

The date the project was last modified

description: string

A short description of the project

display_categories: string[]

A list of the categories that the project has which are not secondary

downloads: number

The total number of downloads of the

featured_gallery: null | string

The featured gallery image of the project

follows: number

The total number of users following the project

gallery: string[]

All gallery images attached to the project

icon_url: null | string

The URL of the project’s icon

latest_version: string

The latest version of minecraft that this project supports

license: string

The SPDX license ID of a project

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

The monetization status of the project.

project_id: string

The ID of the project

project_type: string

The project type of the project

server_side: string

The server side support of the project

slug: string

The slug of a project, used for vanity URLs

thread_id: string

The ID of the moderation thread associated with this project

title: string

The title or name of the project

versions: string[]

A list of the minecraft versions supported by the project