Get a CS2 match

200

Success

Response body

object

string

required

game_server_id

string

required

Id of the game server to run the match on. Must be a CS2 server on the same account as the match

team1

object

Settings for team 1, which starts as CT

name

string

required

Team name

flag

string

required

Team flag (ISO alpha-2: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)

stats

object

team2

object

Settings for team 2, which starts as T

name

string

required

Team name

flag

string

required

Team flag (ISO alpha-2: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)

stats

object

players

array of objects

required

players*

object

match_id

string

required

steam_id_64

string

required

team

string

required

team1 team2 spectator

nickname_override

string

required

connected

boolean

required

kicked

boolean

required

disconnected_at

integer

If the player left the match during the live phase this will be the UNIX timestamp of the last disconnect event. Otherwise null.

disconnected_reason

string

If the player left the match during the live phase this will be the reason for the disconnect. Otherwise null.

stats

object

required

settings

object

map

string

required

Specifies the map for the match. Options include local/official maps (e.g. de_dust2), workshop maps (e.g. workshop/3071899764), or null for the server-configured map.

password

string

required

Server password. Use "" to remove the password. Use null to use the password configured on the game server.

connect_time

integer

required

Defaults to 300

Time in seconds until match is canceled if not everyone has joined

match_begin_countdown

integer

required

Defaults to 30

Time in seconds after everyone has joined until match start

team_size

integer

required

Amount of players in each team. By default, the number of players will be the same as the number of Steam IDs entered in each team. Set this to a custom amount if you need to enter more Steam IDs than should participate, for example, to allow an emergency substitution during the game.

wait_for_gotv

boolean

required

Defaults to false

Controls the GOTV demo recording stop time to mitigate the "GOTV lag spoiler".
False: Stops demo 20s after match ends.
True: Stops demo after tv_delay (default 105s) + 20s after match ends. Recommended if you have live GOTV viewers.

enable_plugin

boolean

required

Defaults to false

Enable experimental CounterStrikeSharp plugin to lock players to their teams

enable_tech_pause

boolean

required

Defaults to false

Enable tech pause using the !tech chat command

webhooks

object

required

match_end_url

string

required

round_end_url

string

required

player_votekick_success_url

string

required

event_url

string

required

URL that will recieve webhooks for all event types specified by the "enabled_events" setting

enabled_events

array of strings

required

Array of event types to subscribe to, use ["*"] to subscribe to all avents

enabled_events*

authorization_header

string

required

rounds_played

integer

required

finished

boolean

required

cancel_reason

string

required

events

array of objects

required

events*

object

event

string

required

The type of event that was triggered

booting_server loading_map server_ready_for_players all_players_connected match_started match_ended players_exited gotv_stopped player_connected player_disconnected player_votekicked round_end match_canceled

timestamp

integer

required

UNIX timestamp when the event was triggered

payload

object

Additional data depending on the object type

Has additional fields

200Success