### Retrieve Queue Bans (JSON Example) Source: https://docs.faceit.com/docs/data-api/data This JSON structure outlines the response for retrieving a list of bans associated with a specific queue. It includes pagination details and a list of ban items, though the specific fields for ban items are not detailed in this example. This is useful for administrators to monitor or manage queue access. ```json { "bans": [ // Ban item details would be listed here ] } ``` -------------------------------- ### GET /games Source: https://docs.faceit.com/docs/data-api/data Retrieve a paginated list of all games available on the FACEIT platform. ```APIDOC ## GET /games ### Description Retrieve details of all games on FACEIT. ### Method GET ### Endpoint https://open.faceit.com/data/v4/games ### Parameters #### Query Parameters - **offset** (integer) - Optional - The starting item position (Default: 0) - **limit** (integer) - Optional - The number of items to return (1-100, Default: 20) ### Response #### Success Response (200) - **items** (array) - List of game objects - **start** (integer) - Starting index - **end** (integer) - Ending index #### Response Example { "start": 0, "end": 0, "items": [{ "game_id": "string", "long_label": "string", "short_label": "string" }] } ``` -------------------------------- ### GET /organizers Source: https://docs.faceit.com/docs/data-api/data Retrieves details of an organizer based on their name. ```APIDOC ## GET /organizers ### Description Retrieve organizer details from name. ### Method GET ### Endpoint https://open.faceit.com/data/v4/organizers ### Parameters #### Query Parameters - **name** (string) - Required - The name of the organizer ### Response #### Success Response (200) - **name** (string) - The name of the organizer. - **id** (string) - The unique identifier for the organizer. - **profile_url** (string) - The URL to the organizer's profile page. #### Response Example ```json { "name": "string", "id": "string", "profile_url": "string" } ``` ``` -------------------------------- ### GET /games/{game_id}/queues/{queue_id} Source: https://docs.faceit.com/docs/data-api/data Retrieve detailed information about a specific queue. ```APIDOC ## GET /games/{game_id}/queues/{queue_id} ### Description Retrieve details of a queue on FACEIT. Available only for game or queue owners. ### Method GET ### Endpoint https://open.faceit.com/data/v4/games/{game_id}/queues/{queue_id} ### Parameters #### Path Parameters - **game_id** (string) - Required - The id of the game - **queue_id** (string) - Required - The id of the queue ### Response #### Success Response (200) - **queueName** (string) - Name of the queue - **state** (string) - Current state of the queue - **organizerId** (string) - ID of the organizer ``` -------------------------------- ### GET /websites/faceit Source: https://docs.faceit.com/docs/data-api/data Retrieves detailed information about a specific match, including results, teams, and player data. ```APIDOC ## GET /websites/faceit ### Description Retrieves detailed information about a specific match, including results, teams, and player data. ### Method GET ### Endpoint /websites/faceit ### Parameters #### Query Parameters - **match_id** (string) - Required - The unique identifier for the match. ### Request Example ```json { "example": "" } ``` ### Response #### Success Response (200) - **end** (integer) - The end timestamp of the match data. - **items** (array) - An array of match objects. - **best_of** (integer) - The best-of format for the match. - **broadcast_start_time** (integer) - The broadcast start time in Unix timestamp format. - **broadcast_start_time_label** (string) - A human-readable label for the broadcast start time. - **calculate_elo** (boolean) - Indicates if Elo should be calculated for this match. - **chat_room_id** (string) - The ID of the associated chat room. - **competition_id** (string) - The ID of the competition. - **competition_name** (string) - The name of the competition. - **competition_type** (string) - The type of competition. - **configured_at** (integer) - The timestamp when the match was configured. - **demo_url** (array) - An array of strings, each representing a demo URL. - **detailed_results** (array) - An array of detailed result objects. - **asc_score** (boolean) - Indicates if the score is ascending. - **factions** (object) - An object containing faction-specific results. - **property1** (object) - Details for faction 'property1'. - **score** (integer) - The score for the faction. - **property2** (object) - Details for faction 'property2'. - **score** (integer) - The score for the faction. - **winner** (string) - The winning faction. - **faceit_url** (string) - The URL to the match on FACEIT. - **finished_at** (integer) - The timestamp when the match finished. - **game** (string) - The name of the game. - **group** (integer) - The group number of the match. - **match_id** (string) - The unique identifier for the match. - **organizer_id** (string) - The ID of the match organizer. - **region** (string) - The region where the match took place. - **results** (object) - The overall results of the match. - **score** (object) - The score breakdown. - **property1** (integer) - Score for 'property1'. - **property2** (integer) - Score for 'property2'. - **winner** (string) - The winning faction. - **round** (integer) - The round number of the match. - **scheduled_at** (integer) - The scheduled start time in Unix timestamp format. - **started_at** (integer) - The actual start time in Unix timestamp format. - **status** (string) - The current status of the match. - **teams** (object) - An object containing details for each team. - **property1** (object) - Details for team 'property1'. - **avatar** (string) - The team's avatar URL. - **faction_id** (string) - The ID of the team's faction. - **leader** (string) - The nickname of the team leader. - **name** (string) - The name of the team. - **roster** (array) - An array of player objects in the roster. - **anticheat_required** (boolean) - Whether anti-cheat is required for the player. - **avatar** (string) - The player's avatar URL. - **game_player_id** (string) - The player's game-specific ID. - **game_player_name** (string) - The player's in-game name. - **game_skill_level** (integer) - The player's skill level in the game. - **membership** (string) - The player's membership type. - **nickname** (string) - The player's nickname on FACEIT. - **player_id** (string) - The unique ID of the player. - **roster_v1** (null) - Placeholder for older roster format. - **stats** (object) - Player statistics. - **rating** (integer) - The player's rating. - **skillLevel** (object) - The player's skill level details. - **average** (integer) - The average skill level. - **range** (object) - The skill level range. - **max** (integer) - The maximum skill level. - **min** (integer) - The minimum skill level. - **winProbability** (number) - The player's win probability. - **substituted** (boolean) - Whether the player was substituted. - **type** (string) - The type of team (e.g., '5v5'). - **property2** (object) - Details for team 'property2'. (Same structure as property1) - **version** (integer) - The version of the match data. - **voting** (null) - Placeholder for voting information. - **start** (integer) - The start timestamp of the match data. #### Response Example ```json { "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 } ``` ``` -------------------------------- ### GET /games/{game_id} Source: https://docs.faceit.com/docs/data-api/data Retrieve the full details of a specific game using its unique identifier. ```APIDOC ## GET /games/{game_id} ### Description Retrieve detailed information for a specific game on FACEIT. ### Method GET ### Endpoint https://open.faceit.com/data/v4/games/{game_id} ### Parameters #### Path Parameters - **game_id** (string) - Required - The unique ID of the game ### Response #### Success Response (200) - **game_id** (string) - The game ID - **long_label** (string) - Full name of the game - **assets** (object) - Collection of game imagery and branding assets #### Response Example { "game_id": "cs2", "long_label": "Counter-Strike 2", "assets": { "cover": "https://example.com/cover.jpg" } } ``` -------------------------------- ### GET /organizers Source: https://docs.faceit.com/docs/data-api/data Retrieves a list of organizers. This endpoint provides basic details for organizers on the FACEIT platform. ```APIDOC ## GET /organizers ### Description Retrieves a list of organizers. This endpoint provides basic details for organizers on the FACEIT platform. ### Method GET ### Endpoint https://open.faceit.com/data/v4/organizers ### Parameters #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **avatar** (string) - URL to the organizer's avatar. - **cover** (string) - URL to the organizer's cover image. - **description** (string) - A description of the organizer. - **facebook** (string) - The organizer's Facebook profile URL. - **faceit_url** (string) - The organizer's FACEIT profile URL. - **followers_count** (integer) - The number of followers the organizer has. - **name** (string) - The name of the organizer. - **organizer_id** (string) - The unique identifier for the organizer. - **twitch** (string) - The organizer's Twitch channel URL. - **twitter** (string) - The organizer's Twitter profile URL. - **type** (string) - The type of organizer. - **vk** (string) - The organizer's VK profile URL. - **website** (string) - The organizer's website URL. - **youtube** (string) - The organizer's YouTube channel URL. #### Response Example ```json { "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 Queue Details (JSON Example) Source: https://docs.faceit.com/docs/data-api/data This JSON object details a specific queue, including its matching algorithm, join types, and administrative settings. It's crucial for understanding the configuration of a particular queue and its operational parameters. This data can inform users about how a queue functions. ```json { "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 } ``` -------------------------------- ### GET /tournaments/{tournament_id}/teams Source: https://docs.faceit.com/docs/data-api/data Retrieve all teams participating in a specific tournament, categorized by their status (checked-in, joined, started, finished). ```APIDOC ## GET /tournaments/{tournament_id}/teams ### Description Retrieve all teams participating in a specific tournament, categorized by their status (checked-in, joined, started, finished). ### Method GET ### Endpoint /tournaments/{tournament_id}/teams ### Parameters #### Path Parameters - **tournament_id** (string) - Required - The ID of the tournament. #### Query Parameters - **offset** (integer) - Optional - The starting item position for pagination. Defaults to 0. - **limit** (integer) - Optional - The number of items to return per page. Must be between 1 and 100. Defaults to 20. ### Request Example ```json { "example": "" } ``` ### Response #### Success Response (200) - **checked_in** (array) - A list of teams that have checked in. - **nickname** (string) - The nickname of the team. - **skill_level** (integer) - The average skill level of the team. - **subs_done** (integer) - The number of substitutions made. - **team_id** (string) - The unique ID of the team. - **team_leader** (string) - The nickname of the team leader. - **team_type** (string) - The type of team (e.g., '5v5'). - **finished** (array) - A list of teams that have finished the tournament. (Same structure as checked_in) - **joined** (array) - A list of teams that have joined the tournament. (Same structure as checked_in) - **started** (array) - A list of teams that have started the tournament. (Same structure as checked_in) #### Error Responses - **401** - Unauthorized: Authentication credentials are missing or invalid. - **403** - Forbidden: The authenticated user does not have permission to access this resource. - **404** - Not Found: The specified tournament could not be found. - **429** - Too Many Requests: The rate limit has been exceeded. - **503** - Service Unavailable: The service is temporarily unavailable. #### Response Example ```json { "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" } ] } ``` ``` -------------------------------- ### GET /tournaments/{tournament_id}/teams Source: https://docs.faceit.com/api/data Retrieves a list of teams participating in a specific tournament, categorized by their current status (checked_in, finished, joined, started). ```APIDOC ## GET /tournaments/{tournament_id}/teams ### Description Retrieve all teams associated with a specific tournament. The results are grouped by the team's status within the tournament. ### Method GET ### Endpoint https://open.faceit.com/data/v4/tournaments/{tournament_id}/teams ### Parameters #### Path Parameters - **tournament_id** (string) - Required - The unique identifier of the tournament. #### Query Parameters - **offset** (integer) - Optional - The starting item position (Default: 0). - **limit** (integer) - Optional - The number of items to return (Range: 1-100, Default: 20). ### Response #### Success Response (200) - **checked_in** (array) - List of teams that have checked in. - **finished** (array) - List of teams that have finished. - **joined** (array) - List of teams that have joined. - **started** (array) - List of teams that have started. #### Response Example { "checked_in": [], "finished": [], "joined": [], "started": [] } ``` -------------------------------- ### Retrieve Leaderboards for a Hub (JSON Example) Source: https://docs.faceit.com/docs/data-api/data This JSON object represents a sample response when retrieving leaderboards for a specific hub. It includes details about the leaderboard and a list of items within it. ```json { "end": 0, "items": [ { "current_streak": 0, "draw": 0, "lost": 0, "played": 0, "player": { "avatar": "https://avatar.jpg", "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 } ``` -------------------------------- ### POST /download/v2/demos/download Source: https://docs.faceit.com/getting-started/Guides/download-api This endpoint exchanges a cloud resource URL for a temporary, signed download URL to access private files. ```APIDOC ## POST /download/v2/demos/download ### Description Returns a signed download URL for a given cloud resource URL. This is required to access private files like game demos. ### Method POST ### Endpoint /download/v2/demos/download ### Parameters #### Request Body - **resource_url** (string) - Required - The Cloud resource URL of the file to be accessed. ### Request Example { "resource_url": "https://demos.faceit.com/csgo/1-cb038819-b0d0-4471-b25c-0e7468ab1eb1-1-1.dem.gz" } ### Response #### Success Response (200) - **payload.download_url** (string) - The signed URL used to download the file. #### Response Example { "payload": { "download_url": "https://signed-url-example.com/file.dem.gz?token=xyz" } } ``` -------------------------------- ### GET /tournaments Source: https://docs.faceit.com/docs/data-api/data Retrieves a list of tournaments based on game and region filters. ```APIDOC ## GET /tournaments ### Description Retrieve a list of tournaments. Note: This is the v4 endpoint; v1 is deprecated. ### Method GET ### Endpoint https://open.faceit.com/data/v4/tournaments ### Parameters #### Query Parameters - **game** (string) - Optional - A game on FACEIT - **region** (string) - Optional - A region of the game - **offset** (integer) - Optional - The starting item position (Default: 0) - **limit** (integer) - Optional - The number of items to return (Default: 20, Range: 1-100) ### Response #### Success Response (200) - **items** (array) - List of tournament objects - **start** (integer) - Starting index - **end** (integer) - Ending index #### Response Example { "start": 0, "end": 0, "items": [ { "tournament_id": "string", "name": "string", "game_id": "string", "status": "string" } ] } ``` -------------------------------- ### Match Details Response Sample Source: https://docs.faceit.com/docs/data-api/data A sample JSON response for retrieving match details. This structure outlines various properties related to a match, including game information, competition details, team rosters, and results. ```JSON { "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 } ``` -------------------------------- ### GET /search/championships Source: https://docs.faceit.com/docs/data-api/data Search for championships on the FACEIT platform based on name and filters. ```APIDOC ## GET /search/championships ### Description Search for championships using specific criteria such as name, game, region, or status. ### Method GET ### Endpoint https://open.faceit.com/data/v4/search/championships ### Parameters #### Query Parameters - **name** (string) - Required - The name of a championship. - **game** (string) - Optional - A game on FACEIT. - **region** (string) - Optional - A region of the game. - **type** (string) - Optional - Kind of competitions (all, upcoming, ongoing, past). ### Response #### Success Response (200) - **items** (array) - List of matching championships #### Response Example { "items": [ { "competition_id": "string", "name": "string", "status": "string" } ] } ``` -------------------------------- ### Matchmaking Details Response Sample Source: https://docs.faceit.com/docs/data-api/data A sample JSON response for the matchmaking details endpoint. It includes details such as the game associated with the matchmaking, its name, region, and a list of available queues with their status. ```JSON { "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" } ``` -------------------------------- ### GET /organizers/{organizer_id}/championships Source: https://docs.faceit.com/docs/data-api/data Retrieves all championships associated with a specific organizer. ```APIDOC ## GET /organizers/{organizer_id}/championships ### Description Retrieves all championships associated with a specific organizer. ### Method GET ### Endpoint https://open.faceit.com/data/v4/organizers/{organizer_id}/championships ### Parameters #### Path Parameters - **organizer_id** (string) - Required - The ID of the organizer. #### Query Parameters - **offset** (integer) - Optional - The starting item position. Defaults to 0. - **limit** (integer) - Optional - The number of items to return. Defaults to 20. Maximum is 100. #### Request Body None ### Response #### Success Response (200) - **Championships list** - Details about the championships organized by the specified organizer. #### Response Example (Response structure for championships list not provided in the input text.) ``` -------------------------------- ### Retrieve Player Details (JSON Response Sample) Source: https://docs.faceit.com/docs/data-api/data This JSON structure represents a sample response when retrieving details for a specific player. It includes information such as activation date, avatar, country, game details, membership, and platform information. The structure is comprehensive, detailing various attributes associated with a player's profile on Faceit. ```json { "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 } ``` -------------------------------- ### GET /players/{player_id}/tournaments Source: https://docs.faceit.com/docs/data-api/data Retrieve a list of tournaments associated with a specific player. ```APIDOC ## GET /players/{player_id}/tournaments ### Description Retrieves a list of tournaments that a specific player has participated in or is associated with. ### Method GET ### Endpoint https://open.faceit.com/data/v4/players/{player_id}/tournaments ### Parameters #### Path Parameters - **player_id** (string) - Required - The unique identifier of the player. ### Response #### Success Response (200) - **items** (array) - List of tournament objects - **start** (integer) - Start index - **end** (integer) - End index #### Response Example { "start": 0, "end": 0, "items": [ { "tournament_id": "string", "name": "string", "status": "string" } ] } ``` -------------------------------- ### GET /websites/faceit Source: https://docs.faceit.com/docs/data-api/data This endpoint appears to be related to website data, possibly match results or statistics, based on the provided response sample. ```APIDOC ## GET /websites/faceit ### Description This endpoint provides detailed information about matches, including results, team data, and player statistics. The response structure is complex and contains nested objects for various aspects of a match. ### Method GET ### Endpoint /websites/faceit ### Parameters *Note: No explicit parameters are defined in the provided text for this endpoint. It might be a placeholder or require parameters not detailed here.* ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **end** (integer) - The end index of the returned items. - **items** (array) - A list of match objects. - **best_of** (integer) - The 'best of' value for the match. - **broadcast_start_time** (integer) - The broadcast start time in Unix timestamp format. - **broadcast_start_time_label** (string) - A human-readable label for the broadcast start time. - **calculate_elo** (boolean) - Indicates if ELO should be calculated for this match. - **chat_room_id** (string) - The ID of the associated chat room. - **competition_id** (string) - The ID of the competition. - **competition_name** (string) - The name of the competition. - **competition_type** (string) - The type of competition. - **configured_at** (integer) - The time the competition was configured. - **demo_url** (array) - A list of URLs for match demos. - (string) - A demo URL. - **detailed_results** (array) - Detailed results for each faction. - **asc_score** (boolean) - Indicates if the score is ascending. - **factions** (object) - Faction-specific results. - **property1** (object) - Details for faction 'property1'. - **score** (integer) - The score for this faction. - **property2** (object) - Details for faction 'property2'. - **score** (integer) - The score for this faction. - **winner** (string) - The winning faction. - **faceit_url** (string) - The FACEIT URL for the match. - **finished_at** (integer) - The time the match finished. - **game** (string) - The game played in the match. - **group** (integer) - The group the match belongs to. - **match_id** (string) - The unique ID of the match. - **organizer_id** (string) - The ID of the match organizer. - **region** (string) - The region where the match was played. - **results** (object) - Summary results of the match. - **score** (object) - The final score. - **property1** (integer) - Score for 'property1'. - **property2** (integer) - Score for 'property2'. - **winner** (string) - The winning faction. - **round** (integer) - The round number. - **scheduled_at** (integer) - The scheduled start time of the match. - **started_at** (integer) - The actual start time of the match. - **status** (string) - The current status of the match. - **teams** (object) - Information about the participating teams. - **property1** (object) - Details for team 'property1'. - **avatar** (string) - Team avatar URL. - **faction_id** (string) - The ID of the team's faction. - **leader** (string) - The player ID of the team leader. - **name** (string) - The name of the team. - **roster** (array) - List of players in the team. - **anticheat_required** (boolean) - Whether anti-cheat is required for the player. - **avatar** (string) - Player avatar URL. - **game_player_id** (string) - Player ID in the specific game. - **game_player_name** (string) - Player name in the specific game. - **game_skill_level** (integer) - Player's skill level in the game. - **membership** (string) - Player's membership status. - **nickname** (string) - Player's nickname. - **player_id** (string) - The unique FACEIT player ID. - **roster_v1** (null) - Placeholder for roster version 1 (currently null). - **stats** (object) - Player statistics. - **rating** (integer) - Player's rating. - **skillLevel** (object) - Player's skill level details. - **average** (integer) - Average skill level. - **range** (object) - Skill level range. - **max** (integer) - Maximum skill level. - **min** (integer) - Minimum skill level. - **winProbability** (number) - Probability of winning. - **substituted** (boolean) - Whether the player was substituted. - **type** (string) - The type of team (e.g., 'team'). - **property2** (object) - Details for team 'property2' (structure identical to property1). - **version** (integer) - The version of the match data. - **voting** (null) - Placeholder for voting information (currently null). - **start** (integer) - The start index of the returned items. #### Response Example ```json { "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 } ``` ``` -------------------------------- ### Response Sample: Hub Details Source: https://docs.faceit.com/api/data This JSON structure represents a sample response for hub details. It includes extensive information such as the hub's avatar, description, game data, organizer data, and player statistics. This detailed object is returned when requesting specific hub information. ```json { "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" } ```