---
title: "Search projects"
method: GET
path: "/search"
tags: ["projects"]
---

# Search projects

`GET /search`

## Query parameters

- `query` string
- `facets` string
- `index` 'relevance' | 'downloads' | 'follows' | 'newest' | 'updated'
- `offset` integer
- `limit` integer

## Response `200`

Expected response to a valid request

- SearchResults
  - `hits` ProjectResult[], required — The list of results
    - `slug` string, required — The slug of a project, used for vanity URLs. Regex: ```^[\w!@$()`.+,"\-']{3,64}$```
    - `title` string, required — The title or name of the project
    - `description` string, required — A short description of the project
    - `categories` string[] — A list of the categories that the project has
    - `client_side` 'required' | 'optional' | 'unsupported' | 'unknown', required — The client side support of the project
    - `server_side` 'required' | 'optional' | 'unsupported' | 'unknown', required — The server side support of the project
    - `project_type` 'mod' | 'modpack' | 'resourcepack' | 'shader', required — The project type of the project
    - `downloads` integer, required — The total number of downloads of the project
    - `icon_url` string, nullable — The URL of the project's icon
    - `color` integer, nullable — The RGB color of the project, automatically generated from the project icon
    - `thread_id` string — The ID of the moderation thread associated with this project
    - `monetization_status` 'monetized' | 'demonetized' | 'force-demonetized'
    - `project_id` string, required — The ID of the project
    - `all_project_types` string[], required — All project types across every version of the project, unlike `project_type` which only reflects a version-specific type
    - `author` string, required — The username of the project's author
    - `display_categories` string[] — A list of the categories that the project has which are not secondary
    - `versions` string[], required — A list of the minecraft versions supported by the project
    - `follows` integer, required — The total number of users following the project
    - `date_created` string, ISO-8601, required — The date the project was added to search
    - `date_modified` string, ISO-8601, required — The date the project was last modified
    - `latest_version` string — The latest version of minecraft that this project supports
    - `license` string, required — The SPDX license ID of a project
    - `gallery` string[] — All gallery images attached to the project
    - `featured_gallery` string, nullable — The featured gallery image of the project
  - `offset` integer, required — The number of results that were skipped by the query
  - `limit` integer, required — The number of results that were returned by the query
  - `total_hits` integer, required — The total number of results that match the query

## Other responses

- `400` — Request was invalid, see given error

---

[API](https://skmtc.net/modrinth/apis/labrinth.md) · [All operations](https://skmtc.net/modrinth/apis/labrinth/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/modrinth/labrinth/versions/439f357e772d/schema)