# Modrinth on Onekey

> 10 endpoints for Modrinth (10 stable, 0 beta), 1 to 5 credits each. Category: Gaming. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.

Page: https://onekey.dev/platforms/modrinth
Reference (Markdown): https://onekey.dev/docs/api/modrinth.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 10 mapped Modrinth endpoints return each:

- `entity.type` (string): 7
- `content.createdAt` (ISO 8601 date): 6
- `entity.id` (string): 6
- `entity.name` (string): 6
- `entity.stats.downloads` (integer): 6
- `author.id` (string): 5
- `entity.description` (string): 4
- `entity.slug` (string): 4
- `media.thumbnailUrl` (URL): 4
- `package.version` (string): 4
- `author.username` (string): 3
- `content.text` (string): 3
- `entity.stats.followers` (integer): 3
- `author.avatarUrl` (URL): 2
- `entity.updatedAt` (ISO 8601 date): 2
- `package.license` (string): 1
- plus 10 platform-specific fields under `ext.`

## Endpoints

### modrinth.game_versions

Minecraft versions known to Modrinth.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/modrinth/game_versions` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `package.version`, `entity.type`, `content.createdAt`, `ext.major`
- Reference: https://onekey.dev/docs/api/modrinth/game_versions.md

### modrinth.members

Team members of a Modrinth project.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/modrinth/members?project=sodium` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `project` (string, required): Project slug or id, e.g. sodium
- Fields returned: `author.id`, `author.username`, `author.avatarUrl`, `ext.role`
- Reference: https://onekey.dev/docs/api/modrinth/members.md

### modrinth.project

Fetch a Modrinth project (mod, plugin, pack...).
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/modrinth/project?project=sodium` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `project` (string, required): Project slug or id, e.g. sodium
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `entity.slug`, `entity.type`, `entity.stats.downloads`, `entity.stats.followers`, `content.createdAt`, `entity.updatedAt`, `package.license`, `media.thumbnailUrl`, `author.id`, `ext.sourceUrl`, `ext.issuesUrl`, `ext.discordUrl`
- Reference: https://onekey.dev/docs/api/modrinth/project.md

### modrinth.random_projects

Ten random Modrinth projects.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/modrinth/random_projects` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `entity.slug`, `entity.type`, `entity.stats.downloads`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/modrinth/random_projects.md

### modrinth.search

Search Modrinth projects.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/modrinth/search?q=shaders` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search text
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `entity.slug`, `entity.type`, `author.username`, `entity.stats.downloads`, `entity.stats.followers`, `media.thumbnailUrl`, `content.createdAt`, `entity.updatedAt`, `package.version`
- Reference: https://onekey.dev/docs/api/modrinth/search.md

### modrinth.statistics

Global Modrinth statistics.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/modrinth/statistics` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `ext.projects`, `ext.versionCount`, `ext.authors`, `ext.fileCount`
- Reference: https://onekey.dev/docs/api/modrinth/statistics.md

### modrinth.user

Fetch a Modrinth user.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/modrinth/user?user=jellysquid3` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `user` (string, required): Modrinth username or id, e.g. jellysquid3
- Fields returned: `author.id`, `author.username`, `author.avatarUrl`, `content.text`, `content.createdAt`, `ext.role`
- Reference: https://onekey.dev/docs/api/modrinth/user.md

### modrinth.user_projects

Projects published by a Modrinth user.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/modrinth/user_projects?user=jellysquid3` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `user` (string, required): Modrinth username or id, e.g. jellysquid3
- Fields returned: `entity.id`, `entity.name`, `entity.description`, `entity.slug`, `entity.type`, `entity.stats.downloads`, `entity.stats.followers`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/modrinth/user_projects.md

### modrinth.version

Fetch a single Modrinth version by id.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/modrinth/version?id=NM9w06Kr` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `id` (string, required): Version id
- Fields returned: `entity.id`, `entity.name`, `package.version`, `entity.type`, `content.createdAt`, `entity.stats.downloads`, `content.text`, `author.id`, `ext.projectId`
- Reference: https://onekey.dev/docs/api/modrinth/version.md

### modrinth.versions

Versions (files) published for a Modrinth project.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/modrinth/versions?project=sodium` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `project` (string, required): Project slug or id, e.g. sodium
- Fields returned: `entity.id`, `entity.name`, `package.version`, `entity.type`, `content.createdAt`, `entity.stats.downloads`, `content.text`, `author.id`
- Reference: https://onekey.dev/docs/api/modrinth/versions.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/modrinth/project?project=sodium" \
  -H "x-api-key: YOUR_API_KEY"
```