Retrieve all championships of a game
Retrieve all championships of a game
Authorizations:
query Parameters
game required | string The id of the game |
type | string Enum: "all" "upcoming" "ongoing" "past" Kind of matches to return. Can be all(default), upcoming, ongoing or past |
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 10 ] Default: 10 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "anticheat_required": true,
- "avatar": "string",
- "background_image": "string",
- "championship_id": "string",
- "championship_start": 0,
- "checkin_clear": 0,
- "checkin_enabled": true,
- "checkin_start": 0,
- "cover_image": "string",
- "current_subscriptions": 0,
- "description": "string",
- "faceit_url": "string",
- "featured": true,
- "full": true,
- "game_data": {
- "assets": {
- "cover": "string",
- "featured_img_l": "string",
- "featured_img_m": "string",
- "featured_img_s": "string",
- "flag_img_icon": "string",
- "flag_img_l": "string",
- "flag_img_m": "string",
- "flag_img_s": "string",
- "landing_page": "string"
}, - "game_id": "string",
- "long_label": "string",
- "order": 0,
- "parent_game_id": "string",
- "platforms": [
- "string"
], - "regions": [
- "string"
], - "short_label": "string"
}, - "game_id": "string",
- "id": "string",
- "join_checks": {
- "allowed_team_types": [
- "string"
], - "blacklist_geo_countries": [
- "string"
], - "join_policy": "string",
- "max_skill_level": 0,
- "membership_type": "string",
- "min_skill_level": 0,
- "whitelist_geo_countries": [
- "string"
], - "whitelist_geo_countries_min_players": 0
}, - "name": "string",
- "organizer_data": {
- "avatar": "string",
- "cover": "string",
- "description": "string",
- "facebook": "string",
- "faceit_url": "string",
- "followers_count": 0,
- "name": "string",
- "organizer_id": "string",
- "twitch": "string",
- "twitter": "string",
- "type": "string",
- "vk": "string",
- "website": "string",
- "youtube": "string"
}, - "organizer_id": "string",
- "prizes": [
- {
- "faceit_points": 0,
- "rank": 0
}
], - "region": "string",
- "rules_id": "string",
- "schedule": {
- "property1": {
- "date": 0,
- "status": "string"
}, - "property2": {
- "date": 0,
- "status": "string"
}
}, - "screening": {
- "enabled": true,
- "id": "string"
}, - "seeding_strategy": "string",
- "slots": 0,
- "status": "string",
- "stream": {
- "active": true,
- "platform": "string",
- "source": "string",
- "title": "string"
}, - "subscription_end": 0,
- "subscription_start": 0,
- "subscriptions_locked": true,
- "substitution_configuration": {
- "max_substitutes": 0,
- "max_substitutions": 0
}, - "total_groups": 0,
- "total_prizes": 0,
- "total_rounds": 0,
- "type": "string"
}
], - "start": 0
}
Retrieve championship details
Retrieve championship details
Authorizations:
path Parameters
championship_id required | string The id of the championship |
query Parameters
expanded | Array of strings unique Items Enum: "organizer" "game" List of entity names to expand in request |
Responses
Response samples
- 200
{- "anticheat_required": true,
- "avatar": "string",
- "background_image": "string",
- "championship_id": "string",
- "championship_start": 0,
- "checkin_clear": 0,
- "checkin_enabled": true,
- "checkin_start": 0,
- "cover_image": "string",
- "current_subscriptions": 0,
- "description": "string",
- "faceit_url": "string",
- "featured": true,
- "full": true,
- "game_data": {
- "assets": {
- "cover": "string",
- "featured_img_l": "string",
- "featured_img_m": "string",
- "featured_img_s": "string",
- "flag_img_icon": "string",
- "flag_img_l": "string",
- "flag_img_m": "string",
- "flag_img_s": "string",
- "landing_page": "string"
}, - "game_id": "string",
- "long_label": "string",
- "order": 0,
- "parent_game_id": "string",
- "platforms": [
- "string"
], - "regions": [
- "string"
], - "short_label": "string"
}, - "game_id": "string",
- "id": "string",
- "join_checks": {
- "allowed_team_types": [
- "string"
], - "blacklist_geo_countries": [
- "string"
], - "join_policy": "string",
- "max_skill_level": 0,
- "membership_type": "string",
- "min_skill_level": 0,
- "whitelist_geo_countries": [
- "string"
], - "whitelist_geo_countries_min_players": 0
}, - "name": "string",
- "organizer_data": {
- "avatar": "string",
- "cover": "string",
- "description": "string",
- "facebook": "string",
- "faceit_url": "string",
- "followers_count": 0,
- "name": "string",
- "organizer_id": "string",
- "twitch": "string",
- "twitter": "string",
- "type": "string",
- "vk": "string",
- "website": "string",
- "youtube": "string"
}, - "organizer_id": "string",
- "prizes": [
- {
- "faceit_points": 0,
- "rank": 0
}
], - "region": "string",
- "rules_id": "string",
- "schedule": {
- "property1": {
- "date": 0,
- "status": "string"
}, - "property2": {
- "date": 0,
- "status": "string"
}
}, - "screening": {
- "enabled": true,
- "id": "string"
}, - "seeding_strategy": "string",
- "slots": 0,
- "status": "string",
- "stream": {
- "active": true,
- "platform": "string",
- "source": "string",
- "title": "string"
}, - "subscription_end": 0,
- "subscription_start": 0,
- "subscriptions_locked": true,
- "substitution_configuration": {
- "max_substitutes": 0,
- "max_substitutions": 0
}, - "total_groups": 0,
- "total_prizes": 0,
- "total_rounds": 0,
- "type": "string"
}
Retrieve all matches of a championship
Retrieve all matches of a championship
Authorizations:
path Parameters
championship_id required | string The id of the championship |
query Parameters
type | string Enum: "all" "upcoming" "ongoing" "past" Kind of matches to return. Can be all(default), upcoming, ongoing or past |
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "best_of": 0,
- "broadcast_start_time": 0,
- "broadcast_start_time_label": "string",
- "calculate_elo": true,
- "chat_room_id": "string",
- "competition_id": "string",
- "competition_name": "string",
- "competition_type": "string",
- "configured_at": 0,
- "demo_url": [
- "string"
], - "detailed_results": [
- {
- "asc_score": true,
- "factions": {
- "property1": {
- "score": 2
}, - "property2": {
- "score": 2
}
}, - "winner": "string"
}
], - "faceit_url": "string",
- "finished_at": 0,
- "game": "string",
- "group": 0,
- "match_id": "string",
- "organizer_id": "string",
- "region": "string",
- "results": {
- "score": {
- "property1": 0,
- "property2": 0
}, - "winner": "string"
}, - "round": 0,
- "scheduled_at": 0,
- "started_at": 0,
- "status": "string",
- "teams": {
- "property1": {
- "avatar": "string",
- "faction_id": "string",
- "leader": "string",
- "name": "string",
- "roster": [
- {
- "anticheat_required": true,
- "avatar": "string",
- "game_player_id": "string",
- "game_player_name": "string",
- "game_skill_level": 0,
- "membership": "string",
- "nickname": "string",
- "player_id": "string"
}
], - "roster_v1": null,
- "stats": {
- "rating": 0,
- "skillLevel": {
- "average": 0,
- "range": {
- "max": 0,
- "min": 0
}
}, - "winProbability": 0
}, - "substituted": true,
- "type": "string"
}, - "property2": {
- "avatar": "string",
- "faction_id": "string",
- "leader": "string",
- "name": "string",
- "roster": [
- {
- "anticheat_required": true,
- "avatar": "string",
- "game_player_id": "string",
- "game_player_name": "string",
- "game_skill_level": 0,
- "membership": "string",
- "nickname": "string",
- "player_id": "string"
}
], - "roster_v1": null,
- "stats": {
- "rating": 0,
- "skillLevel": {
- "average": 0,
- "range": {
- "max": 0,
- "min": 0
}
}, - "winProbability": 0
}, - "substituted": true,
- "type": "string"
}
}, - "version": 0,
- "voting": null
}
], - "start": 0
}
Retrieve all results of a championship
Retrieve all results of a championship
Authorizations:
path Parameters
championship_id required | string The id of the championship |
query Parameters
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "bounds": {
- "left": 0,
- "right": 0
}, - "placements": [
- {
- "id": "string",
- "name": "string",
- "type": "string"
}
]
}
], - "start": 0
}
Retrieve all subscriptions of a championship
Retrieve all subscriptions of a championship
Authorizations:
path Parameters
championship_id required | string The id of the championship |
query Parameters
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 10 ] Default: 10 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "coach": "string",
- "coleader": "string",
- "group": 0,
- "leader": "string",
- "roster": [
- "string"
], - "status": "string",
- "substitutes": [
- "string"
], - "team": {
- "chat_room_id": "team-6204037c-30e6-408b-8aaa-dd8219860b4b",
- "description": "Some description",
- "game": "csgo",
- "leader": "leader",
- "members": [
- {
- "country": "GB",
- "faceit_url": "string",
- "membership_type": "string",
- "memberships": [
- "free",
- "unlimited"
], - "nickname": "nickname",
- "skill_level": 1,
- "user_id": "6204037c-30e6-408b-8aaa-dd8219860b4b"
}
], - "name": "name",
- "nickname": "nickname",
- "team_id": "6204037c-30e6-408b-8aaa-dd8219860b4b",
- "team_type": "premade",
}
}
], - "start": 0
}
Retrieve details of all games on FACEIT
Retrieve details of all games on FACEIT
Authorizations:
query Parameters
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "assets": {
- "cover": "string",
- "featured_img_l": "string",
- "featured_img_m": "string",
- "featured_img_s": "string",
- "flag_img_icon": "string",
- "flag_img_l": "string",
- "flag_img_m": "string",
- "flag_img_s": "string",
- "landing_page": "string"
}, - "game_id": "string",
- "long_label": "string",
- "order": 0,
- "parent_game_id": "string",
- "platforms": [
- "string"
], - "regions": [
- "string"
], - "short_label": "string"
}
], - "start": 0
}
Retrieve details of all matchmakings of a game on FACEIT
Retrieve details of all matchmakings of a game on FACEIT
Authorizations:
path Parameters
game_id required | string Example: cs2 The id of the game |
query Parameters
region | string Example: region=EU The region of the matchmakings |
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "game": "string",
- "has_league": true,
- "id": "string",
- "name": "string",
- "region": "string"
}
], - "start": 0
}
Retrieve game details
Retrieve game details
Authorizations:
path Parameters
game_id required | string The id of the game |
Responses
Response samples
- 200
{- "assets": {
- "cover": "string",
- "featured_img_l": "string",
- "featured_img_m": "string",
- "featured_img_s": "string",
- "flag_img_icon": "string",
- "flag_img_l": "string",
- "flag_img_m": "string",
- "flag_img_s": "string",
- "landing_page": "string"
}, - "game_id": "string",
- "long_label": "string",
- "order": 0,
- "parent_game_id": "string",
- "platforms": [
- "string"
], - "regions": [
- "string"
], - "short_label": "string"
}
Retrieve the details of the parent game, if the game is region-specific
Retrieve the details of the parent game, if the game is region-specific
Authorizations:
path Parameters
game_id required | string The id of the game |
Responses
Response samples
- 200
{- "assets": {
- "cover": "string",
- "featured_img_l": "string",
- "featured_img_m": "string",
- "featured_img_s": "string",
- "flag_img_icon": "string",
- "flag_img_l": "string",
- "flag_img_m": "string",
- "flag_img_s": "string",
- "landing_page": "string"
}, - "game_id": "string",
- "long_label": "string",
- "order": 0,
- "parent_game_id": "string",
- "platforms": [
- "string"
], - "regions": [
- "string"
], - "short_label": "string"
}
Retrieve queues by filters on FACEIT
Retrieve queues by filters on FACEIT. Available only for game developers and queue owners(organizers)
Authorizations:
path Parameters
game_id required | string Example: csgo The id of the game |
query Parameters
entity_type required | string Example: entity_type=hub The type of the entity |
entity_id required | string The id of the entity |
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 20 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "entityId": "string",
- "entityType": "string",
- "game": "string",
- "id": "string",
- "lastModified": "2019-08-24T14:15:22Z",
- "open": true,
- "organizerId": "string",
- "queueName": "string",
- "region": "string",
- "state": "string"
}
], - "start": 0
}
Retrieve details of a queue on FACEIT
Retrieve details of a queue on FACEIT. Available only for game or queue owners(organizers)
Authorizations:
path Parameters
game_id required | string Example: cs2 The id of the game |
queue_id required | string The id of the queue |
Responses
Response samples
- 200
{- "adminTool": true,
- "anticheatRequired": true,
- "calculateElo": true,
- "captainSelection": "string",
- "checkIn": {
- "time": 0
}, - "entityId": "string",
- "entityType": "string",
- "fbiManagement": true,
- "game": "string",
- "groupSimilar": true,
- "id": "string",
- "joinType": {
- "maxParty": 0,
- "party": true,
- "premade": true,
- "solo": true
}, - "lastModified": "2019-08-24T14:15:22Z",
- "maxSkill": 0,
- "minSkill": 0,
- "noOfPlayers": 0,
- "open": true,
- "organizerId": "string",
- "paused": true,
- "queueAlgorithm": {
- "algorithmId": "string",
- "algorithmInput": [
- "string"
], - "algorithmParameters": {
- "band": {
- "value": 0
}
}, - "geoDescription": {
- "en": "string",
- "fr": "string"
}, - "geoLabel": {
- "en": "string",
- "fr": "string"
}, - "id": "string",
- "roleBasedCaptainPick": true
}, - "queueName": "string",
- "region": "string",
- "state": "string",
- "verifiedMatching": true
}
Retrieve queue bans on FACEIT
Retrieve queue bans on FACEIT. Available only for game or queue owners(organizers)
Authorizations:
path Parameters
game_id required | string Example: eu The id of the game |
queue_id required | string The id of the queue |
query Parameters
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "banEnd": "2019-08-24T14:15:22Z",
- "banId": "string",
- "banStart": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "entityId": "string",
- "entityType": "string",
- "expired": true,
- "lastModified": "2019-08-24T14:15:22Z",
- "nickname": "string",
- "organizerId": "string",
- "queueId": "string",
- "reason": "string",
- "type": "string",
- "userId": "string",
- "version": 0
}
], - "start": 0
}
Retrieve queues by region on FACEIT
Retrieve queues by region on FACEIT. Available only for game developers
Authorizations:
path Parameters
game_id required | string Example: csgo The id of the game |
region_id required | string Example: eu The id of the region |
query Parameters
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 20 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "entityId": "string",
- "entityType": "string",
- "game": "string",
- "id": "string",
- "lastModified": "2019-08-24T14:15:22Z",
- "open": true,
- "organizerId": "string",
- "queueName": "string",
- "region": "string",
- "state": "string"
}
], - "start": 0
}
Retrieve hub details
Retrieve hub details
Authorizations:
path Parameters
hub_id required | string The id of the hub |
query Parameters
expanded | Array of strings unique Items Enum: "organizer" "game" List of entity names to expand in request |
Responses
Response samples
- 200
{- "avatar": "string",
- "background_image": "string",
- "chat_room_id": "string",
- "cover_image": "string",
- "description": "string",
- "faceit_url": "string",
- "game_data": {
- "assets": {
- "cover": "string",
- "featured_img_l": "string",
- "featured_img_m": "string",
- "featured_img_s": "string",
- "flag_img_icon": "string",
- "flag_img_l": "string",
- "flag_img_m": "string",
- "flag_img_s": "string",
- "landing_page": "string"
}, - "game_id": "string",
- "long_label": "string",
- "order": 0,
- "parent_game_id": "string",
- "platforms": [
- "string"
], - "regions": [
- "string"
], - "short_label": "string"
}, - "game_id": "string",
- "hub_id": "string",
- "join_permission": "string",
- "max_skill_level": 0,
- "min_skill_level": 0,
- "name": "string",
- "organizer_data": {
- "avatar": "string",
- "cover": "string",
- "description": "string",
- "facebook": "string",
- "faceit_url": "string",
- "followers_count": 0,
- "name": "string",
- "organizer_id": "string",
- "twitch": "string",
- "twitter": "string",
- "type": "string",
- "vk": "string",
- "website": "string",
- "youtube": "string"
}, - "organizer_id": "string",
- "players_joined": 0,
- "region": "string",
- "rule_id": "string"
}
Retrieve all matches of a hub
Retrieve all matches of a hub
Authorizations:
path Parameters
hub_id required | string The id of the hub |
query Parameters
type | string Enum: "all" "upcoming" "ongoing" "past" Kind of matches to return. Can be all(default), upcoming, ongoing or past |
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "best_of": 0,
- "broadcast_start_time": 0,
- "broadcast_start_time_label": "string",
- "calculate_elo": true,
- "chat_room_id": "string",
- "competition_id": "string",
- "competition_name": "string",
- "competition_type": "string",
- "configured_at": 0,
- "demo_url": [
- "string"
], - "detailed_results": [
- {
- "asc_score": true,
- "factions": {
- "property1": {
- "score": 2
}, - "property2": {
- "score": 2
}
}, - "winner": "string"
}
], - "faceit_url": "string",
- "finished_at": 0,
- "game": "string",
- "group": 0,
- "match_id": "string",
- "organizer_id": "string",
- "region": "string",
- "results": {
- "score": {
- "property1": 0,
- "property2": 0
}, - "winner": "string"
}, - "round": 0,
- "scheduled_at": 0,
- "started_at": 0,
- "status": "string",
- "teams": {
- "property1": {
- "avatar": "string",
- "faction_id": "string",
- "leader": "string",
- "name": "string",
- "roster": [
- {
- "anticheat_required": true,
- "avatar": "string",
- "game_player_id": "string",
- "game_player_name": "string",
- "game_skill_level": 0,
- "membership": "string",
- "nickname": "string",
- "player_id": "string"
}
], - "roster_v1": null,
- "stats": {
- "rating": 0,
- "skillLevel": {
- "average": 0,
- "range": {
- "max": 0,
- "min": 0
}
}, - "winProbability": 0
}, - "substituted": true,
- "type": "string"
}, - "property2": {
- "avatar": "string",
- "faction_id": "string",
- "leader": "string",
- "name": "string",
- "roster": [
- {
- "anticheat_required": true,
- "avatar": "string",
- "game_player_id": "string",
- "game_player_name": "string",
- "game_skill_level": 0,
- "membership": "string",
- "nickname": "string",
- "player_id": "string"
}
], - "roster_v1": null,
- "stats": {
- "rating": 0,
- "skillLevel": {
- "average": 0,
- "range": {
- "max": 0,
- "min": 0
}
}, - "winProbability": 0
}, - "substituted": true,
- "type": "string"
}
}, - "version": 0,
- "voting": null
}
], - "start": 0
}
Retrieve all members of a hub
Retrieve all members of a hub
Authorizations:
path Parameters
hub_id required | string The id of the hub |
query Parameters
offset | integer [ 0 .. 1000 ] Default: 0 The starting item position |
limit | integer [ 1 .. 50 ] Default: 50 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "avatar": "string",
- "faceit_url": "string",
- "nickname": "string",
- "roles": [
- "string"
], - "user_id": "string"
}
], - "start": 0
}
Retrieve all roles members can have in a hub
Retrieve all roles members can have in a hub
Authorizations:
path Parameters
hub_id required | string The id of the hub |
query Parameters
offset | integer [ 0 .. 1000 ] Default: 0 The starting item position |
limit | integer [ 1 .. 50 ] Default: 50 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "color": "string",
- "name": "string",
- "ranking": 0,
- "role_id": "string",
- "visible_on_chat": true
}
], - "start": 0
}
Retrieve statistics of a hub
Retrieve statistics of a hub
Authorizations:
path Parameters
hub_id required | string The id of the hub |
query Parameters
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "game_id": "string",
- "players": [
- {
- "nickname": "string",
- "player_id": "string",
- "stats": {
- "property1": null,
- "property2": null
}
}
]
}
Retrieve all leaderboards of a championship
Retrieve all leaderboards of a championship
Authorizations:
path Parameters
championship_id required | string The id of the championship |
query Parameters
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "competition_id": "string",
- "competition_type": "string",
- "end_date": 0,
- "game_id": "string",
- "group": 0,
- "leaderboard_id": "string",
- "leaderboard_mode": "string",
- "leaderboard_name": "string",
- "leaderboard_type": "string",
- "min_matches": 0,
- "points_per_draw": 0,
- "points_per_loss": 0,
- "points_per_win": 0,
- "points_type": "string",
- "ranking_boost": 0,
- "ranking_type": "string",
- "region": "string",
- "round": 0,
- "season": 0,
- "start_date": 0,
- "starting_points": 0,
- "status": "string"
}
], - "start": 0
}
Retrieve group ranking of a championship
Retrieve group ranking of a championship
Authorizations:
path Parameters
championship_id required | string The id of the championship |
group required | integer A group of the championship |
query Parameters
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "current_streak": 0,
- "draw": 0,
- "lost": 0,
- "played": 0,
- "player": {
- "country": "GB",
- "faceit_url": "string",
- "membership_type": "string",
- "memberships": [
- "free",
- "unlimited"
], - "nickname": "nickname",
- "skill_level": 1,
- "user_id": "6204037c-30e6-408b-8aaa-dd8219860b4b"
}, - "points": 0,
- "position": 0,
- "win_rate": 0,
- "won": 0
}
], - "leaderboard": {
- "competition_id": "string",
- "competition_type": "string",
- "end_date": 0,
- "game_id": "string",
- "group": 0,
- "leaderboard_id": "string",
- "leaderboard_mode": "string",
- "leaderboard_name": "string",
- "leaderboard_type": "string",
- "min_matches": 0,
- "points_per_draw": 0,
- "points_per_loss": 0,
- "points_per_win": 0,
- "points_type": "string",
- "ranking_boost": 0,
- "ranking_type": "string",
- "region": "string",
- "round": 0,
- "season": 0,
- "start_date": 0,
- "starting_points": 0,
- "status": "string"
}, - "start": 0
}
Retrieve all leaderboards of a hub
Retrieve all leaderboards of a hub
Authorizations:
path Parameters
hub_id required | string The id of the hub |
query Parameters
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "competition_id": "string",
- "competition_type": "string",
- "end_date": 0,
- "game_id": "string",
- "group": 0,
- "leaderboard_id": "string",
- "leaderboard_mode": "string",
- "leaderboard_name": "string",
- "leaderboard_type": "string",
- "min_matches": 0,
- "points_per_draw": 0,
- "points_per_loss": 0,
- "points_per_win": 0,
- "points_type": "string",
- "ranking_boost": 0,
- "ranking_type": "string",
- "region": "string",
- "round": 0,
- "season": 0,
- "start_date": 0,
- "starting_points": 0,
- "status": "string"
}
], - "start": 0
}
Retrieve all time ranking of a hub
Retrieve all time ranking of a hub
Authorizations:
path Parameters
hub_id required | string The id of the hub |
query Parameters
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "current_streak": 0,
- "draw": 0,
- "lost": 0,
- "played": 0,
- "player": {
- "country": "GB",
- "faceit_url": "string",
- "membership_type": "string",
- "memberships": [
- "free",
- "unlimited"
], - "nickname": "nickname",
- "skill_level": 1,
- "user_id": "6204037c-30e6-408b-8aaa-dd8219860b4b"
}, - "points": 0,
- "position": 0,
- "win_rate": 0,
- "won": 0
}
], - "leaderboard": {
- "competition_id": "string",
- "competition_type": "string",
- "end_date": 0,
- "game_id": "string",
- "group": 0,
- "leaderboard_id": "string",
- "leaderboard_mode": "string",
- "leaderboard_name": "string",
- "leaderboard_type": "string",
- "min_matches": 0,
- "points_per_draw": 0,
- "points_per_loss": 0,
- "points_per_win": 0,
- "points_type": "string",
- "ranking_boost": 0,
- "ranking_type": "string",
- "region": "string",
- "round": 0,
- "season": 0,
- "start_date": 0,
- "starting_points": 0,
- "status": "string"
}, - "start": 0
}
Retrieve seasonal ranking of a hub
Retrieve seasonal ranking of a hub
Authorizations:
path Parameters
hub_id required | string The id of the hub |
season required | integer A season of the hub |
query Parameters
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "current_streak": 0,
- "draw": 0,
- "lost": 0,
- "played": 0,
- "player": {
- "country": "GB",
- "faceit_url": "string",
- "membership_type": "string",
- "memberships": [
- "free",
- "unlimited"
], - "nickname": "nickname",
- "skill_level": 1,
- "user_id": "6204037c-30e6-408b-8aaa-dd8219860b4b"
}, - "points": 0,
- "position": 0,
- "win_rate": 0,
- "won": 0
}
], - "leaderboard": {
- "competition_id": "string",
- "competition_type": "string",
- "end_date": 0,
- "game_id": "string",
- "group": 0,
- "leaderboard_id": "string",
- "leaderboard_mode": "string",
- "leaderboard_name": "string",
- "leaderboard_type": "string",
- "min_matches": 0,
- "points_per_draw": 0,
- "points_per_loss": 0,
- "points_per_win": 0,
- "points_type": "string",
- "ranking_boost": 0,
- "ranking_type": "string",
- "region": "string",
- "round": 0,
- "season": 0,
- "start_date": 0,
- "starting_points": 0,
- "status": "string"
}, - "start": 0
}
Retrieve ranking from a leaderboard id
Retrieve ranking from a leaderboard id
Authorizations:
path Parameters
leaderboard_id required | string The id of the leaderboard |
query Parameters
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "current_streak": 0,
- "draw": 0,
- "lost": 0,
- "played": 0,
- "player": {
- "country": "GB",
- "faceit_url": "string",
- "membership_type": "string",
- "memberships": [
- "free",
- "unlimited"
], - "nickname": "nickname",
- "skill_level": 1,
- "user_id": "6204037c-30e6-408b-8aaa-dd8219860b4b"
}, - "points": 0,
- "position": 0,
- "win_rate": 0,
- "won": 0
}
], - "leaderboard": {
- "competition_id": "string",
- "competition_type": "string",
- "end_date": 0,
- "game_id": "string",
- "group": 0,
- "leaderboard_id": "string",
- "leaderboard_mode": "string",
- "leaderboard_name": "string",
- "leaderboard_type": "string",
- "min_matches": 0,
- "points_per_draw": 0,
- "points_per_loss": 0,
- "points_per_win": 0,
- "points_type": "string",
- "ranking_boost": 0,
- "ranking_type": "string",
- "region": "string",
- "round": 0,
- "season": 0,
- "start_date": 0,
- "starting_points": 0,
- "status": "string"
}, - "start": 0
}
Retrieve a players ranking in a leaderboard
Retrieve a players ranking in a leaderboard
Authorizations:
path Parameters
leaderboard_id required | string The id of the leaderboard |
player_id required | string The id of the player |
Responses
Response samples
- 200
{- "current_streak": 0,
- "draw": 0,
- "lost": 0,
- "played": 0,
- "player": {
- "country": "GB",
- "faceit_url": "string",
- "membership_type": "string",
- "memberships": [
- "free",
- "unlimited"
], - "nickname": "nickname",
- "skill_level": 1,
- "user_id": "6204037c-30e6-408b-8aaa-dd8219860b4b"
}, - "points": 0,
- "position": 0,
- "win_rate": 0,
- "won": 0
}
Retrieve details of a league of a matchmaking on FACEIT
Retrieve details of a league of a matchmaking on FACEIT
Authorizations:
path Parameters
league_id required | string The id of the league |
Responses
Response samples
- 200
{- "divisions": [
- {
- "assets": {
- "color": "string",
- "icon": "string",
- "image": "string"
}, - "config_type": "string",
- "leaderboard_config": {
- "max_players": 0,
- "points_per_loss": -2,
- "points_per_win": 10,
- "promotion": {
- "points": 10
}, - "relegation": {
- "consecutive_losses": 3
}, - "starting_points": 0
}, - "leaderboards": [
- "string"
], - "max_elo": 0,
- "min_elo": 0,
- "name": "string",
- "tiers": [
- {
- "name": "string",
- "points_target": 0,
- "rank": 1
}
], - "type": "string"
}
], - "game": "string",
- "id": "string",
- "min_matches": 0,
- "region": "string",
- "season": {
- "end_date": "2019-08-24T14:15:22Z",
- "number": 0,
- "placement_match_count": 0,
- "start_date": "2019-08-24T14:15:22Z"
}
}
Retrieve details of a season of a league on FACEIT
Retrieve details of a season of a league on FACEIT
Authorizations:
path Parameters
league_id required | string Example: 6e7daaee-8b9d-4fbf-86c4-361fa7e579fc The id of the league |
season_id required | integer Example: 1 The id of the season |
Responses
Response samples
- 200
{- "divisions": [
- {
- "assets": {
- "color": "string",
- "icon": "string",
- "image": "string"
}, - "config_type": "string",
- "leaderboard_config": {
- "max_players": 0,
- "points_per_loss": -2,
- "points_per_win": 10,
- "promotion": {
- "points": 10
}, - "relegation": {
- "consecutive_losses": 3
}, - "starting_points": 0
}, - "leaderboards": [
- "string"
], - "max_elo": 0,
- "min_elo": 0,
- "name": "string",
- "tiers": [
- {
- "name": "string",
- "points_target": 0,
- "rank": 1
}
], - "type": "string"
}
], - "season": {
- "end_date": "2019-08-24T14:15:22Z",
- "number": 0,
- "placement_match_count": 0,
- "start_date": "2019-08-24T14:15:22Z"
}
}
Retrieve details of a player for a given league and season on FACEIT
Retrieve details of a player for a given league and season on FACEIT
Authorizations:
path Parameters
league_id required | string Example: 6e7daaee-8b9d-4fbf-86c4-361fa7e579fc The id of the league |
season_id required | integer Example: 1 The id of the season |
player_id required | string Example: 6e7daaee-8b9d-4fbf-86c4-361fa7e579fc The id of the player |
Responses
Response samples
- 200
{- "division_name": "string",
- "division_tier": "string",
- "division_type": "string",
- "leaderboard_id": "string",
- "points": 0,
- "position": 0
}
Retrieve match details
Retrieve match details
Authorizations:
path Parameters
match_id required | string The id of the match |
Responses
Response samples
- 200
{- "best_of": 0,
- "broadcast_start_time": 0,
- "broadcast_start_time_label": "string",
- "calculate_elo": true,
- "chat_room_id": "string",
- "competition_id": "string",
- "competition_name": "string",
- "competition_type": "string",
- "configured_at": 0,
- "demo_url": [
- "string"
], - "detailed_results": [
- {
- "asc_score": true,
- "factions": {
- "property1": {
- "score": 2
}, - "property2": {
- "score": 2
}
}, - "winner": "string"
}
], - "faceit_url": "string",
- "finished_at": 0,
- "game": "string",
- "group": 0,
- "match_id": "string",
- "organizer_id": "string",
- "region": "string",
- "results": {
- "score": {
- "property1": 0,
- "property2": 0
}, - "winner": "string"
}, - "round": 0,
- "scheduled_at": 0,
- "started_at": 0,
- "status": "string",
- "teams": {
- "property1": {
- "avatar": "string",
- "faction_id": "string",
- "leader": "string",
- "name": "string",
- "roster": [
- {
- "anticheat_required": true,
- "avatar": "string",
- "game_player_id": "string",
- "game_player_name": "string",
- "game_skill_level": 0,
- "membership": "string",
- "nickname": "string",
- "player_id": "string"
}
], - "roster_v1": null,
- "stats": {
- "rating": 0,
- "skillLevel": {
- "average": 0,
- "range": {
- "max": 0,
- "min": 0
}
}, - "winProbability": 0
}, - "substituted": true,
- "type": "string"
}, - "property2": {
- "avatar": "string",
- "faction_id": "string",
- "leader": "string",
- "name": "string",
- "roster": [
- {
- "anticheat_required": true,
- "avatar": "string",
- "game_player_id": "string",
- "game_player_name": "string",
- "game_skill_level": 0,
- "membership": "string",
- "nickname": "string",
- "player_id": "string"
}
], - "roster_v1": null,
- "stats": {
- "rating": 0,
- "skillLevel": {
- "average": 0,
- "range": {
- "max": 0,
- "min": 0
}
}, - "winProbability": 0
}, - "substituted": true,
- "type": "string"
}
}, - "version": 0,
- "voting": null
}
Retrieve statistics of a match
Retrieve statistics of a match
Authorizations:
path Parameters
match_id required | string The id of the match |
Responses
Response samples
- 200
{- "rounds": [
- {
- "best_of": null,
- "competition_id": null,
- "game_id": null,
- "game_mode": null,
- "match_id": null,
- "match_round": null,
- "played": null,
- "round_stats": {
- "property1": null,
- "property2": null
}, - "teams": [
- {
- "players": [
- {
- "nickname": null,
- "player_id": null,
- "player_stats": {
- "property1": null,
- "property2": null
}
}
], - "premade": null,
- "team_id": null,
- "team_stats": {
- "property1": null,
- "property2": null
}
}
]
}
]
}
Retrieve details of a matchmaking of a game on FACEIT
Retrieve details of a matchmaking of a game on FACEIT
Authorizations:
path Parameters
matchmaking_id required | string The id of the matchmaking |
Responses
Response samples
- 200
{- "game": "string",
- "icon": "string",
- "id": "string",
- "league_id": "string",
- "long_description": "string",
- "name": "string",
- "queues": [
- {
- "id": "string",
- "name": "string",
- "open": true,
- "organizer_id": "string",
- "paused": true
}
], - "region": "string",
- "short_description": "string"
}
Retrieve organizer details from name
Retrieve organizer details from name
Authorizations:
query Parameters
name required | string The name of the organizer |
Responses
Response samples
- 200
{- "avatar": "string",
- "cover": "string",
- "description": "string",
- "facebook": "string",
- "faceit_url": "string",
- "followers_count": 0,
- "name": "string",
- "organizer_id": "string",
- "twitch": "string",
- "twitter": "string",
- "type": "string",
- "vk": "string",
- "website": "string",
- "youtube": "string"
}
Retrieve organizer details
Retrieve organizer details
Authorizations:
path Parameters
organizer_id required | string The id of the organizer |
Responses
Response samples
- 200
{- "avatar": "string",
- "cover": "string",
- "description": "string",
- "facebook": "string",
- "faceit_url": "string",
- "followers_count": 0,
- "name": "string",
- "organizer_id": "string",
- "twitch": "string",
- "twitter": "string",
- "type": "string",
- "vk": "string",
- "website": "string",
- "youtube": "string"
}
Retrieve all championships of an organizer
Retrieve all championships of an organizer
Authorizations:
path Parameters
organizer_id required | string The id of the organizer |
query Parameters
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "anticheat_required": true,
- "avatar": "string",
- "background_image": "string",
- "championship_id": "string",
- "championship_start": 0,
- "checkin_clear": 0,
- "checkin_enabled": true,
- "checkin_start": 0,
- "cover_image": "string",
- "current_subscriptions": 0,
- "description": "string",
- "faceit_url": "string",
- "featured": true,
- "full": true,
- "game_data": {
- "assets": {
- "cover": "string",
- "featured_img_l": "string",
- "featured_img_m": "string",
- "featured_img_s": "string",
- "flag_img_icon": "string",
- "flag_img_l": "string",
- "flag_img_m": "string",
- "flag_img_s": "string",
- "landing_page": "string"
}, - "game_id": "string",
- "long_label": "string",
- "order": 0,
- "parent_game_id": "string",
- "platforms": [
- "string"
], - "regions": [
- "string"
], - "short_label": "string"
}, - "game_id": "string",
- "id": "string",
- "join_checks": {
- "allowed_team_types": [
- "string"
], - "blacklist_geo_countries": [
- "string"
], - "join_policy": "string",
- "max_skill_level": 0,
- "membership_type": "string",
- "min_skill_level": 0,
- "whitelist_geo_countries": [
- "string"
], - "whitelist_geo_countries_min_players": 0
}, - "name": "string",
- "organizer_data": {
- "avatar": "string",
- "cover": "string",
- "description": "string",
- "facebook": "string",
- "faceit_url": "string",
- "followers_count": 0,
- "name": "string",
- "organizer_id": "string",
- "twitch": "string",
- "twitter": "string",
- "type": "string",
- "vk": "string",
- "website": "string",
- "youtube": "string"
}, - "organizer_id": "string",
- "prizes": [
- {
- "faceit_points": 0,
- "rank": 0
}
], - "region": "string",
- "rules_id": "string",
- "schedule": {
- "property1": {
- "date": 0,
- "status": "string"
}, - "property2": {
- "date": 0,
- "status": "string"
}
}, - "screening": {
- "enabled": true,
- "id": "string"
}, - "seeding_strategy": "string",
- "slots": 0,
- "status": "string",
- "stream": {
- "active": true,
- "platform": "string",
- "source": "string",
- "title": "string"
}, - "subscription_end": 0,
- "subscription_start": 0,
- "subscriptions_locked": true,
- "substitution_configuration": {
- "max_substitutes": 0,
- "max_substitutions": 0
}, - "total_groups": 0,
- "total_prizes": 0,
- "total_rounds": 0,
- "type": "string"
}
], - "start": 0
}
Retrieve all games an organizer is involved with
Retrieve all games an organizer is involved with
Authorizations:
path Parameters
organizer_id required | string The id of the organizer |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "assets": {
- "cover": "string",
- "featured_img_l": "string",
- "featured_img_m": "string",
- "featured_img_s": "string",
- "flag_img_icon": "string",
- "flag_img_l": "string",
- "flag_img_m": "string",
- "flag_img_s": "string",
- "landing_page": "string"
}, - "game_id": "string",
- "long_label": "string",
- "order": 0,
- "parent_game_id": "string",
- "platforms": [
- "string"
], - "regions": [
- "string"
], - "short_label": "string"
}
], - "start": 0
}
Retrieve all hubs of an organizer
Retrieve all hubs of an organizer
Authorizations:
path Parameters
organizer_id required | string The id of the organizer |
query Parameters
offset | integer [ 0 .. 1000 ] Default: 0 The starting item position |
limit | integer [ 1 .. 50 ] Default: 50 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "avatar": "string",
- "background_image": "string",
- "chat_room_id": "string",
- "cover_image": "string",
- "description": "string",
- "faceit_url": "string",
- "game_data": {
- "assets": {
- "cover": "string",
- "featured_img_l": "string",
- "featured_img_m": "string",
- "featured_img_s": "string",
- "flag_img_icon": "string",
- "flag_img_l": "string",
- "flag_img_m": "string",
- "flag_img_s": "string",
- "landing_page": "string"
}, - "game_id": "string",
- "long_label": "string",
- "order": 0,
- "parent_game_id": "string",
- "platforms": [
- "string"
], - "regions": [
- "string"
], - "short_label": "string"
}, - "game_id": "string",
- "hub_id": "string",
- "join_permission": "string",
- "max_skill_level": 0,
- "min_skill_level": 0,
- "name": "string",
- "organizer_data": {
- "avatar": "string",
- "cover": "string",
- "description": "string",
- "facebook": "string",
- "faceit_url": "string",
- "followers_count": 0,
- "name": "string",
- "organizer_id": "string",
- "twitch": "string",
- "twitter": "string",
- "type": "string",
- "vk": "string",
- "website": "string",
- "youtube": "string"
}, - "organizer_id": "string",
- "players_joined": 0,
- "region": "string",
- "rule_id": "string"
}
], - "start": 0
}
Retrieve all tournaments of an organizer
Retrieve all tournaments of an organizer
Authorizations:
path Parameters
organizer_id required | string The id of the organizer |
query Parameters
type | string Enum: "past" "upcoming" Kind of tournament. Can be upcoming(default) or past |
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "anticheat_required": true,
- "custom": true,
- "faceit_url": "string",
- "featured_image": "string",
- "game_id": "string",
- "invite_type": "string",
- "match_type": "string",
- "max_skill": 0,
- "membership_type": "string",
- "min_skill": 0,
- "name": "string",
- "number_of_players": 0,
- "number_of_players_checkedin": 0,
- "number_of_players_joined": 0,
- "number_of_players_participants": 0,
- "organizer_id": "string",
- "prize_type": "string",
- "region": "string",
- "started_at": 0,
- "status": "string",
- "subscriptions_count": 0,
- "team_size": 0,
- "total_prize": null,
- "tournament_id": "string",
- "whitelist_countries": [
- "string"
]
}
], - "start": 0
}
Retrieve player details
Retrieve player details
Authorizations:
query Parameters
nickname | string The nickname of the player on FACEIT |
game | string A game on FACEIT |
game_player_id | string The ID of a player on game's platform |
Responses
Response samples
- 200
{- "activated_at": "2019-08-24T14:15:22Z",
- "avatar": "string",
- "country": "string",
- "cover_featured_image": "string",
- "cover_image": "string",
- "faceit_url": "string",
- "friends_ids": [
- "string"
], - "games": {
- "property1": {
- "faceit_elo": 0,
- "game_player_id": "string",
- "game_player_name": "string",
- "game_profile_id": "string",
- "region": "string",
- "regions": null,
- "skill_level": 0,
- "skill_level_label": "string"
}, - "property2": {
- "faceit_elo": 0,
- "game_player_id": "string",
- "game_player_name": "string",
- "game_profile_id": "string",
- "region": "string",
- "regions": null,
- "skill_level": 0,
- "skill_level_label": "string"
}
}, - "infractions": null,
- "membership_type": "string",
- "memberships": [
- "string"
], - "new_steam_id": "string",
- "nickname": "string",
- "platforms": {
- "property1": "string",
- "property2": "string"
}, - "player_id": "string",
- "settings": {
- "language": "string"
}, - "steam_id_64": "string",
- "steam_nickname": "string",
- "verified": true
}
Retrieve player details
Retrieve player details
Authorizations:
path Parameters
player_id required | string The id of the player |
Responses
Response samples
- 200
{- "activated_at": "2019-08-24T14:15:22Z",
- "avatar": "string",
- "country": "string",
- "cover_featured_image": "string",
- "cover_image": "string",
- "faceit_url": "string",
- "friends_ids": [
- "string"
], - "games": {
- "property1": {
- "faceit_elo": 0,
- "game_player_id": "string",
- "game_player_name": "string",
- "game_profile_id": "string",
- "region": "string",
- "regions": null,
- "skill_level": 0,
- "skill_level_label": "string"
}, - "property2": {
- "faceit_elo": 0,
- "game_player_id": "string",
- "game_player_name": "string",
- "game_profile_id": "string",
- "region": "string",
- "regions": null,
- "skill_level": 0,
- "skill_level_label": "string"
}
}, - "infractions": null,
- "membership_type": "string",
- "memberships": [
- "string"
], - "new_steam_id": "string",
- "nickname": "string",
- "platforms": {
- "property1": "string",
- "property2": "string"
}, - "player_id": "string",
- "settings": {
- "language": "string"
}, - "steam_id_64": "string",
- "steam_nickname": "string",
- "verified": true
}
Retrieve all bans of a player
Retrieve all bans of a player
Authorizations:
path Parameters
player_id required | string The id of the player |
query Parameters
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "ends_at": "2019-08-24T14:15:22Z",
- "game": "string",
- "nickname": "string",
- "reason": "string",
- "starts_at": "2019-08-24T14:15:22Z",
- "type": "string",
- "user_id": "string"
}
], - "start": 0
}
Retrieve statistics of a player for a given amount of matches
Retrieve statistics of a player for a given amount of matches
Authorizations:
path Parameters
player_id required | string The id of the player |
game_id required | string Example: csgo A game on FACEIT |
query Parameters
offset | integer [ 0 .. 200 ] Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
from | integer Used to filter the dataset by date (minimum). Expected value is date ("items.stats.Match Finished At") in epoch milliseconds. |
to | integer Used to filter the dataset by date (maximum). Expected value is date ("items.stats.Match Finished At") in epoch milliseconds. |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "stats": {
- "property1": null,
- "property2": null
}
}
], - "start": 0
}
Retrieve all matches of a player
Retrieve all matches of a player
Authorizations:
path Parameters
player_id required | string The id of the player |
query Parameters
game required | string A game on FACEIT |
from | integer >= 0 The timestamp (Unix time) as lower bound of the query. 1 month ago if not specified |
to | integer >= 0 The timestamp (Unix time) as higher bound of the query. Current timestamp if not specified |
offset | integer [ 0 .. 1000 ] Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "from": 0,
- "items": [
- {
- "competition_id": "string",
- "competition_name": "string",
- "competition_type": "string",
- "faceit_url": "string",
- "finished_at": 0,
- "game_id": "string",
- "game_mode": "string",
- "match_id": "string",
- "match_type": "string",
- "max_players": 0,
- "organizer_id": "string",
- "playing_players": [
- "string"
], - "region": "string",
- "results": {
- "score": {
- "property1": 0,
- "property2": 0
}, - "winner": "string"
}, - "started_at": 0,
- "status": "string",
- "teams": {
- "property1": {
- "avatar": "string",
- "nickname": "string",
- "players": [
- {
- "avatar": "string",
- "faceit_url": "string",
- "game_player_id": "string",
- "game_player_name": "string",
- "nickname": "string",
- "player_id": "string",
- "skill_level": 0
}
], - "team_id": "string",
- "type": "string"
}, - "property2": {
- "avatar": "string",
- "nickname": "string",
- "players": [
- {
- "avatar": "string",
- "faceit_url": "string",
- "game_player_id": "string",
- "game_player_name": "string",
- "nickname": "string",
- "player_id": "string",
- "skill_level": 0
}
], - "team_id": "string",
- "type": "string"
}
}, - "teams_size": 0
}
], - "start": 0,
- "to": 0
}
Retrieve all hubs of a player
Retrieve all hubs of a player
Authorizations:
path Parameters
player_id required | string The id of the player |
query Parameters
offset | integer [ 0 .. 1000 ] Default: 0 The starting item position |
limit | integer [ 1 .. 50 ] Default: 50 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "avatar": "string",
- "background_image": "string",
- "chat_room_id": "string",
- "cover_image": "string",
- "description": "string",
- "faceit_url": "string",
- "game_data": {
- "assets": {
- "cover": "string",
- "featured_img_l": "string",
- "featured_img_m": "string",
- "featured_img_s": "string",
- "flag_img_icon": "string",
- "flag_img_l": "string",
- "flag_img_m": "string",
- "flag_img_s": "string",
- "landing_page": "string"
}, - "game_id": "string",
- "long_label": "string",
- "order": 0,
- "parent_game_id": "string",
- "platforms": [
- "string"
], - "regions": [
- "string"
], - "short_label": "string"
}, - "game_id": "string",
- "hub_id": "string",
- "join_permission": "string",
- "max_skill_level": 0,
- "min_skill_level": 0,
- "name": "string",
- "organizer_data": {
- "avatar": "string",
- "cover": "string",
- "description": "string",
- "facebook": "string",
- "faceit_url": "string",
- "followers_count": 0,
- "name": "string",
- "organizer_id": "string",
- "twitch": "string",
- "twitter": "string",
- "type": "string",
- "vk": "string",
- "website": "string",
- "youtube": "string"
}, - "organizer_id": "string",
- "players_joined": 0,
- "region": "string",
- "rule_id": "string"
}
], - "start": 0
}
Retrieve statistics of a player
Retrieve statistics of a player
Authorizations:
path Parameters
player_id required | string The id of the player |
game_id required | string A game on FACEIT |
Responses
Response samples
- 200
{- "game_id": "string",
- "lifetime": {
- "property1": null,
- "property2": null
}, - "player_id": "string",
- "segments": [
- {
- "property1": null,
- "property2": null
}
]
}
Retrieve all teams of a player
Retrieve all teams of a player
Authorizations:
path Parameters
player_id required | string The id of the player |
query Parameters
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "chat_room_id": "team-6204037c-30e6-408b-8aaa-dd8219860b4b",
- "description": "Some description",
- "game": "csgo",
- "leader": "leader",
- "members": [
- {
- "country": "GB",
- "faceit_url": "string",
- "membership_type": "string",
- "memberships": [
- "free",
- "unlimited"
], - "nickname": "nickname",
- "skill_level": 1,
- "user_id": "6204037c-30e6-408b-8aaa-dd8219860b4b"
}
], - "name": "name",
- "nickname": "nickname",
- "team_id": "6204037c-30e6-408b-8aaa-dd8219860b4b",
- "team_type": "premade",
}
], - "start": 0
}
Retrieve all tournaments of a player
Retrieve all tournaments of a player
Authorizations:
path Parameters
player_id required | string The id of the player |
query Parameters
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "anticheat_required": true,
- "custom": true,
- "faceit_url": "string",
- "featured_image": "string",
- "game_id": "string",
- "invite_type": "string",
- "match_type": "string",
- "max_skill": 0,
- "membership_type": "string",
- "min_skill": 0,
- "name": "string",
- "number_of_players": 0,
- "number_of_players_checkedin": 0,
- "number_of_players_joined": 0,
- "number_of_players_participants": 0,
- "organizer_id": "string",
- "prize_type": "string",
- "region": "string",
- "started_at": 0,
- "status": "string",
- "subscriptions_count": 0,
- "team_size": 0,
- "total_prize": null,
- "tournament_id": "string",
- "whitelist_countries": [
- "string"
]
}
], - "start": 0
}
Retrieve global ranking of a game
Retrieve global ranking of a game
Authorizations:
path Parameters
game_id required | string The id of the game |
region required | string A region of a game |
query Parameters
country | string A country code (ISO 3166-1) |
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "country": "string",
- "faceit_elo": 0,
- "game_skill_level": 0,
- "nickname": "string",
- "player_id": "string",
- "position": 0
}
], - "start": 0
}
Retrieve user position in the global ranking of a game
Retrieve user position in the global ranking of a game
Authorizations:
path Parameters
game_id required | string The id of the game |
region required | string A region of a game |
player_id required | string The id of a player |
query Parameters
country | string A country code (ISO 3166-1) |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "country": "string",
- "faceit_elo": 0,
- "game_skill_level": 0,
- "nickname": "string",
- "player_id": "string",
- "position": 0
}
], - "position": 0,
- "start": 0
}
Search for championships
Search for championships
Authorizations:
query Parameters
name required | string The name of a championship on FACEIT |
game | string A game on FACEIT |
region | string A region of the game |
type | string Enum: "all" "upcoming" "ongoing" "past" Kind of competitions to return |
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "competition_id": "string",
- "competition_type": "string",
- "game": "string",
- "name": "string",
- "number_of_members": 0,
- "organizer_id": "string",
- "organizer_name": "string",
- "organizer_type": "string",
- "players_checkedin": 0,
- "players_joined": 0,
- "prize_type": "string",
- "region": "string",
- "slots": 0,
- "started_at": 0,
- "status": "string",
- "total_prize": "string"
}
], - "start": 0
}
Search for clans
Search for clans
Authorizations:
query Parameters
name required | string The name of a clan on FACEIT |
game | string A game on FACEIT |
region | string A region of the game |
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "game": "csgo",
- "id": "22479709-2064-4688-80fa-f02e97412345",
- "join": "invite",
- "last_match_finished": "2019-08-24T14:15:22Z",
- "matches_count_24h": 3,
- "max_skill_level": 10,
- "members_count": 72300,
- "members_count_24h": 1,
- "min_skill_level": 1,
- "name": "Example Clan",
- "organizer_id": "f80900c9-88ef-43b4-aa97-d61ea3712345",
- "region": "eu",
- "type": "community"
}
], - "start": 0
}
Search for hubs
Search for hubs
Authorizations:
query Parameters
name required | string The name of a hub on FACEIT |
game | string A game on FACEIT |
region | string A region of the game |
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "competition_id": "string",
- "competition_type": "string",
- "game": "string",
- "name": "string",
- "number_of_members": 0,
- "organizer_id": "string",
- "organizer_name": "string",
- "organizer_type": "string",
- "players_checkedin": 0,
- "players_joined": 0,
- "prize_type": "string",
- "region": "string",
- "slots": 0,
- "started_at": 0,
- "status": "string",
- "total_prize": "string"
}
], - "start": 0
}
Search for organizers
Search for organizers
Authorizations:
query Parameters
name required | string The name of a organizer on FACEIT |
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "active": true,
- "avatar": "string",
- "countries": [
- "string"
], - "games": [
- "string"
], - "name": "string",
- "organizer_id": "string",
- "partner": true,
- "regions": [
- "string"
]
}
], - "start": 0
}
Search for players
Search for players
Authorizations:
query Parameters
nickname required | string The nickname of a player on FACEIT |
game | string A game on FACEIT |
country | string A country code (ISO 3166-1) |
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "avatar": "string",
- "country": "string",
- "games": [
- {
- "name": "string",
- "skill_level": "string"
}
], - "nickname": "string",
- "player_id": "string",
- "status": "string",
- "verified": true
}
], - "start": 0
}
Search for teams
Search for teams
Authorizations:
query Parameters
nickname required | string The nickname of a team on FACEIT |
game | string A game on FACEIT |
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "avatar": "string",
- "chat_room_id": "string",
- "faceit_url": "string",
- "game": "string",
- "name": "string",
- "team_id": "string",
- "verified": true
}
], - "start": 0
}
Search for tournaments
Search for tournaments
Authorizations:
query Parameters
name required | string The name of a tournament on FACEIT |
game | string A game on FACEIT |
region | string A region of the game |
type | string Enum: "all" "upcoming" "ongoing" "past" Kind of competitions to return |
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "competition_id": "string",
- "competition_type": "string",
- "game": "string",
- "name": "string",
- "number_of_members": 0,
- "organizer_id": "string",
- "organizer_name": "string",
- "organizer_type": "string",
- "players_checkedin": 0,
- "players_joined": 0,
- "prize_type": "string",
- "region": "string",
- "slots": 0,
- "started_at": 0,
- "status": "string",
- "total_prize": "string"
}
], - "start": 0
}
Retrieve team details
Retrieve team details
Authorizations:
path Parameters
team_id required | string The id of the team |
Responses
Response samples
- 200
{- "chat_room_id": "team-6204037c-30e6-408b-8aaa-dd8219860b4b",
- "description": "Some description",
- "game": "csgo",
- "leader": "leader",
- "members": [
- {
- "country": "GB",
- "faceit_url": "string",
- "membership_type": "string",
- "memberships": [
- "free",
- "unlimited"
], - "nickname": "nickname",
- "skill_level": 1,
- "user_id": "6204037c-30e6-408b-8aaa-dd8219860b4b"
}
], - "name": "name",
- "nickname": "nickname",
- "team_id": "6204037c-30e6-408b-8aaa-dd8219860b4b",
- "team_type": "premade",
}
Retrieve statistics of a team
Retrieve statistics of a team
Authorizations:
path Parameters
team_id required | string The id of the team |
game_id required | string A game on FACEIT |
Responses
Response samples
- 200
{- "game_id": "string",
- "lifetime": {
- "property1": null,
- "property2": null
}, - "segments": [
- {
- "property1": null,
- "property2": null
}
], - "team_id": "string"
}
Retrieve tournaments of a team
Retrieve tournaments of a team
Authorizations:
path Parameters
team_id required | string The id of the team |
query Parameters
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "anticheat_required": true,
- "custom": true,
- "faceit_url": "string",
- "featured_image": "string",
- "game_id": "string",
- "invite_type": "string",
- "match_type": "string",
- "max_skill": 0,
- "membership_type": "string",
- "min_skill": 0,
- "name": "string",
- "number_of_players": 0,
- "number_of_players_checkedin": 0,
- "number_of_players_joined": 0,
- "number_of_players_participants": 0,
- "organizer_id": "string",
- "prize_type": "string",
- "region": "string",
- "started_at": 0,
- "status": "string",
- "subscriptions_count": 0,
- "team_size": 0,
- "total_prize": null,
- "tournament_id": "string",
- "whitelist_countries": [
- "string"
]
}
], - "start": 0
}
Retrieve tournaments v1 (no longer used)
Retrieve tournaments v1 (no longer used). Please refer to the Championships controller to retrieve tournaments v2
Authorizations:
query Parameters
game | string A game on FACEIT |
region | string A region of the game |
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "anticheat_required": true,
- "custom": true,
- "faceit_url": "string",
- "featured_image": "string",
- "game_id": "string",
- "invite_type": "string",
- "match_type": "string",
- "max_skill": 0,
- "membership_type": "string",
- "min_skill": 0,
- "name": "string",
- "number_of_players": 0,
- "number_of_players_checkedin": 0,
- "number_of_players_joined": 0,
- "number_of_players_participants": 0,
- "organizer_id": "string",
- "prize_type": "string",
- "region": "string",
- "started_at": 0,
- "status": "string",
- "subscriptions_count": 0,
- "team_size": 0,
- "total_prize": null,
- "tournament_id": "string",
- "whitelist_countries": [
- "string"
]
}
], - "start": 0
}
Retrieve tournament details
Retrieve tournament details
Authorizations:
path Parameters
tournament_id required | string The id of the tournament |
query Parameters
expanded | Array of strings unique Items Enum: "organizer" "game" List of entity names to expand in request |
Responses
Response samples
- 200
{- "anticheat_required": true,
- "best_of": null,
- "calculate_elo": true,
- "competition_id": "string",
- "cover_image": "string",
- "custom": true,
- "description": "string",
- "faceit_url": "string",
- "featured_image": "string",
- "game_data": {
- "assets": {
- "cover": "string",
- "featured_img_l": "string",
- "featured_img_m": "string",
- "featured_img_s": "string",
- "flag_img_icon": "string",
- "flag_img_l": "string",
- "flag_img_m": "string",
- "flag_img_s": "string",
- "landing_page": "string"
}, - "game_id": "string",
- "long_label": "string",
- "order": 0,
- "parent_game_id": "string",
- "platforms": [
- "string"
], - "regions": [
- "string"
], - "short_label": "string"
}, - "game_id": "string",
- "invite_type": "string",
- "match_type": "string",
- "max_skill": 0,
- "membership_type": "string",
- "min_skill": 0,
- "name": "string",
- "number_of_players": 0,
- "number_of_players_checkedin": 0,
- "number_of_players_joined": 0,
- "number_of_players_participants": 0,
- "organizer_data": {
- "avatar": "string",
- "cover": "string",
- "description": "string",
- "facebook": "string",
- "faceit_url": "string",
- "followers_count": 0,
- "name": "string",
- "organizer_id": "string",
- "twitch": "string",
- "twitter": "string",
- "type": "string",
- "vk": "string",
- "website": "string",
- "youtube": "string"
}, - "organizer_id": "string",
- "prize_type": "string",
- "region": "string",
- "rounds": [
- null
], - "rule": "string",
- "started_at": 0,
- "status": "string",
- "substitutes_allowed": 0,
- "substitutions_allowed": 0,
- "team_size": 0,
- "total_prize": null,
- "tournament_id": "string",
- "voting": null,
- "whitelist_countries": [
- "string"
]
}
Retrieve brackets of a tournament
Retrieve brackets of a tournament
Authorizations:
path Parameters
tournament_id required | string The id of the tournament |
Responses
Response samples
- 200
{- "game": "string",
- "matches": [
- {
- "faceit_url": "string",
- "match_id": "string",
- "position": 0,
- "results": {
- "score": {
- "property1": 0,
- "property2": 0
}, - "winner": "string"
}, - "round": 0,
- "state": "string",
- "teams": {
- "property1": {
- "avatar": "string",
- "nickname": "string",
- "team_id": "string"
}, - "property2": {
- "avatar": "string",
- "nickname": "string",
- "team_id": "string"
}
}
}
], - "name": "string",
- "rounds": [
- {
- "best_of": 0,
- "label": "string",
- "matches": 0,
- "round": 0,
- "start_time": 0,
- "starts_asap": true,
- "substitution_time": 0,
- "substitutions_allowed": true
}
], - "status": "string"
}
Retrieve all matches of a tournament
Retrieve all matches of a tournament
Authorizations:
path Parameters
tournament_id required | string The id of the tournament |
query Parameters
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "end": 0,
- "items": [
- {
- "best_of": 0,
- "broadcast_start_time": 0,
- "broadcast_start_time_label": "string",
- "calculate_elo": true,
- "chat_room_id": "string",
- "competition_id": "string",
- "competition_name": "string",
- "competition_type": "string",
- "configured_at": 0,
- "demo_url": [
- "string"
], - "detailed_results": [
- {
- "asc_score": true,
- "factions": {
- "property1": {
- "score": 2
}, - "property2": {
- "score": 2
}
}, - "winner": "string"
}
], - "faceit_url": "string",
- "finished_at": 0,
- "game": "string",
- "group": 0,
- "match_id": "string",
- "organizer_id": "string",
- "region": "string",
- "results": {
- "score": {
- "property1": 0,
- "property2": 0
}, - "winner": "string"
}, - "round": 0,
- "scheduled_at": 0,
- "started_at": 0,
- "status": "string",
- "teams": {
- "property1": {
- "avatar": "string",
- "faction_id": "string",
- "leader": "string",
- "name": "string",
- "roster": [
- {
- "anticheat_required": true,
- "avatar": "string",
- "game_player_id": "string",
- "game_player_name": "string",
- "game_skill_level": 0,
- "membership": "string",
- "nickname": "string",
- "player_id": "string"
}
], - "roster_v1": null,
- "stats": {
- "rating": 0,
- "skillLevel": {
- "average": 0,
- "range": {
- "max": 0,
- "min": 0
}
}, - "winProbability": 0
}, - "substituted": true,
- "type": "string"
}, - "property2": {
- "avatar": "string",
- "faction_id": "string",
- "leader": "string",
- "name": "string",
- "roster": [
- {
- "anticheat_required": true,
- "avatar": "string",
- "game_player_id": "string",
- "game_player_name": "string",
- "game_skill_level": 0,
- "membership": "string",
- "nickname": "string",
- "player_id": "string"
}
], - "roster_v1": null,
- "stats": {
- "rating": 0,
- "skillLevel": {
- "average": 0,
- "range": {
- "max": 0,
- "min": 0
}
}, - "winProbability": 0
}, - "substituted": true,
- "type": "string"
}
}, - "version": 0,
- "voting": null
}
], - "start": 0
}
Retrieve all teams of a tournament
Retrieve all teams of a tournament
Authorizations:
path Parameters
tournament_id required | string The id of the tournament |
query Parameters
offset | integer >= 0 Default: 0 The starting item position |
limit | integer [ 1 .. 100 ] Default: 20 The number of items to return |
Responses
Response samples
- 200
{- "checked_in": [
- {
- "nickname": "string",
- "skill_level": 0,
- "subs_done": 0,
- "team_id": "string",
- "team_leader": "string",
- "team_type": "string"
}
], - "finished": [
- {
- "nickname": "string",
- "skill_level": 0,
- "subs_done": 0,
- "team_id": "string",
- "team_leader": "string",
- "team_type": "string"
}
], - "joined": [
- {
- "nickname": "string",
- "skill_level": 0,
- "subs_done": 0,
- "team_id": "string",
- "team_leader": "string",
- "team_type": "string"
}
], - "started": [
- {
- "nickname": "string",
- "skill_level": 0,
- "subs_done": 0,
- "team_id": "string",
- "team_leader": "string",
- "team_type": "string"
}
]
}