modrinth.project

stable Standard

Fetch a Modrinth project (mod, plugin, pack...).

GET /v1/modrinth/project

What you get#

One Modrinth record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

Standard · 1 credit for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`project`	string	yes	(required)	Project slug or id, e.g. sodium	max 64 chars; must match `[A-Za-z0-9_-]{3,64}`; trimmed

Request#

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

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Modrinth response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": {
    "entity": {
      "id": "AANobbMI",
      "name": "Sodium",
      "description": "A high-performance rendering engine replacement for Minecraft, which greatly improves frame rates and reduces micro-stutter.",
      "slug": "sodium",
      "type": "mod",
      "stats": {
        "downloads": 232768908,
        "followers": 41156
      },
      "updatedAt": "2026-09-20T21:27:09Z"
    },
    "content": {
      "createdAt": "2021-01-03T00:53:34Z"
    },
    "package": {
      "license": "LicenseRef-Polyform-Shield-1.0.0"
    },
    "media": {
      "thumbnailUrl": "https://cdn.modrinth.com/data/AANobbMI/295862f4724dc3f78df3447ad6072b2dcd3ef0c9_96.webp"
    },
    "ext": {
      "sourceUrl": "https://github.com/CaffeineMC/sodium",
      "issuesUrl": "https://github.com/CaffeineMC/sodium/issues",
      "discordUrl": "https://caffeinemc.net/discord"
    },
    "author": {
      "id": "4reLOAKe"
    }
  },
  "metadata": {
    "platform": "modrinth",
    "endpoint": "project",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`id`	`entity.id`	-
`title`	`entity.name`	-
`description`	`entity.description`	-
`slug`	`entity.slug`	-
`project_type`	`entity.type`	-
`downloads`	`entity.stats.downloads`	`toNumber`
`followers`	`entity.stats.followers`	`toNumber`
`published`	`content.createdAt`	`toIsoDate`
`updated`	`entity.updatedAt`	`toIsoDate`
`license.id`	`package.license`	-
`icon_url`	`media.thumbnailUrl`	`safeUrl`
`source_url`	`ext.sourceUrl`	`safeUrl`
`issues_url`	`ext.issuesUrl`	`safeUrl`
`discord_url`	`ext.discordUrl`	`safeUrl`
`team`	`author.id`	-

Caching and freshness#

Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
Between 30 minutes and 6 hours the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
A "not found" is remembered for 5 minutes and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	That record does not exist. Free; do not retry.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).