match
public endpoints
/api/v4/matchup/$matchID
parameters
| name | type | description |
|---|---|---|
| $matchID (required) | int | This is the ID of the match. |
response (code: 404)
{
"error": {
"code": 404,
"msg": "no entry with the ID: $matchID found."
}
}
response (code: 200)
{
"ID": 1,
"best_of": 1,
"state_key": 6,
"to_be_played_on": {
"date": "2020-02-21 19:00:00.000000",
"timezone_type": 3,
"timezone": "Europe\/Berlin"
},
"playday": 0,
"url": "https:\/\/www.opleague.pro\/match\/1-OPL-Staff-vs-Recast-Gaming-Youngstars",
"logo_array": null,
"logo_array_on_black": null,
"header_array": null,
"keyart_array": null,
"teams": {
"1": {
"ID": 1,
"name": "OPL Staff",
"short_name": "STAFF",
"residence_name": "Germany",
"url": "https:\/\/www.opleague.pro\/team\/1-OPL-Staff",
"game": {
"ID": 1,
"name": "Rainbow Six Siege",
"short_name": "R6",
"min_age": 18,
"logo_array": [],
"logo_array_on_black": [],
"logo_color_array": [],
"keyart_array": [],
"cover_array": []
},
"description": null,
"discord": "discord.com\/invite\/K4ST7kdBby",
"twitter": "opleaguepro",
"twitch": "opleagueeu",
"youtube": null,
"website": "https:\/\/www.opleague.pro",
"logo_array": {
"background": "..\/styles\/media\/team\/1\/Logo_background.png"
},
"logo_array_on_black": [],
"banner_array": [],
"position_within_match": 1
},
"32": {
"ID": 32,
"name": "Recast Gaming Youngstars",
"short_name": "RcG",
"residence_name": "Europe",
"url": "https:\/\/www.opleague.pro\/team\/32-Recast-Gaming-Youngstars",
"game": {
"ID": 1,
"name": "Rainbow Six Siege",
"short_name": "R6",
"min_age": 18,
"logo_array": [],
"logo_array_on_black": [],
"logo_color_array": [],
"keyart_array": [],
"cover_array": []
},
"description": null,
"discord": null,
"twitter": "gaming_recast",
"twitch": null,
"youtube": null,
"website": null,
"logo_array": {
"background": "..\/styles\/media\/team\/32\/Logo_background.png"
},
"logo_array_on_black": [],
"banner_array": [],
"position_within_match": 2
}
},
"tournament": {
"ID": 1,
"name": "Beta Cup #1",
"start_on": {
"date": "2020-02-21 19:00:00.000000",
"timezone_type": 3,
"timezone": "Europe\/Berlin"
},
"end_on": {
"date": "2020-02-21 23:39:10.000000",
"timezone_type": 3,
"timezone": "Europe\/Berlin"
},
"state_key": 2,
"visibility": 1,
"type_key": 1,
"url": "https:\/\/www.opleague.pro\/event\/1-BetaCup1\/course",
"game": {
"ID": 1,
"name": "Rainbow Six Siege",
"short_name": "R6",
"min_age": 18,
"logo_array": [],
"logo_array_on_black": [],
"logo_color_array": [],
"keyart_array": [],
"cover_array": []
},
"platforms": {
"1": {
"ID": 1,
"name": "PC",
"icon_class": "fas fa-desktop"
}
},
"logo_array": {
"background": "..\/styles\/media\/event\/1\/Logo_background.png"
},
"logo_array_on_black": {
"is_on_error": true
},
"header_array": [],
"keyart_array": {
"on_error": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNgYAAAAAMAASsJTYQAAAAASUVORK5CYII=",
"original": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNgYAAAAAMAASsJTYQAAAAASUVORK5CYII=",
"compressed": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNgYAAAAAMAASsJTYQAAAAASUVORK5CYII=",
"is_on_error": true,
"background": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNgYAAAAAMAASsJTYQAAAAASUVORK5CYII="
},
"ancestors": [],
"leafes": [
1
]
}
}
You are able to stack request with optional parameters like so: /api/v4/matchup/$matchID/$additional1,$additional2,$additional3
/api/v4/matchup/$matchID/map_vote
parameters
| name | type | description |
|---|---|---|
| $matchID (required) | int | This is the ID of the match. |
| map_vote | string | Get the map veto of a match. |
response (code: 400)
{
"error": {
"code": 400,
"msg": "addtional request is invalid: $additional"
}
}
response (code: 404)
{
"error": {
"code": 404,
"msg": "no entry with the ID: $matchID found."
}
}
response (code: 200)
{
"ID": 1,
"best_of": 1,
"state_key": 6,
"to_be_played_on": {
"date": "2020-02-21 19:00:00.000000",
"timezone_type": 3,
"timezone": "Europe\/Berlin"
},
"playday": 0,
"url": "https:\/\/www.opleague.pro\/match\/1-OPL-Staff-vs-Recast-Gaming-Youngstars",
"logo_array": null,
"logo_array_on_black": null,
"header_array": null,
"keyart_array": null,
"teams": {
"1": {
"ID": 1,
"name": "OPL Staff",
"short_name": "STAFF",
"residence_name": "Germany",
"url": "https:\/\/www.opleague.pro\/team\/1-OPL-Staff",
"game": {
"ID": 1,
"name": "Rainbow Six Siege",
"short_name": "R6",
"min_age": 18,
"logo_array": [],
"logo_array_on_black": [],
"logo_color_array": [],
"keyart_array": [],
"cover_array": []
},
"description": null,
"discord": "discord.com\/invite\/K4ST7kdBby",
"twitter": "opleaguepro",
"twitch": "opleagueeu",
"youtube": null,
"website": "https:\/\/www.opleague.pro",
"logo_array": {
"background": "..\/styles\/media\/team\/1\/Logo_background.png"
},
"logo_array_on_black": [],
"banner_array": [],
"position_within_match": 1
},
"32": {
"ID": 32,
"name": "Recast Gaming Youngstars",
"short_name": "RcG",
"residence_name": "Europe",
"url": "https:\/\/www.opleague.pro\/team\/32-Recast-Gaming-Youngstars",
"game": {
"ID": 1,
"name": "Rainbow Six Siege",
"short_name": "R6",
"min_age": 18,
"logo_array": [],
"logo_array_on_black": [],
"logo_color_array": [],
"keyart_array": [],
"cover_array": []
},
"description": null,
"discord": null,
"twitter": "gaming_recast",
"twitch": null,
"youtube": null,
"website": null,
"logo_array": {
"background": "..\/styles\/media\/team\/32\/Logo_background.png"
},
"logo_array_on_black": [],
"banner_array": [],
"position_within_match": 2
}
},
"tournament": {
"ID": 1,
"name": "Beta Cup #1",
"start_on": {
"date": "2020-02-21 19:00:00.000000",
"timezone_type": 3,
"timezone": "Europe\/Berlin"
},
"end_on": {
"date": "2020-02-21 23:39:10.000000",
"timezone_type": 3,
"timezone": "Europe\/Berlin"
},
"state_key": 2,
"visibility": 1,
"type_key": 1,
"url": "https:\/\/www.opleague.pro\/event\/1-BetaCup1\/course",
"game": {
"ID": 1,
"name": "Rainbow Six Siege",
"short_name": "R6",
"min_age": 18,
"logo_array": [],
"logo_array_on_black": [],
"logo_color_array": [],
"keyart_array": [],
"cover_array": []
},
"platforms": {
"1": {
"ID": 1,
"name": "PC",
"icon_class": "fas fa-desktop"
}
},
"logo_array": {
"background": "..\/styles\/media\/event\/1\/Logo_background.png"
},
"logo_array_on_black": {
"is_on_error": true
},
"header_array": [],
"keyart_array": {
"on_error": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNgYAAAAAMAASsJTYQAAAAASUVORK5CYII=",
"original": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNgYAAAAAMAASsJTYQAAAAASUVORK5CYII=",
"compressed": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNgYAAAAAMAASsJTYQAAAAASUVORK5CYII=",
"is_on_error": true,
"background": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNgYAAAAAMAASsJTYQAAAAASUVORK5CYII="
},
"ancestors": [],
"leafes": [
1
]
},
"map_vote": [
{
"map_ID": "4",
"map_name": "coastline",
"map_logo": "https:\/\/www.opleague.pro\/styles\/media\/game\/R6\/map\/coastline.png",
"done_on": {
"date": "2020-02-21 14:36:59.000000",
"timezone_type": 3,
"timezone": "Europe\/Berlin"
},
"done_by_team": "1",
"type": "B",
"type_name": "Ban",
"meta_data": null
},
{
"map_ID": "6",
"map_name": "kafe",
"map_logo": "https:\/\/www.opleague.pro\/styles\/media\/game\/R6\/map\/kafe.png",
"done_on": {
"date": "2020-02-21 14:37:02.000000",
"timezone_type": 3,
"timezone": "Europe\/Berlin"
},
"done_by_team": "2",
"type": "B",
"type_name": "Ban",
"meta_data": null
},
{
"map_ID": "7",
"map_name": "villa",
"map_logo": "https:\/\/www.opleague.pro\/styles\/media\/game\/R6\/map\/villa.png",
"done_on": {
"date": "2020-02-21 14:37:05.000000",
"timezone_type": 3,
"timezone": "Europe\/Berlin"
},
"done_by_team": "1",
"type": "B",
"type_name": "Ban",
"meta_data": null
},
{
"map_ID": "1",
"map_name": "bank",
"map_logo": "https:\/\/www.opleague.pro\/styles\/media\/game\/R6\/map\/bank.png",
"done_on": {
"date": "2020-02-21 14:37:09.000000",
"timezone_type": 3,
"timezone": "Europe\/Berlin"
},
"done_by_team": "2",
"type": "B",
"type_name": "Ban",
"meta_data": null
},
{
"map_ID": "5",
"map_name": "consulate",
"map_logo": "https:\/\/www.opleague.pro\/styles\/media\/game\/R6\/map\/consulate.png",
"done_on": {
"date": "2020-02-21 14:37:12.000000",
"timezone_type": 3,
"timezone": "Europe\/Berlin"
},
"done_by_team": "1",
"type": "B",
"type_name": "Ban",
"meta_data": null
},
{
"map_ID": "2",
"map_name": "border",
"map_logo": "https:\/\/www.opleague.pro\/styles\/media\/game\/R6\/map\/border.png",
"done_on": {
"date": "2020-02-21 14:37:17.000000",
"timezone_type": 3,
"timezone": "Europe\/Berlin"
},
"done_by_team": "2",
"type": "B",
"type_name": "Ban",
"meta_data": null
},
{
"map_ID": "3",
"map_name": "clubhouse",
"map_logo": "https:\/\/www.opleague.pro\/styles\/media\/game\/R6\/map\/clubhouse.png",
"done_on": {
"date": "2020-02-21 14:37:17.000000",
"timezone_type": 3,
"timezone": "Europe\/Berlin"
},
"done_by_team": "1",
"type": "A",
"type_name": "Pick",
"meta_data": {
"ATK_team": 1
}
}
]
}
/api/v4/matchup/$matchID/prediction
parameters
| name | type | description |
|---|---|---|
| $matchID (required) | int | This is the ID of the match. |
| prediction | string | Get the user predictions of a match. |
response (code: 400)
{
"error": {
"code": 400,
"msg": "addtional request is invalid: $additional"
}
}
response (code: 404)
{
"error": {
"code": 404,
"msg": "no entry with the ID: $matchID found."
}
}
response (code: 200)
{
"ID": 1,
"best_of": 1,
"state_key": 6,
"to_be_played_on": {
"date": "2020-02-21 19:00:00.000000",
"timezone_type": 3,
"timezone": "Europe\/Berlin"
},
"playday": 0,
"url": "https:\/\/www.opleague.pro\/match\/1-OPL-Staff-vs-Recast-Gaming-Youngstars",
"logo_array": null,
"logo_array_on_black": null,
"header_array": null,
"keyart_array": null,
"teams": {
"1": {
"ID": 1,
"name": "OPL Staff",
"short_name": "STAFF",
"residence_name": "Germany",
"url": "https:\/\/www.opleague.pro\/team\/1-OPL-Staff",
"game": {
"ID": 1,
"name": "Rainbow Six Siege",
"short_name": "R6",
"min_age": 18,
"logo_array": [],
"logo_array_on_black": [],
"logo_color_array": [],
"keyart_array": [],
"cover_array": []
},
"description": null,
"discord": "discord.com\/invite\/K4ST7kdBby",
"twitter": "opleaguepro",
"twitch": "opleagueeu",
"youtube": null,
"website": "https:\/\/www.opleague.pro",
"logo_array": {
"background": "..\/styles\/media\/team\/1\/Logo_background.png"
},
"logo_array_on_black": [],
"banner_array": [],
"position_within_match": 1
},
"32": {
"ID": 32,
"name": "Recast Gaming Youngstars",
"short_name": "RcG",
"residence_name": "Europe",
"url": "https:\/\/www.opleague.pro\/team\/32-Recast-Gaming-Youngstars",
"game": {
"ID": 1,
"name": "Rainbow Six Siege",
"short_name": "R6",
"min_age": 18,
"logo_array": [],
"logo_array_on_black": [],
"logo_color_array": [],
"keyart_array": [],
"cover_array": []
},
"description": null,
"discord": null,
"twitter": "gaming_recast",
"twitch": null,
"youtube": null,
"website": null,
"logo_array": {
"background": "..\/styles\/media\/team\/32\/Logo_background.png"
},
"logo_array_on_black": [],
"banner_array": [],
"position_within_match": 2
}
},
"tournament": {
"ID": 1,
"name": "Beta Cup #1",
"start_on": {
"date": "2020-02-21 19:00:00.000000",
"timezone_type": 3,
"timezone": "Europe\/Berlin"
},
"end_on": {
"date": "2020-02-21 23:39:10.000000",
"timezone_type": 3,
"timezone": "Europe\/Berlin"
},
"state_key": 2,
"visibility": 1,
"type_key": 1,
"url": "https:\/\/www.opleague.pro\/event\/1-BetaCup1\/course",
"game": {
"ID": 1,
"name": "Rainbow Six Siege",
"short_name": "R6",
"min_age": 18,
"logo_array": [],
"logo_array_on_black": [],
"logo_color_array": [],
"keyart_array": [],
"cover_array": []
},
"platforms": {
"1": {
"ID": 1,
"name": "PC",
"icon_class": "fas fa-desktop"
}
},
"logo_array": {
"background": "..\/styles\/media\/event\/1\/Logo_background.png"
},
"logo_array_on_black": {
"is_on_error": true
},
"header_array": [],
"keyart_array": {
"on_error": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNgYAAAAAMAASsJTYQAAAAASUVORK5CYII=",
"original": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNgYAAAAAMAASsJTYQAAAAASUVORK5CYII=",
"compressed": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNgYAAAAAMAASsJTYQAAAAASUVORK5CYII=",
"is_on_error": true,
"background": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNgYAAAAAMAASsJTYQAAAAASUVORK5CYII="
},
"ancestors": [],
"leafes": [
1
]
},
"prediction": {
"1": {
"vote_count": 0,
"percent": 0
},
"32": {
"vote_count": 0,
"percent": 0
}
}
}
/api/v4/matchup/$matchID/result
parameters
| name | type | description |
|---|---|---|
| $matchID (required) | int | This is the ID of the match. |
| result | string | Get the result of a match. |
response (code: 400)
{
"error": {
"code": 400,
"msg": "addtional request is invalid: $additional"
}
}
response (code: 404)
{
"error": {
"code": 404,
"msg": "no entry with the ID: $matchID found."
}
}
response (code: 200)
{
"ID": 1,
"best_of": 1,
"state_key": 6,
"to_be_played_on": {
"date": "2020-02-21 19:00:00.000000",
"timezone_type": 3,
"timezone": "Europe\/Berlin"
},
"playday": 0,
"url": "https:\/\/www.opleague.pro\/match\/1-OPL-Staff-vs-Recast-Gaming-Youngstars",
"logo_array": null,
"logo_array_on_black": null,
"header_array": null,
"keyart_array": null,
"teams": {
"1": {
"ID": 1,
"name": "OPL Staff",
"short_name": "STAFF",
"residence_name": "Germany",
"url": "https:\/\/www.opleague.pro\/team\/1-OPL-Staff",
"game": {
"ID": 1,
"name": "Rainbow Six Siege",
"short_name": "R6",
"min_age": 18,
"logo_array": [],
"logo_array_on_black": [],
"logo_color_array": [],
"keyart_array": [],
"cover_array": []
},
"description": null,
"discord": "discord.com\/invite\/K4ST7kdBby",
"twitter": "opleaguepro",
"twitch": "opleagueeu",
"youtube": null,
"website": "https:\/\/www.opleague.pro",
"logo_array": {
"background": "..\/styles\/media\/team\/1\/Logo_background.png"
},
"logo_array_on_black": [],
"banner_array": [],
"position_within_match": 1
},
"32": {
"ID": 32,
"name": "Recast Gaming Youngstars",
"short_name": "RcG",
"residence_name": "Europe",
"url": "https:\/\/www.opleague.pro\/team\/32-Recast-Gaming-Youngstars",
"game": {
"ID": 1,
"name": "Rainbow Six Siege",
"short_name": "R6",
"min_age": 18,
"logo_array": [],
"logo_array_on_black": [],
"logo_color_array": [],
"keyart_array": [],
"cover_array": []
},
"description": null,
"discord": null,
"twitter": "gaming_recast",
"twitch": null,
"youtube": null,
"website": null,
"logo_array": {
"background": "..\/styles\/media\/team\/32\/Logo_background.png"
},
"logo_array_on_black": [],
"banner_array": [],
"position_within_match": 2
}
},
"tournament": {
"ID": 1,
"name": "Beta Cup #1",
"start_on": {
"date": "2020-02-21 19:00:00.000000",
"timezone_type": 3,
"timezone": "Europe\/Berlin"
},
"end_on": {
"date": "2020-02-21 23:39:10.000000",
"timezone_type": 3,
"timezone": "Europe\/Berlin"
},
"state_key": 2,
"visibility": 1,
"type_key": 1,
"url": "https:\/\/www.opleague.pro\/event\/1-BetaCup1\/course",
"game": {
"ID": 1,
"name": "Rainbow Six Siege",
"short_name": "R6",
"min_age": 18,
"logo_array": [],
"logo_array_on_black": [],
"logo_color_array": [],
"keyart_array": [],
"cover_array": []
},
"platforms": {
"1": {
"ID": 1,
"name": "PC",
"icon_class": "fas fa-desktop"
}
},
"logo_array": {
"background": "..\/styles\/media\/event\/1\/Logo_background.png"
},
"logo_array_on_black": {
"is_on_error": true
},
"header_array": [],
"keyart_array": {
"on_error": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNgYAAAAAMAASsJTYQAAAAASUVORK5CYII=",
"original": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNgYAAAAAMAASsJTYQAAAAASUVORK5CYII=",
"compressed": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNgYAAAAAMAASsJTYQAAAAASUVORK5CYII=",
"is_on_error": true,
"background": "data:image\/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNgYAAAAAMAASsJTYQAAAAASUVORK5CYII="
},
"ancestors": [],
"leafes": [
1
]
},
"result": {
"scores": {
"1": 0,
"32": 0
},
"win_IDs": [],
"draw_IDs": [],
"loss_IDs": [
1,
32
],
"defwin": [],
"defloss": [],
"state_key": null,
"result_segments": {
"1": {
"scores": {
"1": "-",
"32": "-"
},
"win_IDs": [],
"draw_IDs": [],
"loss_IDs": [
1,
32
],
"defwin": [],
"defloss": [],
"state_key": 1,
"state_key_name": "waiting",
"map": null,
"additional": []
}
}
}
}
private endpoints
In order fetch data from private endpoints you need to request access first.
/api/v4/matchup/$matchID/comment
parameters
| name | type | description |
|---|---|---|
| $matchID (required) | int | This is the ID of the match. |
| comment | string | Get the entire chat history of a match. |
response (code: 400)
{
"error": {
"code": 400,
"msg": "addtional request is invalid: $additional"
}
}
response (code: 404)
{
"error": {
"code": 404,
"msg": "no entry with the ID: $matchID found."
}
}
response (code: 200)
PRIVATE