Documentation

UserInfo

Retrieves the relevant details for a specified user, which the external match-making service can then use to compute effective matches

Request Details

UserInfoRequest
Request Properties
MinCatalogVersion (required) int32

Minimum catalog version for which data is requested (filters the results to only contain inventory items which have a catalog version of this or higher).

PlayFabId (required) String

PlayFab unique identifier of the user whose information is being requested.

POST https://{{TitleID}}.playfabapi.com/Matchmaker/UserInfo
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "PlayFabId": "23990802934",
  "MinCatalogVersion": 4
}
        

Response Details

UserInfoResponse
Result Properties
Inventory List<ItemInstance>

Array of inventory items in the user's current inventory.

IsDeveloper (required) Boolean

Boolean indicating whether the user is a developer.

PlayFabId String

PlayFab unique identifier of the user whose information was requested.

SteamId String

Steam unique identifier, if the user has an associated Steam account.

TitleDisplayName String

Title specific display name, if set.

Username String

PlayFab unique user name.

VirtualCurrency Dict<String, int32>

Array of virtual currency balance(s) belonging to the user.

VirtualCurrencyRechargeTimes Dict<String, VirtualCurrencyRechargeTime>

Array of remaining times and timestamps for virtual currencies.

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
  "code": 200,
  "status": "OK",
  "data": {
    "PlayFabId": "23990802934",
    "Username": "username",
    "TitleDisplayName": "titlespecificdisplayname",
    "Inventory": [
      {
        "ItemId": "shield_level_5",
        "ItemInstanceId": "9879843",
        "ItemClass": "shields",
        "CatalogVersion": "5",
        "UnitPrice": 0
      },
      {
        "ItemId": "energy_boost_1",
        "ItemInstanceId": "3854637",
        "ItemClass": "boosts",
        "RemainingUses": 4,
        "CatalogVersion": "5",
        "UnitPrice": 0
      }
    ],
    "VirtualCurrency": {
      "GC": 1500,
      "ZZ": 225
    },
    "VirtualCurrencyRechargeTimes": {
      "GC": {
        "SecondsToRecharge": 3600,
        "RechargeTime": "2014-01-01T12:00:00Z",
        "RechargeMax": 50
      }
    },
    "IsDeveloper": false,
    "SteamId": "1234"
  }
}

Authentication

SecretKey

Possible Error Codes

Name Code
InvalidParams 1000