PlayFab

PlayFab is Microsoft Azure's backend-as-a-service for live games. PlayFab exposes a large REST API surface (Client, Server, Admin, Authentication, CloudScript, Multiplayer, Economy v2, Matchmaking, Insights, Groups, Data, Profiles, Events, Localization) plus first-party SDKs for Unity, Unreal, Cocos, Phaser, JavaScript, C++, C#, Java, Lua, Objective-C, and Python. Every PlayFab game (a "title") gets its own scoped subdomain at https://[titleId].playfabapi.com. Sessions, identity, progression, inventory, leaderboards, segmentation, A/B testing, push, scheduled tasks, CloudScript (Azure Functions), and PlayFab Multiplayer Servers all run on this surface. PlayFab is operated as part of Azure Gaming and the documentation lives at learn.microsoft.com/en-us/gaming/playfab.

14 APIs 0 Features

AuthenticationAzureBackendBaaSCloudScriptEconomyGame BackendGame DevelopmentGamesLeaderboardsMatchmakingMicrosoftMultiplayerPlayFabREST

APIs

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 ...

PlayFab Server API

The PlayFab Server API is the server-trusted REST surface for custom game servers and trusted backends. It mirrors much of the Client API but operates with the title's developer...

PlayFab Admin API

The PlayFab Admin API is the privileged REST surface for studio and ops tooling. It covers title configuration, virtual currency catalogs, catalog items, store configuration, co...

PlayFab Authentication API

The PlayFab Authentication API issues and validates entity tokens used by the Entity Programming Model that underlies CloudScript using Azure Functions, Groups, Data, Profiles, ...

PlayFab CloudScript API

PlayFab CloudScript runs server-authoritative game logic in PlayFab. Modern CloudScript using Azure Functions registers Azure Function endpoints that can be invoked from clients...

PlayFab Multiplayer API

The PlayFab Multiplayer API powers PlayFab Multiplayer Servers (managed game server hosting on Azure), Party (low-latency voice and data networking), Lobby, and matchmaking serv...

PlayFab Matchmaking API

The PlayFab Matchmaking API exposes ticket-based matchmaking, queue management, match results, and matchmaking rule configuration on top of PlayFab Multiplayer.

PlayFab Economy (Catalog / Inventory) API

PlayFab Economy v2 is the modern catalog, inventory, store, and virtual-currency surface. It covers catalog item authoring, inventory transactions, transactional and subscriptio...

PlayFab Data API

The PlayFab Data API stores arbitrary file and object data attached to any entity (player, title, character, group). It exposes GetFiles, GetObjects, InitiateFileUploads, AbortF...

PlayFab Groups API

The PlayFab Groups API supports guilds, clans, parties, and other player-managed organizations on the Entity model with roles, memberships, applications, and invitations.

PlayFab Profiles API

The PlayFab Profiles API reads and writes Entity Profiles, including display name, language, lineage, and per-entity policies (ACLs) used across the Entity-model APIs.

PlayFab Events API

The PlayFab Events API writes PlayStream and custom telemetry events into PlayFab's pipeline for downstream segmentation, rules, and Insights analytics.

PlayFab Insights API

PlayFab Insights is the managed analytics surface (built on Azure Data Explorer / Kusto) for querying telemetry generated by PlayFab titles. The Insights API manages Insights pe...

PlayFab Localization API

The PlayFab Localization API returns the set of languages supported by the title and is used by clients to negotiate locale.

Collections

PlayFab Client API

OPEN

GraphQL

Azure PlayFab GraphQL Schema

This conceptual GraphQL schema models the Azure PlayFab game backend REST API surface across all major service areas: Client, Server, Admin, Authentication, CloudScript, Multipl...

GRAPHQL

Pricing Plans

Playfab Plans Pricing

1 plans

PLANS

Rate Limits

Playfab Rate Limits

2 limits

RATE LIMITS

FinOps

Playfab Finops

FINOPS

Resources

DomainSecurity

Authentication

Documentation

APIReference

GettingStarted

ReleaseNotes

GitHubOrganization

GitHubOrganization

TermsOfService

PrivacyPolicy

Sources

opencollection: 1.0.0
info:
  name: PlayFab Client API
  version: 1.0.0
request:
  auth:
    type: apikey
    key: X-Authorization
    value: '{{X-Authorization}}'
    placement: header
items:
- info:
    name: Authentication
    type: folder
  items:
  - info:
      name: Sign in with a PlayFab username and password
      type: http
    http:
      method: POST
      url: https://{titleId}.playfabapi.com/Client/LoginWithPlayFab
      body:
        type: json
        data: '{}'
    docs: Sign in with a PlayFab username and password
  - info:
      name: Sign in with an email address and password
      type: http
    http:
      method: POST
      url: https://{titleId}.playfabapi.com/Client/LoginWithEmailAddress
      body:
        type: json
        data: '{}'
    docs: Sign in with an email address and password
  - info:
      name: Sign in with a developer-supplied custom identifier
      type: http
    http:
      method: POST
      url: https://{titleId}.playfabapi.com/Client/LoginWithCustomID
      body:
        type: json
        data: '{}'
    docs: Sign in with a developer-supplied custom identifier
  - info:
      name: Sign in with an Android device identifier
      type: http
    http:
      method: POST
      url: https://{titleId}.playfabapi.com/Client/LoginWithAndroidDeviceID
      body:
        type: json
        data: '{}'
    docs: Sign in with an Android device identifier
  - info:
      name: Sign in with an iOS device identifier
      type: http
    http:
      method: POST
      url: https://{titleId}.playfabapi.com/Client/LoginWithIOSDeviceID
      body:
        type: json
        data: '{}'
    docs: Sign in with an iOS device identifier
  - info:
      name: Sign in with a Sign in with Apple identity token
      type: http
    http:
      method: POST
      url: https://{titleId}.playfabapi.com/Client/LoginWithApple
      body:
        type: json
        data: '{}'
    docs: Sign in with a Sign in with Apple identity token
  - info:
      name: Sign in with Google account credentials
      type: http
    http:
      method: POST
      url: https://{titleId}.playfabapi.com/Client/LoginWithGoogleAccount
      body:
        type: json
        data: '{}'
    docs: Sign in with Google account credentials
  - info:
      name: Sign in with a Steam authentication ticket
      type: http
    http:
      method: POST
      url: https://{titleId}.playfabapi.com/Client/LoginWithSteam
      body:
        type: json
        data: '{}'
    docs: Sign in with a Steam authentication ticket
  - info:
      name: Sign in with an Xbox Live token
      type: http
    http:
      method: POST
      url: https://{titleId}.playfabapi.com/Client/LoginWithXbox
      body:
        type: json
        data: '{}'
    docs: Sign in with an Xbox Live token
  - info:
      name: Register a new PlayFab user account
      type: http
    http:
      method: POST
      url: https://{titleId}.playfabapi.com/Client/RegisterPlayFabUser
      body:
        type: json
        data: '{}'
    docs: Register a new PlayFab user account
- info:
    name: Account
    type: folder
  items:
  - info:
      name: Returns the title's RSA public key
      type: http
    http:
      method: POST
      url: https://{titleId}.playfabapi.com/Client/GetTitlePublicKey
      body:
        type: json
        data: '{}'
    docs: Returns the title's RSA public key
  - info:
      name: Get a Photon custom authentication token
      type: http
    http:
      method: POST
      url: https://{titleId}.playfabapi.com/Client/GetPhotonAuthenticationToken
      body:
        type: json
        data: '{}'
    docs: Get a Photon custom authentication token
  - info:
      name: Set the player's secret used to sign API requests
      type: http
    http:
      method: POST
      url: https://{titleId}.playfabapi.com/Client/SetPlayerSecret
      body:
        type: json
        data: '{}'
    docs: Set the player's secret used to sign API requests
bundled: true