modrinth.search

stable Advanced

Search Modrinth projects.

GET /v1/modrinth/search

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#

Name	Type	Required	Default	What it is	Constraints
`q`	string	yes	(required)	Search text	max 100 chars; must match `[^\x00-\x1f]{1,100}`; trimmed, repeated spaces collapsed

Request#

curl "https://api.onekey.dev/v1/modrinth/search?q=shaders" \
  -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": "JAXaHjHg",
        "name": "Shaders",
        "description": "A client-side Fabric mod that adds customizable animated rainbow and gradient outline effects to Minecraft entities, players, and held items for visual customization.",
        "slug": "shaders-frqmelikescheese",
        "type": "mod",
        "stats": {
          "downloads": 1537,
          "followers": 2
        },
        "updatedAt": "2026-06-22T07:24:37Z"
      },
      "author": {
        "username": "Frqme"
      },
      "media": {
        "thumbnailUrl": "https://cdn.modrinth.com/data/JAXaHjHg/7144cea7a0a95de5d1dd937379ced57d30176edd_96.webp"
      },
      "content": {
        "createdAt": "2026-07-19T02:06:35Z"
      },
      "package": {
        "version": "pt66Vy1I"
      }
    },
    {
      "entity": {
        "id": "YL57xq9U",
        "name": "Iris Shaders",
        "description": "A modern shader pack loader for Minecraft intended to be compatible with existing OptiFine shader packs",
        "slug": "iris",
        "type": "mod",
        "stats": {
          "downloads": 180431998,
          "followers": 29504
        },
        "updatedAt": "2026-09-15T18:18:23Z"
      },
      "author": {
        "username": "coderbot"
      },
      "media": {
        "thumbnailUrl": "https://cdn.modrinth.com/data/YL57xq9U/18d0e7f076d3d6ed5bedd472b853909aac5da202_96.webp"
      },
      "content": {
        "createdAt": "2021-05-27T05:11:15Z"
      },
      "package": {
        "version": "bAdKrpw8"
      }
    }
  ],
  "metadata": {
    "platform": "modrinth",
    "endpoint": "search",
    "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 path	Onekey field	Transform
`project_id`	`entity.id`	-
`title`	`entity.name`	-
`description`	`entity.description`	-
`slug`	`entity.slug`	-
`project_type`	`entity.type`	-
`author`	`author.username`	-
`downloads`	`entity.stats.downloads`	`toNumber`
`follows`	`entity.stats.followers`	`toNumber`
`icon_url`	`media.thumbnailUrl`	`safeUrl`
`date_created`	`content.createdAt`	`toIsoDate`
`date_modified`	`entity.updatedAt`	`toIsoDate`
`latest_version`	`package.version`	-

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#

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`	Unknown endpoint path.
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).