Maps

Retrieve a paginated list of approved maps

get/v1/maps

Request

  • Base URL
    https://api.momentum-mod.org (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

skipnumber

Skip this many records

takenumber

Take this many records

searchstring
Example:dust2

Filter by partial map name match (contains)

searchStartsWithstring
Example:de_dust2

Filter by partial map name match (startsWith)

submitterIDnumber

Filter by submitter ID

creditIDnumber

Filter by a user in map credits

creditType0 | 1 | 2 | 3

Type of credit for creditID field

sortType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17

Get maps in a given order with MapSortType

expand'leaderboards' | 'info' | 'currentVersion' | 'currentVersionWithZones' | 'versions' | 'versionsWithZones' | 'stats' | 'submitter' | 'credits' | 'inFavorites'

Nested properties belonging to the found items to include. Comma-separated leaderboards, info, currentVersion, currentVersionWithZones, versions, versionsWithZones, stats, submitter, credits, inFavorites

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

Filter by map type (gamemode)

difficultyLownumber

Filter by tier (lower bound)

difficultyHighnumber

Filter by tier (upper bound)

linearboolean

Filter by linear or staged

favoriteboolean

Filter by whether map is or is not in user favorites

PBboolean

Filter by whether map whether or not the user has beaten the main track of this map.If a gamemode is provided, uses that. Otherwise uses any mode.

leaderboardType0 | 1 | 2 | 3

If set, will filter by specific leaderboard type (e.g. Ranked only)

tagsWithQualifiers'1;1' | '1;0' | '2;1' | '2;0' | '3;1' | '3;0' | '4;1' | '4;0' | '5;1' | '5;0' | '6;1' | '6;0' | '7;1' | '7;0' | '8;1' | '8;0' | '9;1' | '9;0' | '10;1' | '10;0' | '11;1' | '11;0' | '12;1' | '12;0' | '13;1' | '13;0' | '14;1' | '14;0' | '15;1' | '15;0' | '16;1' | '16;0' | '17;1' | '17;0' | '18;1' | '18;0' | '19;1' | '19;0' | '20;1' | '20;0' | '21;1' | '21;0' | '22;1' | '22;0' | '23;1' | '23;0' | '24;1' | '24;0' | '25;1' | '25;0' | '26;1' | '26;0' | '27;1' | '27;0' | '28;1' | '28;0' | '29;1' | '29;0' | '30;1' | '30;0' | '31;1' | '31;0' | '32;1' | '32;0' | '33;1' | '33;0' | '34;1' | '34;0' | '35;1' | '35;0' | '36;1' | '36;0' | '37;1' | '37;0' | '38;1' | '38;0' | '39;1' | '39;0' | '40;1' | '40;0' | '41;1' | '41;0' | '42;1' | '42;0' | '43;1' | '43;0' | '44;1' | '44;0' | '45;1' | '45;0' | '46;1' | '46;0' | '47;1' | '47;0' | '48;1' | '48;0' | '49;1' | '49;0' | '50;1' | '50;0' | '51;1' | '51;0' | '52;1' | '52;0' | '53;1' | '53;0' | '54;1' | '54;0' | '55;1' | '55;0' | '56;1' | '56;0' | '57;1' | '57;0' | '58;1' | '58;0' | '59;1' | '59;0' | '60;1' | '60;0' | '61;1' | '61;0' | '62;1' | '62;0' | '63;1' | '63;0' | '64;1' | '64;0' | '65;1' | '65;0' | '66;1' | '66;0' | '67;1' | '67;0' | '68;1' | '68;0' | '69;1' | '69;0' | '70;1' | '70;0' | '71;1' | '71;0' | '72;1' | '72;0' | '73;1' | '73;0' | '74;1' | '74;0' | '75;1' | '75;0' | '76;1' | '76;0' | '77;1' | '77;0' | '78;1' | '78;0' | '79;1' | '79;0' | '80;1' | '80;0' | '81;1' | '81;0' | '82;1' | '82;0' | '83;1' | '83;0' | '84;1' | '84;0' | '85;1' | '85;0' | '86;1' | '86;0' | '87;1' | '87;0' | '88;1' | '88;0' | '89;1' | '89;0' | '90;1' | '90;0'

Array containing semicolon-separated 2-tuple strings, where the first part in the tuple is a MapTag value, and the second either a 1 (to include) or 0 (to exclude the tag).Important! malformed string elements (e.g. '-5;4' and '1;1;1') don't throw, but simply don't get added to the resulting array.

Response

totalCountnumber required

The total number of results found

returnCountnumber required

The number of results in the response

Changes

No recorded changes to this operation across all 1 revision of this API.