Get Transaction History

Get transaction history for a player. Up to 50 Events can be returned at once (or 250 with response compression enabled). You can use continuation tokens to paginate through results that return greater than the limit. Getting transaction history has a lower RPS limit than getting a Player’s inventory with Player Entities having a limit of 30 requests in 300 seconds.

Allowed entity token types: title, master_player_account, title_player_account

POST

Inventory

GetTransactionHistory

Get Transaction History

curl --request POST \
  --url https://{titleId}.playfabapi.com/Inventory/GetTransactionHistory \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "Count": 10,
  "CollectionId": "default"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Inventory/GetTransactionHistory"

payload = {
    "Count": 10,
    "CollectionId": "default"
}
headers = {
    "X-EntityToken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Count: 10, CollectionId: 'default'})
};

fetch('https://{titleId}.playfabapi.com/Inventory/GetTransactionHistory', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Inventory/GetTransactionHistory",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Count' => 10,
    'CollectionId' => 'default'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-EntityToken: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Inventory/GetTransactionHistory"

	payload := strings.NewReader("{\n  \"Count\": 10,\n  \"CollectionId\": \"default\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-EntityToken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Inventory/GetTransactionHistory")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Count\": 10,\n  \"CollectionId\": \"default\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Inventory/GetTransactionHistory")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Count\": 10,\n  \"CollectionId\": \"default\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "Transactions": [
      {
        "TransactionId": "1",
        "ItemType": "catalogItem",
        "OperationType": "Add",
        "ApiName": "AddInventoryItems"
      },
      {
        "TransactionId": "2",
        "ItemType": "catalogItem",
        "OperationType": "Add",
        "ApiName": "AddInventoryItems"
      }
    ]
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

Authorizations

X-EntityToken

string

header

required

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Body

application/json

Get transaction history for specified entity and collection.

Count

number

required

Number of items to retrieve. This value is optional. The default value is 10. The maximum value is 50, or 250 if response compression is enabled.

CollectionId

string

The id of the entity's collection to perform this action on. (Default="default")

ContinuationToken

string

An opaque token used to retrieve the next page of items, if any are available. Should be null on initial request.

CustomTags

object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Entity

object

The entity to perform this action on.

Show child attributes

Filter

string

An OData filter used to refine the TransactionHistory. Transaction properties 'timestamp', 'transactionid', 'apiname' and 'operationtype' can be used in the filter. Properties 'transactionid', 'apiname', and 'operationtype' cannot be used together in a single request. The 'timestamp' property can be combined with 'apiname' or 'operationtype' in a single request. For example: "timestamp ge 2023-06-20T23:30Z" or "transactionid eq '10'" or "(timestamp ge 2023-06-20T23:30Z) and (apiname eq 'AddInventoryItems')". By default, a 6 month timespan from the current date is used.

OrderBy

string

An OData orderby to order TransactionHistory results. The only supported values are 'timestamp asc' or 'timestamp desc'. Default orderby is 'timestamp asc'

Response

code

integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status

string

The Http status code as a string.

data

object

Show child attributes

Example:

{
  "Transactions": [
    {
      "TransactionId": "1",
      "ItemType": "catalogItem",
      "OperationType": "Add",
      "ApiName": "AddInventoryItems"
    },
    {
      "TransactionId": "2",
      "ItemType": "catalogItem",
      "OperationType": "Add",
      "ApiName": "AddInventoryItems"
    }
  ]
}

Last modified on October 1, 2026

⌘I

Get Transaction History

curl --request POST \
  --url https://{titleId}.playfabapi.com/Inventory/GetTransactionHistory \
  --header 'Content-Type: application/json' \
  --header 'X-EntityToken: <api-key>' \
  --data '
{
  "Count": 10,
  "CollectionId": "default"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Inventory/GetTransactionHistory"

payload = {
    "Count": 10,
    "CollectionId": "default"
}
headers = {
    "X-EntityToken": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-EntityToken': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Count: 10, CollectionId: 'default'})
};

fetch('https://{titleId}.playfabapi.com/Inventory/GetTransactionHistory', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Inventory/GetTransactionHistory",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Count' => 10,
    'CollectionId' => 'default'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-EntityToken: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Inventory/GetTransactionHistory"

	payload := strings.NewReader("{\n  \"Count\": 10,\n  \"CollectionId\": \"default\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-EntityToken", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Inventory/GetTransactionHistory")
  .header("X-EntityToken", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Count\": 10,\n  \"CollectionId\": \"default\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Inventory/GetTransactionHistory")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-EntityToken"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Count\": 10,\n  \"CollectionId\": \"default\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": 200,
  "status": "OK",
  "data": {
    "Transactions": [
      {
        "TransactionId": "1",
        "ItemType": "catalogItem",
        "OperationType": "Add",
        "ApiName": "AddInventoryItems"
      },
      {
        "TransactionId": "2",
        "ItemType": "catalogItem",
        "OperationType": "Add",
        "ApiName": "AddInventoryItems"
      }
    ]
  }
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

Get Transaction History

Authorizations

Body

Response