# Modrinth Scraper (`crawlerbros/modrinth-scraper`) Actor Scrape Modrinth รขโ‚ฌ" the largest open-source Minecraft mod and plugin registry. Search mods by keyword, filter by categories, loaders, game versions, and project types. Returns download counts, descriptions, author info, and more. - **URL**: https://apify.com/crawlerbros/modrinth-scraper.md - **Developed by:** [Crawler Bros](https://apify.com/crawlerbros) (community) - **Categories:** Automation, Developer tools - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $3.00 / 1,000 results This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Modrinth Scraper Scrape [Modrinth](https://modrinth.com) โ€” the largest open-source Minecraft mod, plugin, and modpack registry with over 50,000 projects and billions of downloads. Search by keyword, browse by category, or filter by mod loader to find the most popular and recently updated projects. ### Features - **Three search modes**: keyword search, category browsing, or loader-specific filtering - **All project types**: mods, plugins, datapacks, shaders, resource packs, and modpacks - **Flexible sorting**: by relevance, downloads, follows, newest, or recently updated - **Rich metadata**: download counts, follower counts, game version compatibility, mod loader support, license info, and direct project URLs - **No authentication required**: uses the public Modrinth REST API ### Use Cases - Track the most popular Minecraft mods in specific categories - Monitor new releases for specific mod loaders (Fabric, Forge, NeoForge) - Build Minecraft modding news feeds and recommendation systems - Research mod adoption trends and download statistics - Find compatible mods for specific Minecraft versions ### Input | Field | Type | Description | Default | |-------|------|-------------|---------| | `mode` | Select | Search mode: `search`, `byCategory`, or `byLoader` | `search` | | `keyword` | Text | Search keyword (mode=search) | `magic` | | `projectType` | Select | Type: mod, plugin, datapack, shader, resourcepack, modpack | `mod` | | `category` | Select | Category filter (mode=byCategory): magic, technology, utility, optimization, etc. | `magic` | | `loader` | Select | Mod loader filter (mode=byLoader): fabric, forge, neoforge, quilt, etc. | `fabric` | | `sortBy` | Select | Sort order: relevance, downloads, follows, newest, updated | `relevance` | | `maxItems` | Integer | Maximum number of projects to return (1โ€“500) | `20` | ### Output Each record contains: | Field | Type | Description | |-------|------|-------------| | `projectId` | String | Unique Modrinth project ID | | `slug` | String | URL-friendly project slug | | `title` | String | Project display name | | `description` | String | Short project description | | `author` | String | Project author username | | `projectType` | String | Type: mod, plugin, modpack, etc. | | `categories` | Array | Project category tags | | `loaders` | Array | Supported mod loaders (Fabric, Forge, etc.) | | `gameVersions` | Array | Supported Minecraft versions (up to 10) | | `downloads` | Integer | Total all-time downloads | | `follows` | Integer | Number of followers | | `latestVersion` | String | Latest release version | | `license` | String | Open source license identifier | | `dateCreated` | String | ISO 8601 creation timestamp | | `dateModified` | String | ISO 8601 last update timestamp | | `iconUrl` | String | Project icon image URL | | `projectUrl` | String | Direct link to the Modrinth project page | | `scrapedAt` | String | ISO 8601 scrape timestamp | ### Example Output ```json { "projectId": "9hx3AbJM", "slug": "easy-magic", "title": "Easy Magic", "description": "Enchanting tables as they always should have been!", "author": "Fuzs", "projectType": "mod", "categories": ["magic", "utility"], "loaders": ["fabric", "forge", "neoforge"], "gameVersions": ["1.20.1", "1.20", "1.19.4"], "downloads": 2500000, "follows": 8500, "latestVersion": "21.3.4", "license": "MIT", "dateCreated": "2021-07-10T12:00:00Z", "dateModified": "2026-05-15T08:00:00Z", "iconUrl": "https://cdn.modrinth.com/data/9hx3AbJM/icon.png", "projectUrl": "https://modrinth.com/mod/easy-magic", "scrapedAt": "2026-06-04T15:30:00.000000+00:00" } ```` ### FAQs **Does this require an API key?** No. The Modrinth API (api.modrinth.com/v2) is fully public and requires no authentication. **What's the difference between categories and loaders?** Categories describe the mod's content (magic, technology, optimization). Loaders indicate the Minecraft modding framework it supports (Fabric, Forge, NeoForge). **How do I find mods for a specific Minecraft version?** Use keyword search and check the `gameVersions` field in the output. Future versions of this actor will add explicit version filtering. **Are modpacks included?** Yes. Set `projectType` to `modpack` to search modpacks specifically. **How many downloads are typical for popular mods?** Top mods have hundreds of millions of downloads. The `sortBy=downloads` option returns the most downloaded projects first. # Actor input Schema ## `mode` (type: `string`): What to search. ## `keyword` (type: `string`): Search term (mode=search). Leave empty to browse top projects. ## `projectType` (type: `string`): Filter by project type. ## `category` (type: `string`): Modrinth category slug. ## `loader` (type: `string`): Minecraft mod loader to filter by. ## `sortBy` (type: `string`): How to order results. ## `maxItems` (type: `integer`): Maximum number of projects to return. ## Actor input object example ```json { "mode": "search", "keyword": "magic", "projectType": "mod", "category": "magic", "loader": "fabric", "sortBy": "relevance", "maxItems": 20 } ``` # Actor output Schema ## `items` (type: `string`): Minecraft mods, modpacks, plugins, and resource packs from modrinth.com. # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "mode": "search", "keyword": "magic", "projectType": "mod", "category": "magic", "loader": "fabric", "sortBy": "relevance", "maxItems": 20 }; // Run the Actor and wait for it to finish const run = await client.actor("crawlerbros/modrinth-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`๐Ÿ’พ Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // ๐Ÿ“š Want to learn more ๐Ÿ“–? Go to โ†’ https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "mode": "search", "keyword": "magic", "projectType": "mod", "category": "magic", "loader": "fabric", "sortBy": "relevance", "maxItems": 20, } # Run the Actor and wait for it to finish run = client.actor("crawlerbros/modrinth-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("๐Ÿ’พ Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # ๐Ÿ“š Want to learn more ๐Ÿ“–? Go to โ†’ https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "mode": "search", "keyword": "magic", "projectType": "mod", "category": "magic", "loader": "fabric", "sortBy": "relevance", "maxItems": 20 }' | apify call crawlerbros/modrinth-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=crawlerbros/modrinth-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Modrinth Scraper", "description": "Scrape Modrinth รขโ‚ฌ\" the largest open-source Minecraft mod and plugin registry. Search mods by keyword, filter by categories, loaders, game versions, and project types. Returns download counts, descriptions, author info, and more.", "version": "0.1", "x-build-id": "sZlxcd2cF7FtDA0qn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~modrinth-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-modrinth-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/crawlerbros~modrinth-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-modrinth-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/crawlerbros~modrinth-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-modrinth-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "byCategory", "byLoader" ], "type": "string", "description": "What to search.", "default": "search" }, "keyword": { "title": "Keyword", "type": "string", "description": "Search term (mode=search). Leave empty to browse top projects.", "default": "magic" }, "projectType": { "title": "Project type", "enum": [ "mod", "plugin", "datapack", "shader", "resourcepack", "modpack" ], "type": "string", "description": "Filter by project type.", "default": "mod" }, "category": { "title": "Category (mode=byCategory)", "enum": [ "adventure", "cursed", "decoration", "economy", "equipment", "food", "game-mechanics", "library", "magic", "management", "minigame", "mobs", "optimization", "social", "storage", "technology", "transportation", "utility", "worldgen" ], "type": "string", "description": "Modrinth category slug.", "default": "magic" }, "loader": { "title": "Mod loader (mode=byLoader)", "enum": [ "fabric", "forge", "neoforge", "quilt", "bukkit", "spigot", "paper", "purpur", "folia", "sponge" ], "type": "string", "description": "Minecraft mod loader to filter by.", "default": "fabric" }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "downloads", "follows", "newest", "updated" ], "type": "string", "description": "How to order results.", "default": "relevance" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of projects to return.", "default": 20 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```