Sign in

v1

latestOpenAPI 3.1.02026-07-13225241316.1 KB
Maps

Search Maps

Search and filter maps with comprehensive filtering options.

get/api/v3/maps

Query parameters

codestring nullable

Filter by map code

Filter by map code

map_idinteger nullable

Filter by map ID

Filter by map ID

playtest_status'Approved' | 'In Progress' | 'Rejected' | 'null' nullable

Filter by playtest status

Filter by playtest status

archivedboolean nullable

Filter by archived status

Filter by archived status

hiddenboolean nullable

Filter by hidden status

Filter by hidden status

officialboolean nullable

Filter by official status

Filter by official status

playtest_thread_idinteger nullable

Filter by playtest thread ID

Filter by playtest thread ID

categorystring[] nullable

Filter by category list

Filter by category list

map_namestring[] nullable

Filter by map name list

Filter by map name list

difficulty_exact'Easy' | 'Medium' | 'Hard' | 'Very Hard' | 'Extreme' | 'Hell' | 'null' nullable

Filter by exact difficulty tier

Filter by exact difficulty tier

difficulty_range_min'Easy' | 'Medium' | 'Hard' | 'Very Hard' | 'Extreme' | 'Hell' | 'null' nullable

Filter by minimum difficulty

Filter by minimum difficulty

difficulty_range_max'Easy' | 'Medium' | 'Hard' | 'Very Hard' | 'Extreme' | 'Hell' | 'null' nullable

Filter by maximum difficulty

Filter by maximum difficulty

mechanicsstring[] nullable

Filter by mechanics (AND semantics)

Filter by mechanics (AND semantics)

restrictionsstring[] nullable

Filter by restrictions (AND semantics)

Filter by restrictions (AND semantics)

tagsstring[] nullable

Filter by tags (AND semantics)

Filter by tags (AND semantics)

creator_idsinteger[] nullable

Filter by creator user IDs

Filter by creator user IDs

creator_namesstring[] nullable

Filter by creator names

Filter by creator names

user_idinteger nullable

User ID for completion/medal filtering

User ID for completion/medal filtering

medal_filter'All' | 'With' | 'Without'

Medal filter (All/With/Without)

Medal filter (All/With/Without)

completion_filter'All' | 'With' | 'Without'

Completion filter (All/With/Without)

Completion filter (All/With/Without)

playtest_filter'All' | 'Only' | 'None'

Playtest filter (All/Only/None)

Playtest filter (All/Only/None)

minimum_qualityinteger nullable

Minimum average quality rating

Minimum average quality rating

page_sizeinteger

Results per page

Results per page

page_numberinteger

Page number (1-indexed)

Page number (1-indexed)

sortstring[] nullable

List of 'field:direction' sort keys

List of 'field:direction' sort keys

finalized_playtestsboolean nullable

Filter finalized playtests

Filter finalized playtests

return_allboolean

Return all results without pagination

Return all results without pagination

force_filtersboolean

Force filters even with code param

Force filters even with code param

Response

Request fulfilled, document follows

idinteger required
codestring required
map_namestring required
category'Classic' | 'Increasing Difficulty' | 'Other' required
checkpointsinteger required
difficulty'Easy -' | 'Easy' | 'Easy +' | 'Medium -' | 'Medium' | 'Medium +' | 'Hard -' | 'Hard' | 'Hard +' | 'Very Hard -' | 'Very Hard' | 'Very Hard +' | 'Extreme -' | 'Extreme' | 'Extreme +' | 'Hell' required
officialboolean required
playtesting'Approved' | 'In Progress' | 'Rejected' required
archivedboolean required
hiddenboolean required
created_atstring date-time required
updated_atstring date-time required
ratingsnumber nullable
guidesstring[] nullable
raw_difficultynumber nullable
mechanicsstring[]
restrictionsstring[]
tagsstring[]
descriptionstring nullable
titlestring nullable
map_bannerstring nullable
timenumber nullable
total_resultsinteger nullable
linked_codestring nullable