A TypeScript API client for the Modrinth v2 API (TokenAuth, staging and production support, custom HTTP layer).
- Node.js 22 or newer (Node 22+). Older Node versions are not supported.
- pnpm is the preferred package manager (works with npm/yarn in most cases).
pnpm add librinthnpm install librinth
# or
yarn add librinthconst Librinth = require('librinth');
const client = new Librinth({ token: process.env.MODRINTH_TOKEN });
await client.getProject('sodium');import Librinth from 'librinth';
const client = new Librinth({ token: process.env.MODRINTH_TOKEN });
const project = await client.getProject('sodium');- pnpm is recommended for development and CI, but npm and yarn are supported for consumers.
- The library ships with TypeScript types.
- Default behavior and API surface are intentionally small and stable.
- Code license: MIT — Copyright (c) 2025 Keira Hopkins and contributors. See LICENSE.
- Modrinth content and assets: This project uses and references content hosted on or originating from Modrinth. We adhere to Modrinth's terms and copyright policies. All appropriate rights and ownership of Modrinth-hosted assets remain with Modrinth and the original creators; this project does not claim ownership of those assets. If you use or redistribute Modrinth-hosted content, ensure you follow Modrinth's licensing and attribution requirements. See https://modrinth.com and https://docs.modrinth.com for details.
- Keep changes small and focused.
- Run linters and tests before opening PRs.
- Follow repository contribution guidelines.
- Modrinth: https://modrinth.com
- Modrinth API docs: https://docs.modrinth.com
- Repo: https://github.com/NotKeira/librinth