FACEIT

https://docs.faceit.com
Admin
FACEIT provides developer tools and online services for game integration, app building, and managing...
Tokens:55,494
Snippets:263
Trust Score:9.8
Update:1 week ago
Show doc for...
Tokens:
Raw
### GET /tournaments/{tournament_id} - 200 Response Sample

Source: https://docs.faceit.com/docs/data-api/data

Example JSON response for a successful tournament details request. The response includes tournament metadata such as anticheat_required, best_of, calculate_elo, competition_id, cover_image, custom, description, faceit_url, featured_image, and game_data with asset URLs.

```json
{
  "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",
      "featured_img_l": "string",
      "featured_img_m": "string",
      "featured_img_s": "string"
    }
  }
}``````json { 
```

--------------------------------

### 200 Response JSON for GET /matches/{match_id}

Source: https://docs.faceit.com/docs/data-api/data

Example response body for a successful 200 response when retrieving match details. Shows the full JSON structure including match metadata, teams, rosters, results, and statistics. Fields like 'best_of', 'calculate_elo', and 'status' are placeholders.

```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,
  "instances": [
    {
      "demos": [
        "string"
      ],
      "id": "string",
      "round": 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,
      "substitutes": [
        {
          "anticheat_required": true,
          "avatar": "string",
          "game_player_id": "string",
          "game_player_name": "string",
          "game_skill_level": 0,
          "membership": "string",
          "nickname": "string",
          "player_id": "string",
          "playing": 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,
      "substitutes": [
        {
          "anticheat_required": true,
          "avatar": "string",
          "game_player_id": "string",
          "game_player_name": "string",
          "game_skill_level": 0,
          "membership": "string",
          "nickname": "string",
          "player_id": "string",
          "playing": true
        }
      ],
      "type": "string"
    }
  },
  "version": 0,
  "voting": null
}
```

--------------------------------

### GET /players Response Sample (200)

Source: https://docs.faceit.com/docs/data-api/data

Example JSON response for a successful player details request. Shows the player object with fields such as activated_at, avatar, country, games, and friends_ids. Use this shape to parse the response from the GET /players endpoint.

```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,
      "region": "string"
    },
    "property2": {
      "faceit_elo": 0,
      "game_player_id": "string",
      "game_player_name": "string",
      "game_profile_id": 
```

```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,
      "region": "string",
      "game_player_id": 
```

```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
    },
    "property2": {
      "faceit_elo": 0,
      "game_player_id": "string",
      "game_player_name": "string",
      "game_profile_id": "string",
      "region": "string",
      "regions": null,
      "skill_level": 0
    }
  },JSON, 
```

```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
    },
    "property2": {
      "faceit_elo": 0,
      "game_player_id": "string",
      "game_player_name": "string",
      "game_profile_id": "string",
      "region": "string",
      "regions": null,
      "skill_level": 0
    }
  },  * 
```

```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,
      "region": "string"
    },
    "property2": {
      "faceit_elo": 0,
      "game_player_id": "string",
      "game_player_name": "string",
      "game_profile_id": "string",
      "region": "string",
      "regions": null,
      "region": "string"
    }
  },  * 
```

--------------------------------

### Example well-formed request

Source: https://docs.faceit.com/getting-started/partner-integration-guide/cdp-integration

A complete example of a well-formed request to the send-event endpoint, including headers and JSON body with platform_user_id, platform, and event attributes.

```http
POST https://cdp.faceit.com/cdp/v1/users/events/send  
Authorization: Bearer <API key>  
Content-Type: application/json  
{  
  "platform_user_id": "1ee5c514-8064-6a42-ab01-0242ac17000a",  
  "platform": "<partner>",  
  "event": {  
    "id": "deposit-1423452345",  
    "name": "deposit",  
    "created_at": 1708703778,  
    "attributes": [  
      {  
        "name": "amount",  
        "value": "100"  
      }  
    ]  
  }  
}  
```

--------------------------------

### User info endpoint URL (GET)

Source: https://docs.faceit.com/getting-started/partner-integration-guide/account-linkage

The partner must implement this endpoint to get user information. Requires an Authorization header with a Bearer access token.

```http
GET https://<partner domain>/oauth2/userinfo  
```

--------------------------------

### GET /leaderboards/hubs/{hub_id}/seasons/{season}

Source: https://docs.faceit.com/docs/data-api/data

Documentation for the GET endpoint that retrieves the seasonal ranking of a hub.

```APIDOC
## GET /leaderboards/hubs/{hub_id}/seasons/{season}

### Description
Retrieves the seasonal ranking of a specific hub. This endpoint returns the leaderboard for a given hub and season, including player standings and leaderboard metadata.

### Method
GET

### Endpoint
https://open.faceit.com/data/v4/leaderboards/hubs/{hub_id}/seasons/{season}

### Authorizations
- _key_

### Parameters
#### Path Parameters
- **hub_id** (string) - Required - The id of the hub
- **season** (integer) - Required - A season of the hub

#### Query Parameters
- **offset** (integer, >= 0) - Optional - Default: 0 - The starting item position
- **limit** (integer, [1..100]) - Optional - Default: 20 - The number of items to return

### Response
#### Success Response (200)
Hub ranking

#### Response Example
```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
}
```

#### Error Responses
- **400** - Bad request
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
- **429** - Too many requests
- **503** - Temporarily unavailable
- **default** - Generic error
```

--------------------------------

### Response example for redeem code endpoint

Source: https://docs.faceit.com/getting-started/partner-integration-guide/auto-redeem-guide

Example of a response from the redeem code endpoint. Contains a human-readable error code and a detailed error message. The partner must return 422 HTTP code for the listed error cases and 401 for invalid access token.

```json
{  
  "code": "invalid_code",  
  "message": "code was already redeemed"  
}  

```

--------------------------------

### Example error response

Source: https://docs.faceit.com/getting-started/partner-integration-guide/cdp-integration

An example of an error response body with an error object containing code and message fields.

```json
{  
   "error": {  
      "code": "UserNotFound",  
      "message": "user is not found"  
   }  
}  
```

--------------------------------

### GET /leagues/{league_id}/seasons/{season_id}

Source: https://docs.faceit.com/docs/data-api/data

Retrieves details of a season of a league on FACEIT.

```APIDOC
## GET /leagues/{league_id}/seasons/{season_id}

### Description
Retrieve details of a season of a league on FACEIT.

### Method
GET

### Endpoint
https://open.faceit.com/data/v4/leagues/{league_id}/seasons/{season_id}

### Parameters
#### Path Parameters
- **league_id** (string) - Required - The id of the league. Example: 6e7daaee-8b9d-4fbf-86c4-361fa7e579fc
- **season_id** (integer) - Required - The id of the season. Example: 1

### Response
#### Success Response (200)
Season details

#### Response Example
{
  "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"
  }
}

### Error Responses
- **400** - Bad request
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
- **429** - Too many requests
- **503** - Temporarily unavailable
- **default** - Generic error
```

--------------------------------

### Request Body for Demo Download

Source: https://docs.faceit.com/getting-started/Guides/download-api

JSON request body for the POST /download/v2/demos/download endpoint. It must include the resource_url of the cloud file.

```json
{  
  "resource_url":"https://demos.faceit.com/csgo/1-cb038819-b0d0-4471-b25c-0e7468ab1eb1-1-1.dem.gz"  
}  
```

--------------------------------

### GET /players/{player_id} - 200 Response Sample (application/json)

Source: https://docs.faceit.com/docs/data-api/data

Sample JSON response body for a successful 200 response when retrieving player details. The response includes player profile fields such as avatar, country, and games with per-game statistics.

```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": 
```

--------------------------------

### Response Body for Demo Download

Source: https://docs.faceit.com/getting-started/Guides/download-api

JSON response body containing the signed download URL in the payload.download_url field.

```json
{  
    "payload":{  
        "download_url": "<signed_url>"  
    }  
}  
```

--------------------------------

### GET /games

Source: https://docs.faceit.com/docs/data-api/data

Retrieves details of all games on FACEIT. Requires API key authorization. Supports pagination via offset and limit query parameters.

```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. Minimum: 0.
- **limit** (integer) - Optional - The number of items to return. Range: 1-100. Default: 20.

### Response
#### Success Response (200)
Games list

#### Response Example
```json
{
  "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
}
```

### Error Responses
- **400** - Bad request
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
- **429** - Too many requests
- **503** - Temporarily unavailable
- **default** - Generic error
```

--------------------------------

### GET /search/championships

Source: https://docs.faceit.com/docs/data-api/data

Search for championships on FACEIT.

```APIDOC
## GET /search/championships

### Description
Search for championships on FACEIT.

### Method
GET

### Endpoint
https://open.faceit.com/data/v4/search/championships

### Parameters
#### Query Parameters
- **name** (string) - Required - The name of a championship on FACEIT
- **game** (string) - Optional - A game on FACEIT
- **region** (string) - Optional - A region of the game
- **type** (string) - Optional - Enum: "all" "upcoming" "ongoing" "past" Kind of competitions to return
- **offset** (integer) - Optional - Default: 0 - The starting item position
- **limit** (integer) - Optional - Default: 20 - The number of items to return

### Responses
#### Success Response (200)
List of championship

#### Response Example
```json
{
  "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
}
```

#### Error Responses
- **400** - Bad request
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
- **429** - Too many requests
- **503** - Temporarily unavailable
- **default** - Generic error
```

--------------------------------

### GET /search/clans

Source: https://docs.faceit.com/docs/data-api/data

Search for clans on FACEIT.

```APIDOC
## GET /search/clans

### Description
Search for clans on FACEIT.

### Method
GET

### Endpoint
https://open.faceit.com/data/v4/search/clans

### Parameters
#### Query Parameters
- **name** (string) - Required - The name of a clan on FACEIT
- **game** (string) - Optional - A game on FACEIT
- **region** (string) - Optional - A region of the game
- **offset** (integer) - Optional - Default: 0 - The starting item position
- **limit** (integer) - Optional - Default: 20 - The number of items to return

### Responses
#### Success Response (200)
List of hub

#### Response Example
```json
{
  "end": 0,
  "items": [
    {
      "avatar": "https://faceit.com/images/example-clan-avatar.jpeg",
      "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
}
```

#### Error Responses
- **400** - Bad request
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
- **429** - Too many requests
- **503** - Temporarily unavailable
- **default** - Generic error
```

--------------------------------

### GET /players/{player_id}/teams

Source: https://docs.faceit.com/docs/data-api/data

Retrieve all teams of a player.

```APIDOC
## GET /players/{player_id}/teams

### Description
Retrieve all teams of a player.

### Method
GET

### Endpoint
https://open.faceit.com/data/v4/players/{player_id}/teams

### Parameters
#### Path Parameters
- **player_id** (string) - Required - The id of the player

#### Query Parameters
- **offset** (integer) - Optional - The starting item position. Default: 0. Minimum: 0.
- **limit** (integer) - Optional - The number of items to return. Range: 1 to 100. Default: 20.

### Response
#### Success Response (200)
Teams of a user

#### Response Example
```json
{
  "end": 0,
  "items": [
    {
      "avatar": "https://avatar.jpg",
      "chat_room_id": "team-6204037c-30e6-408b-8aaa-dd8219860b4b",
      "cover_image": "https://cover-image.jpg",
      "description": "Some description",
      "facebook": "https://facebook/team",
      "faceit_url": "https://www.faceit.com/{lang}/teams/6204037c-30e6-408b-8aaa-dd8219860b4b",
      "game": "csgo",
      "leader": "leader",
      "members": [
        {
          "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"
        }
      ],
      "name": "name",
      "nickname": "nickname",
      "team_id": "6204037c-30e6-408b-8aaa-dd8219860b4b",
      "team_type": "premade",
      "twitter": "https://twitter/team",
      "website": "https://team.website",
      "youtube": "https://youtube.com/team"
    }
  ],
  "start": 0
}
```

### Error Responses
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
- **429** - Too many requests
- **503** - Temporarily unavailable
- **default** - Generic error
```

--------------------------------

### GET /matchmakings/{matchmaking_id}

Source: https://docs.faceit.com/docs/data-api/data

Retrieve details of a matchmaking by its ID.

```APIDOC
## GET /matchmakings/{matchmaking_id}

### Description
Retrieve details of a matchmaking of a game on FACEIT.

### Method
GET

### Endpoint
https://open.faceit.com/data/v4/matchmakings/{matchmaking_id}

### Parameters
#### Path Parameters
- **matchmaking_id** (string) - Required - The id of the matchmaking

### Response
#### Success Response (200)
Matchmaking

#### Response Example
```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"
}
```

### Error Handling
- **400** - Bad request
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
- **429** - Too many requests
- **503** - Temporarily unavailable
- **default** - Generic error
```

--------------------------------

### POST /cdp/v1/users/events/send

Source: https://docs.faceit.com/getting-started/partner-integration-guide/cdp-integration

Sends a user event (e.g., KYC, deposit) to FACEIT. The request must include platform_user_id, platform, and event details. Returns 200 on success or 4XX with an error object on failure.

```APIDOC
## POST /cdp/v1/users/events/send

### Description
Sends a user event (e.g., KYC, deposit) to FACEIT. The request must include platform_user_id, platform, and event details. Returns 200 on success or 4XX with an error object on failure.

### Method
POST

### Endpoint
https://cdp.faceit.com/cdp/v1/users/events/send

### Parameters
#### Header Parameters
- **Content-Type** (string) - Required - Must be application/json.
- **Authorization** (string) - Required - Bearer authentication. API key shared by FACEIT.

#### Request Body
- **platform_user_id** (string) - Required - The user ID in the partner platform. The partner returns this ID in the user-info-endpoint response after linking accounts.
- **platform** (string) - Required - The platform defines the partner ID in the FACEIT.
- **event** (Event) - Required - The event contains related to the event information from the partner platform.

#### Event Object
- **id** (string) - Required - The event identificator. It should be unique for every event. FACEIT uses it to check if the event is already handled. If the partner sends the same ID, FACEIT does nothing and returns OK. For two different events, the partner should send two different IDs.
- **name** (string) - Required - The name defines a human-readable event name. FACEIT accepts any event name, but they should be negotiated with management.
- **created_at** (int64) - Required - Unix timestamp. It defines the date when the event actually happened, not the time when the event was sent.
- **attributes** (array of Attribute) - Optional - Attributes define event-specific information. It can be empty. FACEIT accepts any attributes, but they should be negotiated with management. The partner doesn’t have to send redundant attributes.

#### Attribute Object
- **name** (string) - Required - Human-readable attribute name.
- **value** (string) - Required - Attribute value.

### Request Example
```
POST https://cdp.faceit.com/cdp/v1/users/events/send  
Authorization: Bearer <API key>  
Content-Type: application/json  
{  
  "platform_user_id": "1ee5c514-8064-6a42-ab01-0242ac17000a",  
  "platform": "<partner>",  
  "event": {  
    "id": "deposit-1423452345",  
    "name": "deposit",  
    "created_at": 1708703778,  
    "attributes": [  
      {  
        "name": "amount",  
        "value": "100"  
      }  
    ]  
  }  
}  
```

### Response
#### Success Response (200)
Returns 200 HTTP code if an event was sent successfully.

#### Error Response (4XX)
Returns 4XX HTTP code with an `error` object in the response body with the following parameters:
- **code** (string) - A human-readable error code used to identify the error that occurred.
- **message** (string) - A detailed error message.

#### Response Example
```
{  
   "error": {  
      "code": "UserNotFound",  
      "message": "user is not found"  
   }  
}  
```

### Notes
- For test env domain will be cdp.faceit-stage.com
- Currently, there aren’t special errors. The partner should retry every error from FACEIT. That’s why there aren’t examples of error codes.
```

--------------------------------

### GET /games/{game_id}/queues/{queue_id}

Source: https://docs.faceit.com/docs/data-api/data

Retrieves details of a queue on FACEIT. Available only for game or queue owners (organizers).

```APIDOC
## GET /games/{game_id}/queues/{queue_id}

### Description
Retrieves details of a queue on FACEIT. Available only for game or queue owners (organizers).

### 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. Example: cs2
- **queue_id** (string) - Required - The id of the queue

### Response
#### Success Response (200)
- **adminTool** (boolean) - Whether admin tool is enabled
- **anticheatRequired** (boolean) - Whether anticheat is required
- **calculateElo** (boolean) - Whether ELO calculation is enabled
- **captainSelection** (string) - Captain selection method
- **checkIn** (object) - Check-in settings
  - **time** (integer) - Check-in time
- **entityId** (string) - The entity id
- **entityType** (string) - The entity type
- **fbiManagement** (boolean) - Whether FBI management is enabled
- **game** (string) - The game id
- **groupSimilar** (boolean) - Whether similar groups are grouped
- **id** (string) - The queue id
- **joinType** (object) - Join type settings
  - **maxParty** (integer) - Maximum party size
  - **party** (boolean) - Whether party join is allowed
  - **premade** (boolean) - Whether premade join is allowed
  - **solo** (boolean) - Whether solo join is allowed
- **lastModified** (string, date-time) - Last modification timestamp
- **maxSkill** (integer) - Maximum skill level
- **minSkill** (integer) - Minimum skill level
- **noOfPlayers** (integer) - Number of players
- **open** (boolean) - Whether the queue is open
- **organizerId** (string) - The organizer id
- **paused** (boolean) - Whether the queue is paused
- **queueAlgorithm** (object) - Queue algorithm settings
  - **algorithmId** (string) - Algorithm id
  - **algorithmInput** (array of string) - Algorithm input
  - **algorithmParameters** (object) - Algorithm parameters
    - **band** (object) - Band settings
      - **value** (integer) - Band value
  - **geoDescription** (object) - Geographic description
    - **en** (string) - English description
    - **fr** (string) - French description
  - **geoLabel** (object) - Geographic label
    - **en** (string) - English label
    - **fr** (string) - French label
  - **id** (string) - Algorithm id
  - **roleBasedCaptainPick** (boolean) - Whether role-based captain pick is enabled
- **queueName** (string) - The queue name
- **region** (string) - The region
- **state** (string) - The queue state
- **verifiedMatching** (boolean) - Whether verified matching is enabled

#### Response Example
```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
}
```

### Error Handling
- **400** - Bad request
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
- **429** - Too many requests
- **503** - Temporarily unavailable
- **default** - Generic error
```

--------------------------------

### GET /hubs/{hub_id}/rules

Source: https://docs.faceit.com/docs/data-api/data

Retrieves the rules of a specific hub.

```APIDOC
## GET /hubs/{hub_id}/rules

### Description
Retrieves the rules of a specific hub.

### Method
GET

### Endpoint
https://open.faceit.com/data/v4/hubs/{hub_id}/rules

### Parameters
#### Path Parameters
- **hub_id** (string) - Required - The id of the hub

### Response
#### Success Response (200)
Rules details

#### Response Example
```json
{
  "body": "string",
  "game": "string",
  "name": "string",
  "organizer": "string",
  "rule_id": "string"
}
```

#### Error Responses
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
- **429** - Too many requests
- **503** - Temporarily unavailable
- **default** - Generic error
```

--------------------------------

### GET /leagues/{league_id}/seasons/{season_id}/players/{player_id}

Source: https://docs.faceit.com/docs/data-api/data

Retrieves details of a player for a given league and season on FACEIT.

```APIDOC
## GET /leagues/{league_id}/seasons/{season_id}/players/{player_id}

### Description
Retrieve details of a player for a given league and season on FACEIT.

### Method
GET

### Endpoint
https://open.faceit.com/data/v4/leagues/{league_id}/seasons/{season_id}/players/{player_id}

### Parameters
#### Path Parameters
- **league_id** (string) - Required - The id of the league. Example: 6e7daaee-8b9d-4fbf-86c4-361fa7e579fc
- **season_id** (integer) - Required - The id of the season. Example: 1
- **player_id** (string) - Required - The id of the player. Example: 6e7daaee-8b9d-4fbf-86c4-361fa7e579fc

### Response
#### Success Response (200)
Player details

#### Response Example
{
  "division_name": "string",
  "division_tier": "string",
  "division_type": "string",
  "leaderboard_id": "string",
  "points": 0,
  "position": 0
}

### Error Responses
- **400** - Bad request
- **401** - Unauthorized
- **403** - Forbidden
- **404** - Not Found
- **429** - Too many requests
- **503** - Temporarily unavailable
- **default** - Generic error
```
Tokens:
Raw