Matchmaking - Get Current Games

Get details about all current running game servers matching the given parameters.

POST https://titleId.playfabapi.com/Client/GetCurrentGames

Request Header

Name Required Type Description
SessionTicket True
  • string

This API requires a client session ticket, available from any Client Login function.

Request Body

Name Type Description
BuildVersion
  • string

Build to match against.

GameMode
  • string

Game mode to look for.

Region

Region to check for Game Server Instances.

StatisticName
  • string

Statistic name to find statistic-based matches.

TagFilter

Filter to include and/or exclude Game Server Instances associated with certain tags.

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer wrapper for all responses with errors

Security

SessionTicket

This API requires a client session ticket, available from any Client Login function.

Type: apiKey
In: header

Definitions

ApiErrorWrapper

The basic wrapper around every failed API response

CollectionFilter

Collection filter to include and/or exclude collections with certain key-value pairs. The filter generates a collection set defined by Includes rules and then remove collections that matches the Excludes rules. A collection is considered matching a rule if the rule describes a subset of the collection.

Container_Dictionary_String_String

A data container

CurrentGamesRequest
CurrentGamesResult
GameInfo
GameInstanceState
Region

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code
  • integer

Numerical HTTP code

error
  • string

Playfab error code

errorCode
  • integer

Numerical PlayFab error code

errorDetails
  • object

Detailed description of individual issues with the request object

errorMessage
  • string

Description for the PlayFab errorCode

status
  • string

String HTTP code

CollectionFilter

Collection filter to include and/or exclude collections with certain key-value pairs. The filter generates a collection set defined by Includes rules and then remove collections that matches the Excludes rules. A collection is considered matching a rule if the rule describes a subset of the collection.

Name Type Description
Excludes

List of Exclude rules, with any of which if a collection matches, it is excluded by the filter.

Includes

List of Include rules, with any of which if a collection matches, it is included by the filter, unless it is excluded by one of the Exclude rule

Container_Dictionary_String_String

A data container

Name Type Description
Data
  • object

Content of data

CurrentGamesRequest

Name Type Description
BuildVersion
  • string

Build to match against.

GameMode
  • string

Game mode to look for.

Region

Region to check for Game Server Instances.

StatisticName
  • string

Statistic name to find statistic-based matches.

TagFilter

Filter to include and/or exclude Game Server Instances associated with certain tags.

CurrentGamesResult

Name Type Description
GameCount
  • number

number of games running

Games

array of games found

PlayerCount
  • number

total number of players across all servers

GameInfo

Name Type Description
BuildVersion
  • string

build version this server is running

GameMode
  • string

game mode this server is running

GameServerData
  • string

game session custom data

GameServerStateEnum

game specific string denoting server configuration

LastHeartbeat
  • string

last heartbeat of the game server instance, used in external game server provider mode

LobbyID
  • string

unique lobby identifier for this game server

MaxPlayers
  • number

maximum players this server can support

PlayerUserIds
  • string[]

array of current player IDs on this server

Region

region to which this server is associated

RunTime
  • number

duration in seconds this server has been running

ServerIPV4Address
  • string

IPV4 address of the server

ServerIPV6Address
  • string

IPV6 address of the server

ServerPort
  • number

port number to use for non-http communications with the server

ServerPublicDNSName
  • string

Public DNS name (if any) of the server

StatisticName
  • string

stastic used to match this game in player statistic matchmaking

Tags
  • object

game session tags

GameInstanceState

Name Type Description
Closed
  • string
Open
  • string

Region

Name Type Description
Australia
  • string
Brazil
  • string
EUWest
  • string
Japan
  • string
Singapore
  • string
USCentral
  • string
USEast
  • string