matchmaking

This websocket interface enables ladder admins to add/remove ladder-entries to/from the matchmaking pool. While ladder-entries are in the matchmaking pool, and while the ladder admin is actively connected to this interface, Competier will attempt to find a match between ladder-entries in the pool based on configurable parameters in ladder: defaultTeamSize, defaultTeamAmount, mmUseRating, mmUseDistance, mmAvoidRematches. Refer to the ladder documentation to learn more.

Once connected, you first message should be your API key, and your second message should be the ID of the ladder you'd like to matchmake for. Then, send any amount of messages, each of which contains the ID of a ladder-entry you'd like to add or remove from the matchmaking pool. You can also explicitly send a message containing add or remove to specify the intended action.
Whenever Competier finds a successful match, you'll receive a JSON result, but with finishPositions and read-only values missing. Once you've conducted the match, simply fill in finishPositions and POST the result to the according endpoint. Partaking ladder-entries are auto-removed from the matchmaking pool when a match is found.

A credit is used when a websocket connection is established, as well as whenever the server responds with a successful match. Adding or removing ladder-entries to/from the matchmaking pool doesn't use up your quota.

If your ladder is configured with playersCanEnterResults = true, any user with a respective ladder-entry connected to their account can connect to the matchmaking interface for your ladder, for example using the Competier App. However, instead of getting to choose the ladder-entry IDs to add to the matchmaking pool, instead they'll simply add themselves to the pool, which will happen automatically upon entering a valid ladder ID. If a match is found, all proposed players will be notified about whom they should be playing with/against, and disconnected from the interface. It's your players' responsibility to organize the match and post a result after the fact, and the Competier App will encourage them to do so. If applicable, matches between a mix of account-representing ladder-entries and self-managed ladder-entries can occur. In that case, both the matchmaking players and the admin will receive information on the successful match through this interface.

Request