Modrinth Python API Docs | dltHub
Build a Modrinth-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
Modrinth API streamlines mod development for Minecraft Fabric and Forge. It supports multiple Minecraft versions. Essential operations include getting user projects and searching projects. The REST API base URL is https://api.modrinth.com and All authenticated requests use a personal access token in the Authorization header..
dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Modrinth data in under 10 minutes.
What data can I load from Modrinth?
Here are some of the endpoints you can load from Modrinth:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| search_projects | v2/search | GET | hits | Search projects. Returns a paginated response with results in the hits array. |
| get_project | v2/project/{id | slug} | GET | |
| list_project_versions | v2/project/{id | slug}/version | GET | |
| get_user_projects | v2/user/{id | username}/projects | GET | projects |
| get_tag_categories | v2/tag/category | GET | categories | List tag categories; results are in the categories array. |
How do I authenticate with the Modrinth API?
Modrinth accepts personal access tokens (PATs) which are sent in the Authorization header without a Bearer prefix. Every request must also include a User-Agent header identifying your application.
1. Get your credentials
- Sign into your Modrinth account at https://modrinth.com.
- Open Settings → Account (https://modrinth.com/settings/account).
- In the Personal Access Tokens (or API Tokens) section, click “Create new token”.
- Choose the required scopes and generate the token (it starts with
mrp_). - Copy the token and store it in your DLT secrets.toml as
token = "mrp_...". - Include the token in the Authorization header of every request and add a descriptive User-Agent header.
2. Add them to .dlt/secrets.toml
[sources.modrinth_source] token = "mrp_your_personal_access_token_here"
dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.
How do I set up and run the pipeline?
Set up a virtual environment and install dlt:
uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"
1. Install the dlt AI Workbench:
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex
This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →
2. Install the rest-api-pipeline toolkit:
dlt ai toolkit rest-api-pipeline install
This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →
3. Start LLM-assisted coding:
Use /find-source to load data from the Modrinth API into DuckDB.
The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.
4. Run the pipeline:
python modrinth_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline modrinth_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset modrinth_data The duckdb destination used duckdb:/modrinth.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline modrinth_pipeline show
This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.
Python pipeline example
This example loads search_projects and list_project_versions from the Modrinth API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def modrinth_source(token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.modrinth.com", "auth": { "type": "api_key", "token": token, }, }, "resources": [ {"name": "search_projects", "endpoint": {"path": "v2/search", "data_selector": "hits"}}, {"name": "list_project_versions", "endpoint": {"path": "v2/project/{id|slug}/version"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="modrinth_pipeline", destination="duckdb", dataset_name="modrinth_data", ) load_info = pipeline.run(modrinth_source()) print(load_info)
To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.
How do I query the loaded data?
Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.
Python (pandas DataFrame):
import dlt data = dlt.pipeline("modrinth_pipeline").dataset() sessions_df = data.list_project_versions.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM modrinth_data.list_project_versions LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("modrinth_pipeline").dataset() data.list_project_versions.df().head()
See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.
What destinations can I load Modrinth data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example value |
|---|---|
| DuckDB (local, default) | "duckdb" |
| PostgreSQL | "postgres" |
| BigQuery | "bigquery" |
| Snowflake | "snowflake" |
| Redshift | "redshift" |
| Databricks | "databricks" |
| Filesystem (S3, GCS, Azure) | "filesystem" |
Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.
Next steps
Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:
data-exploration— Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.dlthub-runtime— Deploy, schedule, and monitor your pipeline in production.
dlt ai toolkit data-exploration install dlt ai toolkit dlthub-runtime install
Was this page helpful?
Community Hub
Need more dlt context for Modrinth?
Request dlt skills, commands, AGENT.md files, and AI-native context.