FACEIT Notes API Proxy - Documentation

Table of Contents ▼

Health Check Match Data with Players Historical Nicknames from Match Player Information Search Players

GET /api/health

Health check endpoint to verify API status and availability. Useful for monitoring and uptime checks.

Request Parameters

No parameters required.

Example Response

{
  "status": "healthy",
  "timestamp": "2025-10-26T12:34:56.789Z",
  "uptime": 3600,
  "environment": "production",
  "version": "1.0.0",
  "checks": {
    "api_key": "configured"
  }
}

GET /api/match

Get match data with all players. Returns current nicknames, avatars, and countries of all players.

Request Parameters

matchId FACEIT match ID (required)

Example Response

{
  "matchId": "1-xxx",
  "players": [
    {
      "playerId": "abc123",
      "nickname": "Player1",
      "avatar": "https://...",
      "country": "ua",
      "games": { "cs2": {...} }
    }
  ]
}

GET /api/match-stats

Get players from a match with their historical nicknames (as they were during the match). Useful for retrieving old nicknames.

Request Parameters

matchId FACEIT match ID (required)

Example Response

{
  "matchId": "1-xxx",
  "players": [
    {
      "playerId": "abc123",
      "nickname": "OldNickname"
    },
    {
      "playerId": "def456",
      "nickname": "AnotherOldNick"
    }
  ]
}

GET /api/player

Get information about a single player by their ID.

Request Parameters

playerId FACEIT player ID (required)

Example Response

{
  "playerId": "abc123",
  "nickname": "Player1",
  "avatar": "https://...",
  "country": "ua",
  "games": {
    "cs2": {
      "skill_level": 10,
      "faceit_elo": 2000
    }
  }
}

GET /api/search

Search for players by nickname with additional filters for game and country.

Request Parameters

nickname Nickname to search for (required)
game Filter by game (e.g., "cs2", "dota2", "lol")
country Filter by country (e.g., "ua", "ru", "us")
offset Pagination offset (default: 0)
limit Number of results (default: 20, max: 100)

Example Response

{
  "start": 0,
  "end": 20,
  "items": [
    {
      "player_id": "abc123",
      "nickname": "SearchedPlayer",
      "avatar": "https://...",
      "country": "ua",
      "games": { "cs2": {...} }
    }
  ]
}