Docs
View as Markdown

modrinth.user_projects

stable Advanced

Projects published by a Modrinth user.

GET /v1/modrinth/user_projects

What you get#

A list of Modrinth results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

  • Advanced · 5 credits 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#

NameTypeRequiredDefaultWhat it isConstraints
userstringyes(required)Modrinth username or id, e.g. jellysquid3max 40 chars; must match [A-Za-z0-9_-]{2,40}; trimmed, leading @ removed

Request#

curl "https://api.onekey.dev/v1/modrinth/user_projects?user=jellysquid3" \
  -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": "hEOCdOgW",
        "name": "Phosphor",
        "description": "No-compromises lighting engine optimization mod",
        "slug": "phosphor",
        "type": "mod",
        "stats": {
          "downloads": 865923,
          "followers": 2838
        }
      },
      "media": {
        "thumbnailUrl": "https://cdn.modrinth.com/data/hEOCdOgW/488f485c87650df9a3f1dab9dca0e95b0be9804f_96.webp"
      }
    },
    {
      "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
        }
      },
      "media": {
        "thumbnailUrl": "https://cdn.modrinth.com/data/AANobbMI/295862f4724dc3f78df3447ad6072b2dcd3ef0c9_96.webp"
      }
    }
  ],
  "metadata": {
    "platform": "modrinth",
    "endpoint": "user_projects",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "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 pathOnekey fieldTransform
identity.id-
titleentity.name-
descriptionentity.description-
slugentity.slug-
project_typeentity.type-
downloadsentity.stats.downloadstoNumber
followersentity.stats.followerstoNumber
icon_urlmedia.thumbnailUrlsafeUrl

Caching and freshness#

  • Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
  • Between 2 minutes and 15 minutes 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 hour more (marked stale).
  • A "not found" is remembered for 1 minute and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).