Conventions

Last updated: 2024-12-08

Please follow these conventions when using the ManiaExchange API.

• The MX API requires the User-Agent request header.
• The MX API only supports the mime type application/json for formatted responses.
• Input parameters not included in the method URL as {param} are to be appended as querystring, like ?param=value.
• We encourage only fetching the required fields in APIs that use the mandatory {fields} parameter.
• Time values on the server are always stored as UTC.
• We encourage caching of API GET results.
• Deprecated methods will be kept, but will no longer be updated.

Changelog

Recent changes to the documentation are listed here.

• code Method "Search Maps" has been edited
  3/1/2026  arrow_forward
• data_object New Parameter Created for Method "Search Maps": "VideoCount"
  3/1/2026  arrow_forward
• data_object New Parameter Created for Method "Put Play Later Map": "Result"
  3/1/2026  arrow_forward
• data_object New Parameter Created for Method "Put Map Award": "PostedAt"
  3/1/2026  arrow_forward
• data_object New Parameter Created for Method "Put Map Award": "remove"
  3/1/2026  arrow_forward
• data_object New Parameter Created for Method "Put Map Award": "mapId"
  3/1/2026  arrow_forward
• data_object Parameter "mapId" from Method "Put Map in Play Later" has been edited
  3/1/2026  arrow_forward
• data_object New Parameter Created for Method "Put Map in Play Later": "forceAdd"
  3/1/2026  arrow_forward
• data_object New Parameter Created for Method "Put Map in Play Later": "mapId"
  3/1/2026  arrow_forward
• format_list_numbered Enumeration "Mappack Order Modes" has been deleted
  2/27/2026  hide_source
• data_object Parameter "inreplays" from Method "Search Tracks" has been edited
  2/27/2026  arrow_forward
• data_object New Parameter Created for Method "Search Tracks": "inreplays"
  2/27/2026  arrow_forward
• data_object New Parameter Created for Method "Search Tracks": "replaysby"
  2/27/2026  arrow_forward
• code Method "Search Tracks" has been edited
  2/27/2026  arrow_forward
• format_list_numbered New Enum Option Created for Enum "Environments": "White Shore"
  2/27/2026  arrow_forward
• format_list_numbered New Enum Option Created for Enum "Environments": "Blue Bay"
  2/27/2026  arrow_forward
• format_list_numbered New Enum Option Created for Enum "Environments": "Green Coast"
  2/27/2026  arrow_forward
• format_list_numbered New Enum Option Created for Enum "Environments": "Red Island"
  2/27/2026  arrow_forward
• data_object New Parameter Created for Method "Search Maps": "OnlineRecordsAt"
  2/27/2026  arrow_forward
• data_object New Parameter Created for Method "Search Maps": "OnlineRecordCount"
  2/27/2026  arrow_forward