Ev.io Matchmaker API

Visit the API Tester here.

Send all requests to https://evio-match-api.herokuapp.com.

POST /v1/matches

Create a new match. All matches created via the API run in tourney mode, which means players will be taken to the pre-game room when they join via the link.

Request

Example

{
    "callbackUrl": "https://httpbin.org/post",
    "teams": [
        {
            "players": [
                {
                    "account": "30"
                },
                {
                    "account": "31"
                }
            ]
        },
        {
            "players": [
                {
                    "account": "33"
                },
                {
                    "account": "34"
                }
            ]
        }
    ],
    "duration": 60,
    "gravity": 0.07,
    "damageMultiplier": 1,
    "timeVelocity": 1,
    "killsToWin": 10,
    "gameMode": "team_deathmatch",
    "map": "93",
    "region": "san-francisco"
}

Documentation

• callbackUrl: A POST request is sent to this endpoint when the match status updates. See Match Callback. Retries on failure with exponential back off.
• teams: Array of teams participating. Each team gets its own array (two teams max).
  • players: List of allowed player accounts. Only player accounts in this array are allowed to join via the link.
    • account: The account ID for the player. Find your account ID by visiting https://ev.io/user/ and copying the user ID from the URL. For example, the user ID for https://ev.io/user/1 is 1.
• duration: Duration of the match in seconds
• gravity
• damageMultiplier
• timeVelocity: Makes the match faster or slower
• killsToWin
• gameMode: "team_deathmatch"
• map: See available maps here. You need the "nid."
• region: "san-francisco" | "new-jersey" | "singapore" | "amsterdam"

Response

Example

{
    "match": {
        "matchId": "xxxx",
        "status": "pending",
        "teams": [
            {
                "placement": null,
                "players": [
                    {
                        "account": "30",
                        "stats": null
                    },
                    {
                        "account": "31",
                        "stats": null
                    }
                ]
            },
            {
                "placement": null,
                "players": [
                    {
                        "account": "33",
                        "stats": null
                    },
                    {
                        "account": "34",
                        "stats": null
                    }
                ]
            }
        ],
        "duration": 60,
        "gravity": 0.07,
        "damageMultiplier": 1,
        "timeVelocity": 1,
        "killsToWin": 10,
        "gameMode": "team_deathmatch",
        "map": "93",
        "region": "san-francisco"
    }
}

Documentation

• match: See Match

GET /v1/matches/:matchId

Get data on a created match via the match id.

Response

Example

{
    "match": {
        "matchId": "xxxx",
        "status": "complete",
        "teams": [
            {
                "placement": 1,
                "players": [
                    {
                        "account": "30",
                        "stats": {
                            "char": "105",
                            "kills": 0,
                            "deaths": 0,
                            "score": 0,
                            "round_wins": 0,
                            "guest_kills": 0,
                            "bot_kills": 0,
                            "registered_kills": 0,
                            "clan_kills": 0,
                            "bot_deaths": 0,
                            "boss_kills": 0,
                            "revives": 0,
                            "flags": 0,
                            "assists": 0
                        }
                    }
                ]
            },
            {
                "placement": 1,
                "players": [
                    {
                        "account": "720356",
                        "stats": {
                            "char": "84",
                            "kills": 0,
                            "deaths": 0,
                            "score": 0,
                            "round_wins": 0,
                            "guest_kills": 0,
                            "bot_kills": 0,
                            "registered_kills": 0,
                            "clan_kills": 0,
                            "bot_deaths": 0,
                            "boss_kills": 0,
                            "revives": 0,
                            "flags": 0,
                            "assists": 0
                        }
                    }
                ]
            }
        ],
        "duration": 5,
        "gravity": 0.07,
        "damageMultiplier": 1,
        "timeVelocity": 1,
        "killsToWin": 10,
        "gameMode": "team_deathmatch",
        "map": "93",
        "region": "san-francisco"
    }
}

Documentation

• match: See Match

Match

Example

{
  "matchId": "xxxx",
  "status": "complete",
  "teams": [
    {
      "placement": 1,
      "players": [
        {
          "account": "30",
          "stats": {
            "char": "105",
            "kills": 0,
            "deaths": 0,
            "score": 0,
            "round_wins": 0,
            "guest_kills": 0,
            "bot_kills": 0,
            "registered_kills": 0,
            "clan_kills": 0,
            "bot_deaths": 0,
            "boss_kills": 0,
            "revives": 0,
            "flags": 0,
            "assists": 0
          }
        }
      ]
    },
    {
      "placement": 1,
      "players": [
        {
          "account": "720356",
          "stats": {
            "char": "84",
            "kills": 0,
            "deaths": 0,
            "score": 0,
            "round_wins": 0,
            "guest_kills": 0,
            "bot_kills": 0,
            "registered_kills": 0,
            "clan_kills": 0,
            "bot_deaths": 0,
            "boss_kills": 0,
            "revives": 0,
            "flags": 0,
            "assists": 0
          }
        }
      ]
    }
  ],
  "duration": 5,
  "gravity": 0.07,
  "damageMultiplier": 1,
  "timeVelocity": 1,
  "killsToWin": 10,
  "gameMode": "team_deathmatch",
  "map": "93",
  "region": "san-francisco"
}

Documentation

• matchId: Use this ID to get the match status or generate the join link (e.g. https://ev.io/?match=MATCH_ID)
• status: "pending" | "running" | "complete" | "cancelled"
• teams
  • placement
  • players
    • account: Player's account ID stats
• duration
• gravity
• damageMultiplier
• timeVelocity
• killsToWin
• gameMode: "team_deathmatch"
• map
• region: "san-francisco" | "new-jersey" | "singapore" | "amsterdam"

Match Callback

POST request sent to callbackUrl.

Example

{
    "match": {
      "matchId": "xxxx",
      "status": "complete",
      "teams": [
        {
          "placement": 1,
          "players": [
            {
              "account": "30",
              "stats": {
                "char": "105",
                "kills": 0,
                "deaths": 0,
                "score": 0,
                "round_wins": 0,
                "guest_kills": 0,
                "bot_kills": 0,
                "registered_kills": 0,
                "clan_kills": 0,
                "bot_deaths": 0,
                "boss_kills": 0,
                "revives": 0,
                "flags": 0,
                "assists": 0
              }
            }
          ]
        },
        {
          "placement": 1,
          "players": [
            {
              "account": "720356",
              "stats": {
                "char": "84",
                "kills": 0,
                "deaths": 0,
                "score": 0,
                "round_wins": 0,
                "guest_kills": 0,
                "bot_kills": 0,
                "registered_kills": 0,
                "clan_kills": 0,
                "bot_deaths": 0,
                "boss_kills": 0,
                "revives": 0,
                "flags": 0,
                "assists": 0
              }
            }
          ]
        }
      ],
      "duration": 5,
      "gravity": 0.07,
      "damageMultiplier": 1,
      "timeVelocity": 1,
      "killsToWin": 10,
      "gameMode": "team_deathmatch",
      "map": "93",
      "region": "san-francisco"
    }
}

Documentation

• match: See Match