Maps

Search Maps

Changed on

Search and filter maps with comprehensive filtering options.

get/api/v3/maps

Request

  • Base URL
    https://api.genji.pk
  • URL
    https://api.genji.pk/api/v3/maps
  • Auth
    none declared

Query parameters

codestring nullable

Filter by map code

map_idinteger nullable

Filter by map ID

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

Filter by playtest status

archivedboolean nullable

Filter by archived status

hiddenboolean nullable

Filter by hidden status

officialboolean nullable

Filter by official status

playtest_thread_idinteger nullable

Filter by playtest thread ID

categorystring[] nullable

Filter by category list

map_namestring[] nullable

Filter by map name list

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

Filter by exact difficulty tier

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

Filter by minimum difficulty

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

Filter by maximum difficulty

mechanicsstring[] nullable

Filter by mechanics (AND semantics)

restrictionsstring[] nullable

Filter by restrictions (AND semantics)

tagsstring[] nullable

Filter by tags (AND semantics)

creator_idsinteger[] nullable

Filter by creator user IDs

creator_namesstring[] nullable

Filter by creator names

user_idinteger nullable

User ID for completion/medal filtering

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

Medal filter (All/With/Without)

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

Completion filter (All/With/Without)

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

Playtest filter (All/Only/None)

minimum_qualityinteger nullable

Minimum average quality rating

page_sizeinteger

Results per page

page_numberinteger

Page number (1-indexed)

sortstring[] nullable

List of 'field:direction' sort keys, in priority order. Use created_at for submission date or updated_at for last core map change; asc is oldest first, desc is newest first. Missing dates sort last. Defaults to difficulty ascending.

finalized_playtestsboolean nullable

Filter finalized playtests

return_allboolean

Return all results without pagination

force_filtersboolean

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

Changes

  • f52357a382e1Revision changes
    • info

      added the enum value created_at:asc to the property oneOf[subschema #1]/items/ of the query request parameter sort

    • info

      added the enum value created_at:desc to the property oneOf[subschema #1]/items/ of the query request parameter sort

    • info

      added the enum value updated_at:asc to the property oneOf[subschema #1]/items/ of the query request parameter sort

    • info

      added the enum value updated_at:desc to the property oneOf[subschema #1]/items/ of the query request parameter sort