Class Modrinth

The main class for the Modrinth API

Example

import { Modrinth } from "typerinth";

const modrinth = new Modrinth();

modrinth.search("fabric").then(console.log);

Auth

generateAuthorizationUrl getToken

Miscellaneous

getStatistics

Other

constructor getApiUrl getOptions

Projects

checkProjectValidity getProject getProjects getRandomProjects search

Tags

getLicense getTag

Teams

getMultipleTeamMembers getProjectTeamMembers getTeamMembers

Users

getAuthUser getFollowedProjects getUser getUserProjects getUsers

Versions

getProjectVersions getVersion getVersionFromFileHash getVersions

Auth

generateAuthorizationUrl

  • generateAuthorizationUrl(
        clientId: string,
        redirectUri: string,
        scopes: AuthScope[],
    ): string

    Generate an authorization URL to get an authorization code

    Modrinth OAuth Guide

    Parameters

    • clientId: string

      The ID of the client

    • redirectUri: string

      The uri to redirect to with the authorization code (must be listed in the client's redirect URIs)

    • scopes: AuthScope[]

      The scopes to request authorization for (must be listed in the client's scopes)

    Returns string

    The URL to get the authorization code

    Example

    new Modrinth().generateAuthorizationUrl(
        CLIENT_ID,
        "https://example.com/auth/callback",
        [AuthScope.UserRead, AuthScope.PayoutsRead]
    );

getToken

  • getToken(
        code: string,
        clientId: string,
        redirectUri: string,
    ): Promise<GetTokenResponse>

    Get an access token from an authorization code

    (Rquest to https://api.modrinth.com/_internal/oauth/token)

    Modrinth OAuth Guide

    Parameters

    • code: string

      The authorization code gotten from the authorization URL

    • clientId: string

      The ID of the client

    • redirectUri: string

      The uri to redirect to after getting the token (must be listed in the client's redirect URIs)

    Returns Promise<GetTokenResponse>

    The access token and other token information

Miscellaneous

getStatistics

Other

constructor

  • new Modrinth(options?: MROptions): Modrinth

    Create a new Modrinth instance

    Parameters

    • options: MROptions = {}

      Options for the Modrinth instance

    Returns Modrinth

    Example

    const modrinth = new Modrinth({
        baseUrl: 'https://api.modrinth.com',
        apiVersion: 'v2',
        userAgent: 'AppName/Version',
        cache: {
            ttl: 600,
            checkperiod: 120,
            useCache: true,
        },
    });

getApiUrl

  • getApiUrl(): URL

    Get the base URL for the Modrinth API

    Returns URL

    The base URL for the Modrinth API

getOptions

  • getOptions(): MROptions

    Get the options for the Modrinth instance

    Returns MROptions

    The options for the Modrinth instance

Projects

checkProjectValidity

  • checkProjectValidity(projectId: string): Promise<boolean>

    Check if a project is valid

    Parameters

    • projectId: string

      The ID or slug of the project to check

    Returns Promise<boolean>

    Whether the project is valid

getProject

  • getProject(projectId: string): Promise<Project>

    Get a project by its ID or slug

    Parameters

    • projectId: string

      The ID or slug of the project to get

    Returns Promise<Project>

    The project with the given ID or slug

    Throws

    ProjectNotFoundError If the project with the given ID or slug does not exist

    Throws

    ApiError If an error occurs

    Throws

    UnexpectedApiError If an unexpected error occurs

getProjects

  • getProjects(projectIds: string[]): Promise<Project[]>

    Get multiple projects by their IDs or slugs

    Parameters

    • projectIds: string[]

      The IDs or slugs of the projects to get

    Returns Promise<Project[]>

    Throws

    ApiError If an error occurs

    Throws

    UnexpectedApiError If an unexpected error occurs

getRandomProjects

  • getRandomProjects(
        count:
            | 0
            | 1
            | 2
            | 3
            | 4
            | 5
            | 6
            | 7
            | 8
            | 9
            | 10
            | 11
            | 12
            | 13
            | 14
            | 15
            | 16
            | 17
            | 18
            | 19
            | 20
            | 21
            | 22
            | 23
            | 24
            | 25
            | 26
            | 27
            | 28
            | 29
            | 30
            | 31
            | 32
            | 33
            | 34
            | 35
            | 36
            | 37
            | 38
            | 39
            | 40
            | 41
            | 42
            | 43
            | 44
            | 45
            | 46
            | 47
            | 48
            | 49
            | 50
            | 51
            | 52
            | 53
            | 54
            | 55
            | 56
            | 57
            | 58
            | 59
            | 60
            | 61
            | 62
            | 63
            | 64
            | 65
            | 66
            | 67
            | 68
            | 69
            | 70
            | 71
            | 72
            | 73
            | 74
            | 75
            | 76
            | 77
            | 78
            | 79
            | 80
            | 81
            | 82
            | 83
            | 84
            | 85
            | 86
            | 87
            | 88
            | 89
            | 90
            | 91
            | 92
            | 93
            | 94
            | 95
            | 96
            | 97
            | 98
            | 99
            | 100,
    ): Promise<Project[]>

    Get a random selection of projects

    Parameters

    • count:
          | 0
          | 1
          | 2
          | 3
          | 4
          | 5
          | 6
          | 7
          | 8
          | 9
          | 10
          | 11
          | 12
          | 13
          | 14
          | 15
          | 16
          | 17
          | 18
          | 19
          | 20
          | 21
          | 22
          | 23
          | 24
          | 25
          | 26
          | 27
          | 28
          | 29
          | 30
          | 31
          | 32
          | 33
          | 34
          | 35
          | 36
          | 37
          | 38
          | 39
          | 40
          | 41
          | 42
          | 43
          | 44
          | 45
          | 46
          | 47
          | 48
          | 49
          | 50
          | 51
          | 52
          | 53
          | 54
          | 55
          | 56
          | 57
          | 58
          | 59
          | 60
          | 61
          | 62
          | 63
          | 64
          | 65
          | 66
          | 67
          | 68
          | 69
          | 70
          | 71
          | 72
          | 73
          | 74
          | 75
          | 76
          | 77
          | 78
          | 79
          | 80
          | 81
          | 82
          | 83
          | 84
          | 85
          | 86
          | 87
          | 88
          | 89
          | 90
          | 91
          | 92
          | 93
          | 94
          | 95
          | 96
          | 97
          | 98
          | 99
          | 100

      The number of projects to get (between 0 and 100)

    Returns Promise<Project[]>

    Throws

    ApiError If an error occurs

    Throws

    UnexpectedApiError If an unexpected error occurs

search

  • search(query: string, options?: SearchOptions): Promise<SearchResult>

    Search for projects

    Parameters

    • query: string

      The query to search for

    • Optionaloptions: SearchOptions

      Options for the search

    Returns Promise<SearchResult>

    The search results

    Throws

    ApiError If an error occurs

    Throws

    UnexpectedApiError If an unexpected error occurs

    Example

    const result = await modrinth.search('life', {
        limit: 3,
        index: SearchIndex.Downloads,
        facets: new SearchFacets(
            new FacetGroup(
                new Facet(FacetType.Categories, FacetOperation.EQUALS, 'forge')
            ),
            new FacetGroup(
                new Facet(FacetType.Versions, FacetOperation.EQUALS, '1.16.5'),
                new Facet(FacetType.Versions, FacetOperation.EQUALS, '1.17.1')
            )
        ),
    });

Tags

getLicense

getTag

Teams

getMultipleTeamMembers

  • getMultipleTeamMembers(teamIds: string[]): Promise<TeamMember[][]>

    Get the members of multiple teams

    Parameters

    • teamIds: string[]

      The IDs of the teams to get the members of

    Returns Promise<TeamMember[][]>

    The members of the teams with the given IDs

    Throws

    ApiError If an error occurs

    Throws

    UnexpectedApiError If an unexpected error occurs

getProjectTeamMembers

  • getProjectTeamMembers(projectId: string): Promise<TeamMember[]>

    Get the team members of a project

    Parameters

    • projectId: string

      The ID or slug of the project to get the team members of

    Returns Promise<TeamMember[]>

    The team members of the project with the given ID or slug

    Throws

    ProjectNotFoundError If the project with the given ID or slug does not exist

    Throws

    ApiError If an error occurs

    Throws

    UnexpectedApiError If an unexpected error occurs

getTeamMembers

  • getTeamMembers(teamId: string): Promise<TeamMember[]>

    Get the team members of a team

    Parameters

    • teamId: string

      The ID of the team to get the members of

    Returns Promise<TeamMember[]>

    The team members of the team with the given ID

    Throws

    ApiError If an error occurs

    Throws

    UnexpectedApiError If an unexpected error occurs

Users

getAuthUser

  • getAuthUser(): Promise<User>

    Get the user that is authenticated with the authorization header

    Rquires authorization with scope:

    USER_READ

    Returns Promise<User>

    The authenticated user

    Throws

    ApiError If an error occurs

    Throws

    UnexpectedApiError If an unexpected error occurs

getFollowedProjects

  • getFollowedProjects(userId: string): Promise<Project[]>

    Get the projects followed by a user

    Rquires authorization with scope:

    USER_READ

    Parameters

    • userId: string

      The ID or username of the user to get the followed projects of

    Returns Promise<Project[]>

    Throws

    UserNotFoundError If the user with the given ID or username does not exist

    Throws

    ApiError If an error occurs

getUser

  • getUser(userId: string): Promise<User>

    Get a user by their ID or username

    Parameters

    • userId: string

      The ID or username of the user to get

    Returns Promise<User>

    Throws

    UserNotFoundError If the user with the given ID or username does not exist

    Throws

    ApiError If an error occurs

    Throws

    UnexpectedApiError If an unexpected error occurs

getUserProjects

  • getUserProjects(userId: string): Promise<Project[]>

    Get a user's projects by their ID or username

    Parameters

    • userId: string

      The ID or username of the user

    Returns Promise<Project[]>

    Throws

    UserProjectsNotFoundError If the user's projects do not exist

    Throws

    ApiError If an error occurs

    Throws

    UnexpectedApiError If an unexpected error occurs

getUsers

  • getUsers(userIds: string[]): Promise<User[]>

    Get multiple users by their IDs or usernames

    Parameters

    • userIds: string[]

      The IDs or usernames of the users to get

    Returns Promise<User[]>

    Throws

    ApiError If an error occurs

    Throws

    UnexpectedApiError If an unexpected error occurs

Versions

getProjectVersions

getVersion

getVersionFromFileHash

getVersions

  • getVersions(versionIds: string[]): Promise<ProjectVersion[]>

    Get multiple versions by their IDs

    Parameters

    • versionIds: string[]

      The IDs of the versions to get

    Returns Promise<ProjectVersion[]>

    Throws

    ApiError If an error occurs

    Throws

    UnexpectedApiError If an unexpected error occurs

Settings

Member Visibility

On This Page

Auth
Miscellaneous
Other
Projects
Tags
Teams
Users
Versions