PlayFab

PlayFab Client API

The PlayFab Client API is the player-facing REST surface used by game clients for login, account linking, virtual currency, inventory, friends, leaderboards, statistics, player data, cloud script execution, multiplayer session lookup, push registration, segmentation triggers, and analytics events. It is scoped per-title at https://[titleId].playfabapi.com/Client and authenticated with a session ticket issued from a Login* call.

GitHub OpenAPI

Operations 174

POST /Client/AcceptTrade #
POST /Client/AddFriend #
POST /Client/AddGenericID #
POST /Client/AddOrUpdateContactEmail #
POST /Client/AddSharedGroupMembers #
POST /Client/AddUsernamePassword #
POST /Client/AddUserVirtualCurrency #
POST /Client/AndroidDevicePushNotificationRegistration #
POST /Client/AttributeInstall #
POST /Client/CancelTrade #
POST /Client/ConfirmPurchase #
POST /Client/ConsumeItem #
POST /Client/ConsumeMicrosoftStoreEntitlements #
POST /Client/ConsumePS5Entitlements #
POST /Client/ConsumePSNEntitlements #
POST /Client/ConsumeXboxEntitlements #
POST /Client/CreateSharedGroup #
POST /Client/DeletePlayerCustomProperties #
POST /Client/ExecuteCloudScript #
POST /Client/GetAccountInfo #
POST /Client/GetAdPlacements #
POST /Client/GetAllUsersCharacters #
POST /Client/GetCatalogItems #
POST /Client/GetCharacterData #
POST /Client/GetCharacterInventory #
POST /Client/GetCharacterLeaderboard #
POST /Client/GetCharacterReadOnlyData #
POST /Client/GetCharacterStatistics #
POST /Client/GetContentDownloadUrl #
POST /Client/GetFriendLeaderboard #
POST /Client/GetFriendLeaderboardAroundPlayer #
POST /Client/GetFriendsList #
POST /Client/GetLeaderboard #
POST /Client/GetLeaderboardAroundCharacter #
POST /Client/GetLeaderboardAroundPlayer #
POST /Client/GetLeaderboardForUserCharacters #
POST /Client/GetPaymentToken #
POST /Client/GetPhotonAuthenticationToken #
POST /Client/GetPlayerCombinedInfo #
POST /Client/GetPlayerCustomProperty #
POST /Client/GetPlayerProfile #
POST /Client/GetPlayerSegments #
POST /Client/GetPlayerStatistics #
POST /Client/GetPlayerStatisticVersions #
POST /Client/GetPlayerTags #
POST /Client/GetPlayerTrades #
POST /Client/GetPlayFabIDsFromBattleNetAccountIds #
POST /Client/GetPlayFabIDsFromFacebookIDs #
POST /Client/GetPlayFabIDsFromFacebookInstantGamesIds #
POST /Client/GetPlayFabIDsFromGameCenterIDs #
POST /Client/GetPlayFabIDsFromGenericIDs #
POST /Client/GetPlayFabIDsFromGoogleIDs #
POST /Client/GetPlayFabIDsFromGooglePlayGamesPlayerIDs #
POST /Client/GetPlayFabIDsFromKongregateIDs #
POST /Client/GetPlayFabIDsFromNintendoServiceAccountIds #
POST /Client/GetPlayFabIDsFromNintendoSwitchDeviceIds #
POST /Client/GetPlayFabIDsFromOpenIdSubjectIdentifiers #
POST /Client/GetPlayFabIDsFromPSNAccountIDs #
POST /Client/GetPlayFabIDsFromPSNOnlineIDs #
POST /Client/GetPlayFabIDsFromSteamIDs #
POST /Client/GetPlayFabIDsFromSteamNames #
POST /Client/GetPlayFabIDsFromTwitchIDs #
POST /Client/GetPlayFabIDsFromXboxLiveIDs #
POST /Client/GetPublisherData #
POST /Client/GetPurchase #
POST /Client/GetSharedGroupData #
POST /Client/GetStoreItems #
POST /Client/GetTime #
POST /Client/GetTitleData #
POST /Client/GetTitleNews #
POST /Client/GetTitlePublicKey #
POST /Client/GetTradeStatus #
POST /Client/GetUserData #
POST /Client/GetUserInventory #
POST /Client/GetUserPublisherData #
POST /Client/GetUserPublisherReadOnlyData #
POST /Client/GetUserReadOnlyData #
POST /Client/GrantCharacterToUser #
POST /Client/LinkAndroidDeviceID #
POST /Client/LinkApple #
POST /Client/LinkBattleNetAccount #
POST /Client/LinkCustomID #
POST /Client/LinkFacebookAccount #
POST /Client/LinkFacebookInstantGamesId #
POST /Client/LinkGameCenterAccount #
POST /Client/LinkGoogleAccount #
POST /Client/LinkGooglePlayGamesServicesAccount #
POST /Client/LinkIOSDeviceID #
POST /Client/LinkKongregate #
POST /Client/LinkNintendoServiceAccount #
POST /Client/LinkNintendoSwitchDeviceId #
POST /Client/LinkOpenIdConnect #
POST /Client/LinkPSNAccount #
POST /Client/LinkSteamAccount #
POST /Client/LinkTwitch #
POST /Client/LinkXboxAccount #
POST /Client/ListPlayerCustomProperties #
POST /Client/LoginWithAndroidDeviceID #
POST /Client/LoginWithApple #
POST /Client/LoginWithBattleNet #
POST /Client/LoginWithCustomID #
POST /Client/LoginWithEmailAddress #
POST /Client/LoginWithFacebook #
POST /Client/LoginWithFacebookInstantGamesId #
POST /Client/LoginWithGameCenter #
POST /Client/LoginWithGoogleAccount #
POST /Client/LoginWithGooglePlayGamesServices #
POST /Client/LoginWithIOSDeviceID #
POST /Client/LoginWithKongregate #
POST /Client/LoginWithNintendoServiceAccount #
POST /Client/LoginWithNintendoSwitchDeviceId #
POST /Client/LoginWithOpenIdConnect #
POST /Client/LoginWithPlayFab #
POST /Client/LoginWithPSN #
POST /Client/LoginWithSteam #
POST /Client/LoginWithTwitch #
POST /Client/LoginWithXbox #
POST /Client/OpenTrade #
POST /Client/PayForPurchase #
POST /Client/PurchaseItem #
POST /Client/RedeemCoupon #
POST /Client/RefreshPSNAuthToken #
POST /Client/RegisterForIOSPushNotification #
POST /Client/RegisterPlayFabUser #
POST /Client/RemoveContactEmail #
POST /Client/RemoveFriend #
POST /Client/RemoveGenericID #
POST /Client/RemoveSharedGroupMembers #
POST /Client/ReportAdActivity #
POST /Client/ReportDeviceInfo #
POST /Client/ReportPlayer #
POST /Client/RestoreIOSPurchases #
POST /Client/RewardAdActivity #
POST /Client/SendAccountRecoveryEmail #
POST /Client/SetFriendTags #
POST /Client/SetPlayerSecret #
POST /Client/StartPurchase #
POST /Client/SubtractUserVirtualCurrency #
POST /Client/UnlinkAndroidDeviceID #
POST /Client/UnlinkApple #
POST /Client/UnlinkBattleNetAccount #
POST /Client/UnlinkCustomID #
POST /Client/UnlinkFacebookAccount #
POST /Client/UnlinkFacebookInstantGamesId #
POST /Client/UnlinkGameCenterAccount #
POST /Client/UnlinkGoogleAccount #
POST /Client/UnlinkGooglePlayGamesServicesAccount #
POST /Client/UnlinkIOSDeviceID #
POST /Client/UnlinkKongregate #
POST /Client/UnlinkNintendoServiceAccount #
POST /Client/UnlinkNintendoSwitchDeviceId #
POST /Client/UnlinkOpenIdConnect #
POST /Client/UnlinkPSNAccount #
POST /Client/UnlinkSteamAccount #
POST /Client/UnlinkTwitch #
POST /Client/UnlinkXboxAccount #
POST /Client/UnlockContainerInstance #
POST /Client/UnlockContainerItem #
POST /Client/UpdateAvatarUrl #
POST /Client/UpdateCharacterData #
POST /Client/UpdateCharacterStatistics #
POST /Client/UpdatePlayerCustomProperties #
POST /Client/UpdatePlayerStatistics #
POST /Client/UpdateSharedGroupData #
POST /Client/UpdateUserData #
POST /Client/UpdateUserPublisherData #
POST /Client/UpdateUserTitleDisplayName #
POST /Client/ValidateAmazonIAPReceipt #
POST /Client/ValidateGooglePlayPurchase #
POST /Client/ValidateIOSReceipt #
POST /Client/ValidateWindowsStoreReceipt #
POST /Client/WriteCharacterEvent #
POST /Client/WritePlayerEvent #
POST /Client/WriteTitleEvent #

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/rest/api/playfab/client/
📖
Authentication
https://learn.microsoft.com/en-us/gaming/playfab/sdks/playfab-authentication

Specifications

⚙
OpenAPI
https://artifacts.apis.io/playfab/openapi/playfab-client-openapi.yml
⚙
OpenAPI
https://raw.githubusercontent.com/PlayFab/API_Specs/master/Swagger/PlayFab/Client.swagger.json

Other Resources

🔗
APIsJSON
https://artifacts.apis.io/playfab/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/playfab:playfab-client-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

playfab-client-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  version: '260922'
  title: PlayFab Client API
  description: APIs which provide the full range of PlayFab features available to the client - authentication, account and data management, inventory,
    friends, matchmaking, reporting, and platform-specific functionality
  termsOfService: https://playfab.com/terms/
  contact:
    url: https://community.playfab.com/index.html
  license:
    name: Apache 2.0
    url: https://github.com/PlayFab/API_Specs/blob/master/LICENSE
servers:
- url: https://{titleId}.playfabapi.com
  variables:
    titleId:
      default: titleId
      description: Unique PlayFab title identifier.
tags:
- name: Account Management
  description: Account Management APIs
- name: Advertising
  description: Advertising APIs
- name: Analytics
  description: Analytics APIs
- name: Authentication
  description: Authentication APIs
- name: Character Data
  description: Character Data APIs
- name: Characters
  description: Characters APIs
- name: Content
  description: Content Service APIs
- name: Friend List Management
  description: Friend List Management APIs
- name: Matchmaking
  description: Matchmaking APIs
- name: Platform Specific Methods
  description: Platform Specific Methods APIs
- name: Player Data Management
  description: Player Data Management APIs
- name: Player Item Management
  description: Player Item Management APIs
- name: PlayStream
  description: PlayStream Management APIs
- name: Server-Side Cloud Script
  description: Server-Side Cloud Script APIs
- name: Shared Group Data
  description: Shared Group Data APIs
- name: Title-Wide Data Management
  description: Title-Wide Data Management APIs


# --- truncated at 32 KB (556 KB total) ---
# Full source: https://artifacts.apis.io/playfab/openapi/playfab-client-openapi.yml