v1

latestOpenAPI 3.0.02026-08-0446129150.1 KB
Mods

Get all mods that match the search criteria.

get/v1/mods/search

Query parameters

gameIdinteger required

Filter by game id.

classIdinteger

Filter by section id (discoverable via Categories)

categoryIdinteger

Filter by category id

categoryIdsstring

Filter by a list of category ids - this will override categoryId categoryIds=[1,2,3...]

The maximum allowed category ids per query is 10

gameVersionstring

Filter by game version string

gameVersionsstring

Filter by a list of game version strings - this will override gameVersion

gameVersions=["1.19.1", "1.19.2", "1.20.1" ...]

The maximum allowed category ids per query is 4

searchFilterstring

Filter by free text search in the mod name and author

sortField1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13

1 = Featured 2 = Popularity 3 = LastUpdated 4 = Name 5 = Author 6 = TotalDownloads 7 = Category 8 = GameVersion 9 = EarlyAccess 10 = FeaturedReleased 11 = ReleasedDate 12 = Rating 13 = Relevancy

Filter by ModsSearchSortField enumeration

sortOrder'asc' | 'desc'

'asc' if sort is in ascending order, 'desc' if sort is in descending order

modLoaderType0 | 1 | 2 | 3 | 4 | 5 | 6

0 = Any 1 = Forge 2 = Cauldron 3 = LiteLoader 4 = Fabric 5 = Quilt 6 = NeoForge

Filter only mods associated to a given modloader (Forge, Fabric ...). Must be coupled with gameVersion.

modLoaderTypesstring

Filter by a list of mod loader types - this will override modLoaderType modLoaderTypes=[Forge, Fabric, ...]

Max values = 5

gameVersionTypeIdinteger nullable

Filter only mods that contain files tagged with versions of the given gameVersionTypeId

authorIdinteger nullable

Filter only mods that the given authorId is a member of.

primaryAuthorIdinteger nullable

Filter only mods that the given primaryAuthorId is the owner of.

PremiumType0 | 1 | 2

0 = All 1 = Premium 2 = Free

Filter only mods that are Premium or not.

slugstring

Filter by slug (coupled with classId will result in a unique result).

clientCompatibleboolean

When set to true, will filter out any mod that doesn't have a default file that is compatible with the client. This is usually due to a bad file structure of the file (which might cause unexpected behaviours on the user's machine - such as overriding other mods installed).

modsSearchEnhancedFeaturesinteger

Bitwise number with values from ModsSearchEnhancedFeatures

indexinteger

A zero based index of the first item to include in the response, the limit is: (index + pageSize <= 10,000).

pageSizeinteger

The number of items to include in the response, the default/maximum value is 50.

Response