The API reference below lists all available API methods.
While for the search API you can specify a {format} parameter (json (default) or xml), other API calls simply use derive this value from the set MIME-type (application/json or application/xml).
Because of the switch to local API-MGMT, most API calls using the url api.mania-exchange.com are no longer updated and therefore deprecated. Please read the following infos:
api.mania-exchange.com access points will not work (strictly use the trackmania.exchange domain).track and map as URL segment, where specified.The map and replay exchange for Trackmania®.
trackmania.exchange
The map and replay exchange for Trackmania² in maniaplanet.
tm.mania.exchange
tm.mania-exchange.com
The map and replay exchange for Shootmania in maniaplanet.
sm.mania.exchange
sm.mania-exchange.com
Search for publicly available maps. Due to the size of the search engine, its functionality can not be replicated on this API. You must
use each sites' search API directly by visiting the specified URL.
We strongly recommend you cache search results.
See Enumeration values for all "magic values".
https://{site}/mapsearch2/search?api=on&format={format}&{params}
https://{site}/tracksearch2/search?api=on&format={format}&{params}
| Parameter | Description |
mode |
Special mapsearch mode. [Values] |
trackname |
Name of a map (aka track). The name can be partial, a full name is not required. |
author |
Name of map author. Searches for ManiaExchange usernames. |
mpauthor |
Name of map author. Searches for ManiaPlanet login names. |
anyauthor |
Name of map author. Searches for ManiaExchange usernames and ManiaPlanet login names. |
mod |
Name of mod used. |
authorid |
Filter maps by ManiaExchange user ID. |
mtype |
Map type. The ManiaScript map type used. Multiple map types can be passed by separating them with a ,-character. |
tpack |
The title pack required to play the map. Multiple title packs can be passed by separating them with a ,-character. |
rtype |
Replay type. [Values] |
style |
Internal style code (int) used to classify maps by style. [TM Values] [SM Values] |
length |
Internal length code (int) used to classify maps by length. [Values] |
lengthop |
Operator used to filter maps by length. [Values] |
priord |
The primary order to sort maps by. [Values] |
secord |
The secondary order to sort maps by. [Values] |
environments |
Internal environment code (int) used to filter maps by environment. Multiple environments can be passed by separating them with a ,-character. [TM Values] [SM Values] |
vehicles |
Internal vehicle (equals related environment) code (int) used to filter maps by vehicle. Multiple vehicles can be passed by separating them with a ,-character. [TM Values] [SM Values] |
unlimiter |
Boolean value (true or false) indicating whether or not to filter out TM Unlimiter maps. |
page |
Page index. |
limit |
Number of maps returned for the search. 20 (min), 100 (max). |
unreleased |
If set to 0, only released maps, if set to 1 only unreleased maps. Any other value will show both released and unreleased maps. |
mapgroup |
Special map group index to filter maps on. (For example, index 3 on the TM-subsite shows maps from the Nadeo 10th Anniversary Creative Competition group only.) |
commentsminlength |
Author comments minimum length. |
customscreenshot |
If set to 1, only maps with a custom screenshot are selected. |
minexebuild |
Minimum game version this map was saved in (allows filtering on betaX or higher maps only, for example). |
maxexebuild |
Maximum game version this map was saved in. |
envmix |
If set to 0, only non-environment-mixed maps, if set to 1 only environment-mixed maps maps. Any other value will show both. |
ghostblocks |
If set to 0, only maps without ghostblocks, if set to 1 only maps with ghostblocks. Any other value will show both. |
embeddedobjects |
If set to 0, only maps without embedded objects, if set to 1 only maps with embedded objects. Any other value will show both. |
gv |
Game version. 1: show only MP4 maps or newer. -1: show only pre-MP4 maps. |
Search for publicly available mappacks. Due to the size of the search engine, its functionality can not be replicated on this API. You must
use each sites' search API directly by visiting the specified URL.
We strongly recommend you cache search results.
See Enumeration values for all "magic values".
https://{site}/mappacksearch/search?api=on&format={format}&{params}
| Parameter | Description |
name |
Name of a mappack. The name can be partial, a full name is not required. |
username |
Name of mappack creator. Searches for ManiaExchange usernames. |
type |
The Mappack type. [TM Values] |
titlepack |
The Titlepack name (without everything after the @). |
environments |
Internal environment code (int) used to filter maps by environment. Multiple environments can be passed by separating them with a ,-character. [TM Values] [SM Values] |
This method returns information for a collection of maps.
You can request information for a maximum of 50 maps.
You must specify the UID or map ID in your request (you cannot use both in one request).
https://{site}/api/maps/get_map_info/multi/{ids,}
https://{site}/api/tracks/get_track_info/multi/{ids,}
DEPRECATED FOR: TM.MX (August 2020), TMX
https://api.mania.exchange/{sitehandle}/maps/{ids,}
https://api.mania.exchange/{sitehandle}/tracks/{ids,}
| Parameter | Description |
ids |
map ID or map UID. This can be a string or integer value. Map IDs and map UIDs can be mixed in a single request. Return order is not guaranteed. |
Gets a collection of embedded objects for the specified map.
https://{site}/api/maps/embeddedobjects/{ID}
https://{site}/api/tracks/embeddedobjects/{ID}
DEPRECATED FOR: TM.MX, TMX
https://api.mania-exchange.com/{site}/tracks/embeddedobjects/{id}
| Parameter | Description |
id |
Track ID. |
This method returns information for a single mappack.
https://{site}/api/mappack/get_info/{id}?={secret}
DEPRECATED FOR: TM.MX, TMX
https://api.mania-exchange.com/{sitehandle}/mappacks/{ids,}/?={secret}
| Parameter | Description |
id |
The Mappack ID. |
secret |
Used for unreleased mappacks. Like a password for secret testing. |
Get the tracks of a mappack.
https://{site}/api/mappack/get_mappack_tracks/{ID}?={secret}
DEPRECATED FOR: TM.MX, TMX
https://api.mania-exchange.com/tm/mappack/{ID}/tracks/?={secret}
| Parameter | Description |
ID |
The mappack ID. |
secret |
Used for unreleased mappacks. Like a password for secret testing. |
Returns the raw track file associated with the given id.
https://{site}/maps/download/{id}
https://{site}/tracks/download/{id}
| Parameter | Description |
id |
The track ID. Providing an invalid ID will cause a redirect to the sites homepage. |
X-ManiaPlanet-ServerLogin header to the server login string.
Returns a zip file with all approved tracks inside the associated mappack ID.
https://{site}/mappack/download/{id}?{param}
| Parameter | Description |
id |
The mappack ID. Providing an invalid ID will cause a redirect to the sites homepage. |
secret |
Used for unreleased mappacks. Like a password for secret testing. |
X-ManiaPlanet-ServerLogin header to the server login string.
Returns the 10 most recently uploaded tracks.
Deprecated. - Use the mode-parameter of the search API instead.
https://api.mania-exchange.com/{site}/tracks/list/latest
Returns the 10 most recently created mappacks.
Deprecated. - Use the mode-parameter of the search API instead.
https://api.mania-exchange.com/{site}/mappacks/list/latest
| Parameter | Description |
titlepack |
The Titlepack name (without everything after the @). |
Returns world record for the specified track.
Deprecated. - Use the amount-parameter of the get replays API instead.
DEPRECATED FOR: TM.MX, TMX
https://api.mania-exchange.com/{site}/tracks/worldrecord/{id}
| Parameter | Description |
id |
The track ID. |
Gets a collection of replays for the specified track, in ascending order.
Select an amount of 1 to return the world record.
https://{site}/replays/get_replays/{id}/{amount?}
DEPRECATED FOR: TM.MX, TMX
https://api.mania-exchange.com/{site}/replays/{id}/{amount?}
| Parameter | Description |
id |
Track ID. |
amount |
The amount of records to return. 25 (max, default). |
Returns the seasonal leaderboard for the specified season.
https://{site}/api/leaderboard/season/{SeasonID}
| Parameter | Description |
SeasonID |
The identifier for the season. Leave empty or specify with 0 to get the current season's information. |
Returns the seasonal leaderboard stats for the specified season and users.
https://{site}/api/leaderboard/season/{SeasonID}/user/{ids,}
| Parameter | Description |
SeasonID |
The identifier for the season. Leave empty or specify with 0 to get the current season's information. |
ids |
The UserIDs for the users, comma seperated. |
Returns the available leaderboard seasons.
https://{site}/api/leaderboard/getseasons
Returns the high quality image for the specified map (width is kept original).
https://{site}/maps/{mapid}/image/{image}
| Parameter | Description |
mapid |
The map ID. |
image |
The image number. Between 0 to 5. Available images are determined by the ImageCount attribute from the map info. |
Returns the image thumbnail for the specified map (width = 600px).
https://{site}/maps/{mapid}/imagethumb/{image}
| Parameter | Description |
mapid |
The map ID. |
image |
The image number. Between 0 to 5. Available images are determined by the ImageCount attribute from the map info. |
Returns the (first) custom screenshot for the specified map. If no screenshot has been uploaded, the extracted file thumbnail will be displayed.
https://{site}/maps/screenshot/{type}/{id}
https://{site}/tracks/screenshot/{type}/{id}
| Parameter | Description |
id |
The track ID. |
type |
Value indicating the size of the screenshot. Options available: normal or small. Note that if the track has no custom screenshot, no small variant is generated. |
Returns the thumbnail extracted from the uploaded track file.
https://{site}/maps/thumbnail/{id}
https://{site}/tracks/thumbnail/{id}
| Parameter | Description |
id |
The track ID. |
Returns the custom thumbnail (400x400) for the specified mappack. If no thumbnail has been uploaded, a standard image will be displayed.
https://{site}/mappacks/thumbnail/{id}
| Parameter | Description |
id |
The mappack ID. |
Returns the available style tags.
https://{site}/api/tags/gettags