{"openapi":"3.1.0","info":{"title":"Modrinth Minecraft Mods API","version":"1.0.0","description":"Live mod-platform stats from Modrinth, the open Minecraft content platform — no key, nothing stored. The adoption-and-community view of the Minecraft modding ecosystem: how much each mod, modpack, shader or resource pack is downloaded and followed, and which projects are most popular, distinct from the other developer-ecosystem and gaming APIs in the catalogue. The project endpoint returns a single project in full — total downloads, followers, type, categories, supported game versions and loaders, client/server sides and license. The search endpoint searches projects, filterable by type (mod, modpack, shader, resource pack, data pack) and sortable by downloads or follows, each with its download and follower count. The versions endpoint returns a project's recent releases with per-version downloads, supported game versions and loaders. Build mod dashboards, popularity trackers, \"is this mod maintained\" widgets and modpack browsers on top of real Modrinth data. Look up a project by its slug (sodium, iris, fabric-api); downloads are the headline popularity metric.","contact":{"name":"PremiumApi","url":"https://www.oanor.com/by/premiumapi"}},"servers":[{"url":"https://api.oanor.com/modrinth-api","description":"oanor gateway"}],"tags":[{"name":"Project"},{"name":"Search"},{"name":"Versions"},{"name":"Meta"},{"name":"Projects"},{"name":"Creators"}],"components":{"securitySchemes":{"oanorKey":{"type":"apiKey","in":"header","name":"x-oanor-key","description":"Get your key at https://www.oanor.com/developer/keys"}}},"security":[{"oanorKey":[]}],"paths":{"/v1/project":{"get":{"operationId":"get_v1_project","tags":["Project"],"summary":"A project in full","description":"","parameters":[{"name":"slug","in":"query","required":true,"description":"Project slug","schema":{"type":"string"},"example":"sodium"}],"security":[{"oanorKey":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":{"url":"https://modrinth.com/mod/sodium","slug":"sodium","title":"Sodium","source":"Modrinth","license":"LicenseRef-Polyform-Shield-1.0.0","loaders":["fabric","neoforge","quilt"],"updated":"2026-06-12T00:47:33.259264Z","downloads":166010755,"followers":37192,"published":"2021-01-03T00:53:34.185936Z","categories":["optimization"],"client_side":"required","server_side":"unsupported","project_type":"mod","latest_game_version":"26.2-rc-1","supported_game_versions":36},"meta":{"timestamp":"2026-06-12T01:42:09.988Z","request_id":"84042f4a-6135-4961-bdf1-4b9f6c4910ab"},"status":"ok","message":"Project retrieved successfully","success":true}}}},"401":{"description":"Missing or invalid x-oanor-key header"},"402":{"description":"Active subscription required"},"429":{"description":"Rate-limit or monthly quota reached"},"502":{"description":"Upstream did not respond"}}}},"/v1/search":{"get":{"operationId":"get_v1_search","tags":["Search"],"summary":"Search projects","description":"","parameters":[{"name":"q","in":"query","required":true,"description":"Search query","schema":{"type":"string"},"example":"shaders"},{"name":"type","in":"query","required":false,"description":"mod, modpack, shader, resourcepack, datapack or plugin","schema":{"type":"string"},"example":"shader"},{"name":"sort","in":"query","required":false,"description":"relevance (default), downloads, follows, newest or updated","schema":{"type":"string"},"example":"downloads"},{"name":"limit","in":"query","required":false,"description":"Max results (1-25)","schema":{"type":"string"},"example":"10"}],"security":[{"oanorKey":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":{"sort":"downloads","type":"shader","count":10,"query":"shaders","total":156,"source":"Modrinth","results":[{"slug":"complementary-reimagined","title":"Complementary Shaders - Reimagined","author":"EminGT","downloads":51705265,"followers":9704,"categories":["atmosphere","bloom","cartoon","colored-lighting","fantasy","foliage","high","iris","low","medium","optifine","pbr","potato","reflections","shadows","vanilla-like"],"project_type":"shader","latest_game_version":"yCCduG44"},{"slug":"complementary-unbound","title":"Complementary Shaders - Unbound","author":"EminGT","downloads":33224978,"followers":5205,"categories":["atmosphere","bloom","cartoon","colored-lighting","fantasy","foliage","high","iris","low","medium","optifine","pbr","potato","reflections","semi-realistic","shadows"],"project_type":"shader","latest_game_version":"VMHXIk50"},{"slug":"bsl-shaders","title":"BSL Shaders","author":"CaptTatsu","downloads":23488683,"followers":5633,"categories":["atmosphere","bloom","cartoon","colored-lighting","foliage","iris","low","optifine","pbr","reflections","shadows"],"project_type":"shader","latest_game_version":"hIibTfxn"},{"slug":"photon-shader","title":"Photon Shaders","author":"sixthsurge","downloads":19628723,"followers":3601,"categories":["atmosphere","bloom","colored-lighting","foliage","high","iris","low","medium","optifine","pbr","reflections","semi-realistic","shadows"],"project_type":"shader","latest_game_version":"gUv7fBPN"},{"slug":"bliss-shader","title":"Bliss Shaders","author":"Xonk","downloads":10706783,"followers":2495,"categories":["atmosphere","bloom","colored-lighting","fantasy","foliage","high","iris","low","medium","optifine","pbr","reflections","screenshot","semi-realistic","shadows"],"project_type":"shader","latest_game_version":"kC2Y8q1P"},{"slug":"makeup-ultra-fast-shaders","title":"MakeUp - Ultra Fast","author":"KDXavier","downloads":9378104,"followers":2074,"categories":["atmosphere","bloom","fantasy","foliage","iris","low","medium","optifine","potato","reflections","semi-realistic","shadows"],"project_type":"shader","latest_game_version":"V5pgSLtI"},{"slug":"pastel-shaders","title":"Pastel Shaders","author":"ElocinDev","downloads":4234209,"followers":447,"categories":["iris","optifine"],"project_type":"shader","latest_game_version":"w3Pxx3b4"},{"slug":"astralex","title":"AstraLex Shaders","author":"LexBoosT","downloads":3604204,"followers":1076,"categories":["atmosphere","bloom","cartoon","colored-lighting","fantasy","foliage","iris","medium","optifine","pbr","reflections","shadows"],"project_type":"shader","latest_game_version":"qSbtQS2o"},{"slug":"hysteria-shaders","title":"Hysteria Shaders","author":"ElocinDev","downloads":2688365,"followers":514,"categories":["atmosphere","bloom","colored-lighting","fantasy","foliage","iris","medium","optifine","pbr","potato","reflections","shadows"],"project_type":"shader","latest_game_version":"u7oNAXa5"},{"slug":"spooklementary","title":"Spooklementary","author":"SpacEagle17","downloads":2212356,"followers":702,"categories":["atmosphere","bloom","fantasy","foliage","high","iris","low","medium","optifine","pbr","reflections","shadows"],"project_type":"shader","latest_game_version":"rcr90eRP"}]},"meta":{"timestamp":"2026-06-12T01:42:10.254Z","request_id":"95492071-32e8-42a4-8e51-56cc6fb65a00"},"status":"ok","message":"Search retrieved successfully","success":true}}}},"401":{"description":"Missing or invalid x-oanor-key header"},"402":{"description":"Active subscription required"},"429":{"description":"Rate-limit or monthly quota reached"},"502":{"description":"Upstream did not respond"}}}},"/v1/versions":{"get":{"operationId":"get_v1_versions","tags":["Versions"],"summary":"A project's recent releases","description":"","parameters":[{"name":"slug","in":"query","required":true,"description":"Project slug","schema":{"type":"string"},"example":"sodium"},{"name":"limit","in":"query","required":false,"description":"Max versions (1-50)","schema":{"type":"string"},"example":"15"}],"security":[{"oanorKey":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":{"slug":"sodium","count":15,"source":"Modrinth","versions":[{"name":"Sodium 0.9.0-beta.2 for Fabric 26.2-rc-1","loaders":["fabric"],"featured":false,"downloads":64,"version_type":"beta","game_versions":["26.2-rc-1"],"date_published":"2026-06-12T00:47:33.259264Z","version_number":"mc26.2-rc-1-0.9.0-beta.2-fabric"},{"name":"Sodium 0.9.0-beta.1 for Fabric 26.2-rc-1","loaders":["fabric"],"featured":false,"downloads":285,"version_type":"beta","game_versions":["26.2-rc-1"],"date_published":"2026-06-11T21:42:56.402555Z","version_number":"mc26.2-rc-1-0.9.0-beta.1-fabric"},{"name":"Sodium 0.8.12-alpha.4 for Fabric 1.21.1","loaders":["fabric"],"featured":false,"downloads":244756,"version_type":"alpha","game_versions":["1.21.1"],"date_published":"2026-05-25T13:19:01.423143Z","version_number":"mc1.21.1-0.8.12-alpha.4-fabric"},{"name":"Sodium 0.8.12-alpha.4 for NeoForge 1.21.1","loaders":["neoforge"],"featured":false,"downloads":295873,"version_type":"alpha","game_versions":["1.21.1"],"date_published":"2026-05-25T13:19:01.387557Z","version_number":"mc1.21.1-0.8.12-alpha.4-neoforge"},{"name":"Sodium 0.8.12 for NeoForge 1.21.11","loaders":["neoforge"],"featured":false,"downloads":78238,"version_type":"release","game_versions":["1.21.11"],"date_published":"2026-05-18T22:12:49.426653Z","version_number":"mc1.21.11-0.8.12-neoforge"},{"name":"Sodium 0.8.12 for Fabric 1.21.11","loaders":["fabric"],"featured":false,"downloads":1427942,"version_type":"release","game_versions":["1.21.11"],"date_published":"2026-05-18T22:12:48.468154Z","version_number":"mc1.21.11-0.8.12-fabric"},{"name":"Sodium 0.8.12 for Fabric 26.1.2","loaders":["fabric"],"featured":false,"downloads":1739077,"version_type":"release","game_versions":["26.1.2"],"date_published":"2026-05-18T22:12:28.474147Z","version_number":"mc26.1.2-0.8.12-fabric"},{"name":"Sodium 0.8.12 for NeoForge 26.1.2","loaders":["neoforge"],"featured":false,"downloads":177234,"version_type":"release","game_versions":["26.1.2"],"date_published":"2026-05-18T22:12:28.453346Z","version_number":"mc26.1.2-0.8.12-neoforge"},{"name":"Sodium 0.8.12-beta.4 for Fabric 26.1.2","loaders":["fabric"],"featured":false,"downloads":271435,"version_type":"beta","game_versions":["26.1.2"],"date_published":"2026-05-14T12:38:04.031677Z","version_number":"mc26.1.2-0.8.12-beta.4-fabric"},{"name":"Sodium 0.8.12-beta.4 for NeoForge 26.1.2","loaders":["neoforge"],"featured":false,"downloads":29562,"version_type":"beta","game_versions":["26.1.2"],"date_published":"2026-05-14T12:38:04.007023Z","version_number":"mc26.1.2-0.8.12-beta.4-neoforge"},{"name":"Sodium 0.8.12-beta.3 for NeoForge 1.21.11","loaders":["neoforge"],"featured":false,"downloads":16450,"version_type":"beta","game_versions":["1.21.11"],"date_published":"2026-05-14T00:07:47.190866Z","version_number":"mc1.21.11-0.8.12-beta.3-neoforge"},{"name":"Sodium 0.8.12-beta.3 for Fabric 1.21.11","loaders":["fabric"],"featured":false,"downloads":290054,"version_type":"beta","game_versions":["1.21.11"],"date_published":"2026-05-14T00:07:47.169126Z","version_number":"mc1.21.11-0.8.12-beta.3-fabric"},{"name":"Sodium 0.8.12-alpha.3 for Fabric 1.21.1","loaders":["fabric"],"featured":false,"downloads":152188,"version_type":"alpha","game_versions":["1.21.1"],"date_published":"2026-05-13T23:41:04.808660Z","version_number":"mc1.21.1-0.8.12-alpha.3-fabric"},{"name":"Sodium 0.8.12-alpha.2 for NeoForge 1.21.1","loaders":["neoforge"],"featured":false,"downloads":216808,"version_type":"alpha","game_versions":["1.21.1"],"date_published":"2026-05-13T23:29:44.454608Z","version_number":"mc1.21.1-0.8.12-alpha.2-neoforge"},{"name":"Sodium 0.8.12-alpha.2 for Fabric 1.21.1","loaders":["fabric"],"featured":false,"downloads":2727,"version_type":"alpha","game_versions":["1.21.1"],"date_published":"2026-05-13T23:29:44.435940Z","version_number":"mc1.21.1-0.8.12-alpha.2-fabric"}]},"meta":{"timestamp":"2026-06-12T01:42:10.539Z","request_id":"bea6ca4f-d4b4-4dee-b455-2c9a908e870d"},"status":"ok","message":"Versions retrieved successfully","success":true}}}},"401":{"description":"Missing or invalid x-oanor-key header"},"402":{"description":"Active subscription required"},"429":{"description":"Rate-limit or monthly quota reached"},"502":{"description":"Upstream did not respond"}}}},"/v1/meta":{"get":{"operationId":"get_v1_meta","tags":["Meta"],"summary":"Service metadata","description":"","parameters":[],"security":[{"oanorKey":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":{"note":"Look up a project by its slug (slug=sodium, iris, fabric-api). search accepts type=mod|modpack|shader|resourcepack|datapack and sort=downloads|follows|newest|updated|relevance. Downloads is the headline popularity metric.","source":"Modrinth public API (api.modrinth.com/v2, live)","service":"modrinth-api","endpoints":{"GET /v1/meta":"This document.","GET /v1/search":"Search projects (q=shaders, type=shader, sort=downloads).","GET /v1/project":"A project in full — downloads, followers, type, loaders (slug=sodium).","GET /v1/versions":"A project's recent releases with per-version downloads (slug=sodium)."},"description":"Live mod-platform stats from Modrinth, the open Minecraft content platform. The adoption-and-community view of the Minecraft modding ecosystem — how much each mod, modpack, shader or resource pack is downloaded and followed, and which projects are most popular. project = a single project in full (downloads, followers, type, categories, supported game versions and loaders, sides, license); search = search projects filterable by type and sortable by downloads or follows; versions = a project's recent releases with per-version downloads, game versions and loaders. Live, no key, nothing stored. Distinct from the other developer-ecosystem and gaming APIs.","upstream_status":"ok","sodium_downloads":166010755},"meta":{"timestamp":"2026-06-12T01:42:10.637Z","request_id":"943b91a4-5375-4e8d-9d02-8da6a77c6eab"},"status":"ok","message":"Meta","success":true}}}},"401":{"description":"Missing or invalid x-oanor-key header"},"402":{"description":"Active subscription required"},"429":{"description":"Rate-limit or monthly quota reached"},"502":{"description":"Upstream did not respond"}}}},"/v1/dependencies":{"get":{"operationId":"get_v1_dependencies","tags":["Projects"],"summary":"The projects a project depends on","description":"","parameters":[{"name":"slug","in":"query","required":true,"description":"Project slug","schema":{"type":"string"},"example":"sodium"}],"security":[{"oanorKey":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":{"slug":"sodium","count":2,"source":"Modrinth","dependencies":[{"slug":"canvas","title":"Canvas Renderer","downloads":60193,"project_type":"mod"},{"slug":"notenoughcrashes","title":"Not Enough Crashes","downloads":11404971,"project_type":"mod"}]},"meta":{"timestamp":"2026-06-13T13:54:18.227Z","request_id":"d542d0fc-0c81-4147-879d-8bf09169c0b8"},"status":"ok","message":"Dependencies retrieved successfully","success":true}}}},"401":{"description":"Missing or invalid x-oanor-key header"},"402":{"description":"Active subscription required"},"429":{"description":"Rate-limit or monthly quota reached"},"502":{"description":"Upstream did not respond"}}}},"/v1/members":{"get":{"operationId":"get_v1_members","tags":["Projects"],"summary":"The team behind a project","description":"","parameters":[{"name":"slug","in":"query","required":true,"description":"Project slug","schema":{"type":"string"},"example":"sodium"}],"security":[{"oanorKey":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":{"slug":"sodium","count":3,"source":"Modrinth","members":[{"role":"Maintainer","avatar":"https://avatars3.githubusercontent.com/u/31803019?v=4","user_id":"DzLrfrbK","username":"IMS"},{"role":"Project Lead","avatar":"https://cdn.modrinth.com/user/TEZXhE2U/f4705a5f2388c65029ae2e59f1434b3e6e4de23a.png","user_id":"TEZXhE2U","username":"jellysquid3"},{"role":"Maintainer","avatar":"https://avatars.githubusercontent.com/u/17120022?v=4","user_id":"PSleyMoH","username":"douira"}]},"meta":{"timestamp":"2026-06-13T13:54:18.540Z","request_id":"c9af746b-b731-4b94-8410-0372f232ab73"},"status":"ok","message":"Members retrieved successfully","success":true}}}},"401":{"description":"Missing or invalid x-oanor-key header"},"402":{"description":"Active subscription required"},"429":{"description":"Rate-limit or monthly quota reached"},"502":{"description":"Upstream did not respond"}}}},"/v1/user":{"get":{"operationId":"get_v1_user","tags":["Creators"],"summary":"A creator's profile and their projects","description":"","parameters":[{"name":"username","in":"query","required":true,"description":"Modrinth username","schema":{"type":"string"},"example":"jellysquid3"},{"name":"limit","in":"query","required":false,"description":"Max projects (1-50)","schema":{"type":"string"},"example":"20"}],"security":[{"oanorKey":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"example":{"data":{"id":"TEZXhE2U","bio":"Professional idiot at day, maniac programmer by night.","url":"https://modrinth.com/user/jellysquid3","avatar":"https://cdn.modrinth.com/user/TEZXhE2U/f4705a5f2388c65029ae2e59f1434b3e6e4de23a.png","joined":"2021-01-03T00:49:18.373336Z","source":"Modrinth","projects":[{"slug":"sodium","title":"Sodium","downloads":166791786,"followers":37273,"project_type":"mod"},{"slug":"lithium","title":"Lithium","downloads":98782569,"followers":21770,"project_type":"mod"},{"slug":"phosphor","title":"Phosphor","downloads":820117,"followers":2878,"project_type":"mod"},{"slug":"hydrogen","title":"Hydrogen","downloads":420867,"followers":1014,"project_type":"mod"}],"username":"jellysquid3","project_count":4,"total_downloads":266815339},"meta":{"timestamp":"2026-06-13T13:54:18.900Z","request_id":"06886065-e865-41ce-9e33-fb2bba2d2720"},"status":"ok","message":"User retrieved successfully","success":true}}}},"401":{"description":"Missing or invalid x-oanor-key header"},"402":{"description":"Active subscription required"},"429":{"description":"Rate-limit or monthly quota reached"},"502":{"description":"Upstream did not respond"}}}}},"x-oanor-pricing":[{"slug":"free","name":"Free","price_cents_month":0,"monthly_call_quota":26000,"rps_limit":3,"hard_limit":true},{"slug":"starter","name":"Starter","price_cents_month":440,"monthly_call_quota":340000,"rps_limit":10,"hard_limit":true},{"slug":"pro","name":"Pro","price_cents_month":1360,"monthly_call_quota":1450000,"rps_limit":25,"hard_limit":true},{"slug":"scale","name":"Scale","price_cents_month":3240,"monthly_call_quota":5200000,"rps_limit":55,"hard_limit":true}],"x-oanor-marketplace-url":"https://www.oanor.com/api/modrinth-api"}