Headers:

• Authorization: nadeo_v1 t={token} An access token for the NadeoLiveServices audience

Path parameters:

• {matchmakingType} integer The ID of the matchmaking type *

Body parameters:

• {code} string The party code *
• {playWith} string[] The account IDs of the players you wish to queue with (leave empty to queue solo) *

The request body is an object with code and playWith fields:

{
  "code": code,
  "playWith": playWith
}

Sends a heartbeat to start and persist a matchmaking queue.

Remarks:

• See the glossary for a list of available matchmaking types and their IDs.
• When queueing normally, the game will send a heartbeat every 5 seconds. It is recommended that you also do the same, else you might get unexpected results.
• To stop queuing, you must send a cancel request.
• You must be careful with this endpoint - if you send heartbeats but do not join and complete a match when it becomes available, your account will be penalized!
• The code parameter can be (and typically is) left blank. This might have been used for Royal before it was discontinued.
• This endpoint is only useful with tokens authenticated through Ubisoft user accounts (as opposed to dedicated server accounts).
• The response field "status" is typically one of the following: "canceled", "pending", "queued", "match_ready".

Example request:

https://meet.trackmania.nadeo.club/api/matchmaking/5/heartbeat

{
  "code": "",
  "playWith": [
    "594be80b-62f3-4705-932b-e743e97882cf"
  ]
}

Example response while queueing:

{
  "banEndDate": null,
  "status": "queued",
  "matchLiveId": null,
  "matchmakingWaitingTime": 60,
  "creationDate": 1756330600
}

Example response when a match is found:

{
  "banEndDate": null,
  "status": "match_ready",
  "matchLiveId": "LID-MTCH-tnn54mgcalomujp",
  "matchmakingWaitingTime": null,
  "creationDate": null
}