FAForever Lobby Server API 1.0.0

{
  "command": "auth",
  "token": "eyJhbGciOiJSUzI1NiJ9...",
  "unique_id": "7d04beb8-d4b8-40f5-8464-a9efa8546728",
  "session": 812469452
}

{
  "command": "ask_session",
  "version": "0.11.16",
  "user_agent": "faf-client"
}

{
  "command": "game_host",
  "title": "Test game",
  "visibility": "public",
  "mod": "faf",
  "mapname": "scmp_007",
  "password": null
}

{
  "command": "game_join",
  "uid": 42,
  "password": null
}

{
  "command": "restore_game_session",
  "game_id": 42
}

{
  "command": "game_matchmaking",
  "queue_name": "ladder1v1",
  "state": "start"
}

{
  "command": "is_ready_response",
  "request_id": "abc123"
}

{
  "command": "matchmaker_info"
}

{
  "command": "set_player_vetoes",
  "vetoes": [
    {
      "map_pool_map_version_id": 15,
      "veto_tokens_applied": 1
    }
  ]
}

{
  "command": "social_add",
  "friend": 42
}

{
  "command": "social_add",
  "foe": 99
}

{
  "command": "social_remove",
  "friend": 42
}

{
  "command": "avatar",
  "action": "list_avatar"
}

{
  "command": "avatar",
  "action": "select",
  "avatar": "https://content.faforever.com/faf/avatars/UEF.png"
}

{
  "command": "admin",
  "action": "closelobby",
  "user_id": 42
}

{
  "command": "admin",
  "action": "broadcast",
  "message": "Server will restart in 5 minutes"
}

{
  "command": "invite_to_party",
  "recipient_id": 3
}

{
  "command": "accept_party_invite",
  "sender_id": 1
}

{
  "command": "kick_player_from_party",
  "kicked_player_id": 3
}

{
  "command": "leave_party"
}

{
  "command": "unready_party"
}

{
  "command": "set_party_factions",
  "factions": [
    "uef"
  ]
}

{
  "command": "coop_list"
}

{
  "command": "modvault",
  "type": "start"
}

{
  "command": "modvault",
  "type": "like",
  "uid": "FFF"
}

{
  "command": "ice_servers"
}

{
  "command": "ping"
}

{
  "command": "pong"
}

{
  "command": "welcome",
  "me": {
    "id": 3,
    "login": "Rhiza",
    "clan": "123",
    "country": "",
    "ratings": {
      "global": {
        "rating": [
          1650,
          62.52
        ],
        "number_of_games": 2
      },
      "ladder_1v1": {
        "rating": [
          1650,
          62.52
        ],
        "number_of_games": 2
      }
    },
    "global_rating": [
      1650,
      62.52
    ],
    "ladder_rating": [
      1650,
      62.52
    ],
    "number_of_games": 2
  },
  "current_time": "1970-01-01T00:00:00+00:00",
  "id": 3,
  "login": "Rhiza"
}

{
  "command": "session",
  "session": 812469452
}

{
  "command": "authentication_failed",
  "text": "Login not found or password incorrect. They are case sensitive."
}

{
  "command": "player_info",
  "players": [
    {
      "id": 3,
      "login": "Rhiza",
      "clan": "123",
      "country": "",
      "ratings": {
        "global": {
          "rating": [
            1650,
            62.52
          ],
          "number_of_games": 2
        },
        "ladder_1v1": {
          "rating": [
            1650,
            62.52
          ],
          "number_of_games": 2
        }
      },
      "global_rating": [
        1650,
        62.52
      ],
      "ladder_rating": [
        1650,
        62.52
      ],
      "number_of_games": 2
    }
  ]
}

{
  "command": "game_info",
  "games": [
    {
      "command": "game_info",
      "visibility": "public",
      "password_protected": false,
      "uid": 42,
      "title": "Test Game",
      "state": "open",
      "game_type": "custom",
      "featured_mod": "faf",
      "sim_mods": {},
      "mapname": "scmp_007",
      "map_file_path": "maps/scmp_007.zip",
      "host": "test",
      "num_players": 1,
      "max_players": 12,
      "hosted_at": "2023-01-01T12:00:00+00:00",
      "launched_at": null,
      "rating_type": "global",
      "rating_min": null,
      "rating_max": null,
      "enforce_rating_range": false,
      "teams_ids": [
        {
          "team_id": 2,
          "player_ids": [
            1
          ]
        }
      ],
      "teams": {
        "2": [
          "test"
        ]
      }
    }
  ]
}

{
  "command": "social",
  "autojoin": [
    "#123_clan"
  ],
  "channels": [
    "#123_clan"
  ],
  "friends": [],
  "foes": [
    400
  ],
  "power": 2
}

{
  "command": "game_launch",
  "args": [
    "/numgames",
    5
  ],
  "uid": 42,
  "mod": "faf",
  "name": "Test Game Name",
  "init_mode": 0,
  "game_type": "custom",
  "rating_type": "global"
}

{
  "command": "game_launch",
  "args": [
    "/numgames",
    0
  ],
  "uid": 41956,
  "mod": "ladder1v1",
  "name": "ladder1 Vs ladder2",
  "init_mode": 1,
  "game_type": "matchmaker",
  "rating_type": "ladder_1v1",
  "team": 2,
  "faction": 1,
  "expected_players": 2,
  "map_position": 1,
  "mapname": "scmp_015",
  "map_pool_map_version_id": 1
}

{
  "command": "game_join_failed",
  "reason": "host_left_game",
  "uid": 42
}

{
  "command": "game_join_failed",
  "reason": "bad_password",
  "uid": 42
}

{
  "command": "matchmaker_info",
  "queues": [
    {
      "queue_name": "ladder1v1",
      "queue_pop_time": "2023-01-01T12:02:00+00:00",
      "queue_pop_time_delta": 90.5,
      "num_players": 12,
      "team_size": 1,
      "boundary_80s": [
        [
          800,
          1200
        ]
      ],
      "boundary_75s": [
        [
          700,
          1300
        ]
      ]
    }
  ]
}

{
  "command": "search_info",
  "queue_name": "ladder1v1",
  "state": "start"
}

{
  "command": "search_info",
  "queue_name": "ladder1v1",
  "state": "stop"
}

{
  "command": "search_timeout",
  "timeouts": [
    {
      "player": 123,
      "expires_at": "2022-02-05T00:10:00+00:00"
    }
  ]
}

{
  "command": "search_violation",
  "count": 1,
  "time": "2022-02-05T00:00:00+00:00"
}

{
  "command": "match_found",
  "queue_name": "ladder1v1"
}

{
  "command": "match_cancelled",
  "game_id": 41956
}

{
  "command": "update_party",
  "owner": 1,
  "members": [
    {
      "player": 1,
      "factions": [
        "uef"
      ]
    },
    {
      "player": 3,
      "factions": [
        "uef",
        "aeon",
        "cybran",
        "seraphim"
      ]
    }
  ]
}

{
  "command": "party_invite",
  "sender": 1
}

{
  "command": "kicked_from_party"
}

{
  "command": "vetoes_info",
  "forced": false,
  "vetoes": [
    {
      "map_pool_map_version_id": 15,
      "veto_tokens_applied": 1,
      "matchmaker_queue_map_pool_id": 3
    }
  ]
}

{
  "command": "coop_info",
  "uid": 1,
  "type": "FA Campaign",
  "name": "FA Campaign map",
  "description": "A map from the FA campaign",
  "filename": "maps/scmp_coop_123.v0002.zip",
  "featured_mod": "coop"
}

{
  "command": "avatar",
  "avatarlist": [
    {
      "url": "https://content.faforever.com/faf/avatars/UEF.png",
      "tooltip": "UEF"
    },
    {
      "url": "https://content.faforever.com/faf/avatars/Aeon.png",
      "tooltip": "Aeon"
    }
  ]
}