Easily Integrate
Modrinth's API using Konfig's TypeScript SDK
Growing API Companies trust Konfig's SDKs to onboard developers to their API.
First, instantiate the SDK
It only takes a few lines of code.
Then, send your first request
We made it really easy.
Enjoy a buttery smooth developer experience with 76 SDK methods
Parameter
The query to search for
Facets are an essential concept for understanding how to filter out results.
These are the most commonly used facet types:
project_typecategories(loaders are lumped in with categories in search)versionsclient_sideserver_sideopen_source
Several others are also available for use, though these should not be used outside very specific use cases.
titleauthorfollowsproject_idlicensedownloadscolorcreated_timestampmodified_timestamp
In order to then use these facets, you need a value to filter by, as well as an operation to perform on this value.
The most common operation is : (same as =), though you can also use !=, >=, >, <=, and <.
Join together the type, operation, and value, and you've got your string.
{type} {operation} {value}
Examples:
categories = adventure
versions != 1.20.1
downloads <= 100
You then join these strings together in arrays to signal AND and OR operators.
OR
All elements in a single array are considered to be joined by OR statements.
For example, the search [["versions:1.16.5", "versions:1.17.1"]] translates to Projects that support 1.16.5 OR 1.17.1.
AND
Separate arrays are considered to be joined by AND statements.
For example, the search [["versions:1.16.5"], ["project_type:modpack"]] translates to Projects that support 1.16.5 AND are modpacks.
The sorting method used for sorting search results
The offset into the search. Skips this number of results
The number of results returned by the search
Response
Endpoint
No Parameters
Response
Expected response to a valid request
Endpoint
No Parameters
Response
The requested item(https://docs.modrinth.com/ were not found or no authorization to access the requested item(https://docs.modrinth.com/
Endpoint
No Parameters
Response
Expected response to a valid request
The requested item(https://docs.modrinth.com/ were not found or no authorization to access the requested item(https://docs.modrinth.com/
Endpoint
No Parameters
Response
Endpoint
Parameter
Response
Expected response to a valid request
Endpoint
How Konfig Works
Konfig collects APIs and automatically generates SDKs so you can focus on building your application.
Konfig maintains the highest quality collection of OpenAPI Specifications on the internet in a GitHub repository
We pull OpenAPI Specifications from public sources, fix any errors, and make sure they pass our lint rules. We continually make sure the repository is up-to-date and collect up-time and response time metrics for every API.
Generates AI-Augmented SDKs from openapi-examples
Our SDK generator is trusted by growing API companies and goes through a rigorous testing process to ensure the generated SDKs are high-quality and easy to use.
Publishes to standard package managers
We publish to standard package managers like npm, PyPI, and Maven so you can easily integrate the SDK into your application.
About Modrinth
Modrinth is a modding platform providing gamers a site where they can discover modifications for their favorite games and developers a site where they can upload their projects and share them to the world.