Overview
API requests related to character-level actions, including inventory, groups, friends, and statistics.
OperationCode
| Name | Code | Description |
|---|---|---|
| Add Player Friend | addPlayerFriend | Send a friend request from one character to another. |
| Add Segment | addSegment | Tag a character with a specific segment for segmentation or personalization. |
| Change Player Currency | changePlayerCurrency | Adjust the amount of one or more currencies associated with a character. |
| Change Player Statistics | changePlayerStatistics | Update statistical values such as score, experience, or level for a character. |
| Create Group | createGroup | Initialize a new group and assign the character as the group leader or owner. |
| Create Player Item | createPlayerItem | Generate a new item and add it to the character’s inventory. |
| Get Avatar | getAvatar | Fetch the avatar image or configuration currently assigned to the character. |
| Get Catalog Id | getCatalogId | Retrieve the catalog identifier assigned to a specific character. |
| Get Country Code | getCountryCode | Determine the country code associated with the character, typically based on IP. |
| Get Create Leaderboard | getCreateLeaderboard | Return leaderboard entries created by characters, including custom info if requested. |
| Get Currency Leaderboard | getCurrencyLeaderboard | Perform the GetCurrencyLeaderboard operation. |
| Get Currency Log | getCurrencyLog | Perform the GetCurrencyLog operation. |
| Get Custom Data | getCustomData | Perform the GetCustomData operation. |
| Get Display Name | getDisplayName | Perform the GetDisplayName operation. |
| Get Friend Statistics Leaderboard Around Player | getFriendStatisticsLeaderboardAroundPlayer | Perform the GetFriendStatisticsLeaderboardAroundPlayer operation. |
| Get Friend Statistics Leaderboard | getFriendStatisticsLeaderboard | Perform the GetFriendStatisticsLeaderboard operation. |
| Get Ip Address Create | getIpAddressCreate | Perform the GetIpAddressCreate operation. |
| Get Last Login Leaderboard | getLastLoginLeaderboard | Perform the GetLastLoginLeaderboard operation. |
| Get Owner | getOwner | Perform the GetOwner operation. |
| Get Player Ban | getPlayerBan | Perform the GetPlayerBan operation. |
| Get Player Currency | getPlayerCurrency | Perform the GetPlayerCurrency operation. |
| Get Player Data | getPlayerData | Perform the GetPlayerData operation. |
| Get Player Friend | getPlayerFriend | Perform the GetPlayerFriend operation. |
| Get Player Group | getPlayerGroup | Perform the GetPlayerGroup operation. |
| Get Player Information | getPlayerInformation | Perform the GetPlayerInformation operation. |
| Get Player Inventory | getPlayerInventory | Perform the GetPlayerInventory operation. |
| Get Player Statistics | getPlayerStatistics | Perform the GetPlayerStatistics operation. |
| Get Players With Display Name | getPlayersWithDisplayName | Perform the GetPlayersWithDisplayName operation. |
| Get Players With Segment | getPlayersWithSegment | Perform the GetPlayersWithSegment operation. |
| Get Players With Tag | getPlayersWithTag | Perform the GetPlayersWithTag operation. |
| Get Remove Status | getRemoveStatus | Perform the GetRemoveStatus operation. |
| Get Segment | getSegment | Perform the GetSegment operation. |
| Get Statistics Leaderboard Around Player | getStatisticsLeaderboardAroundPlayer | Perform the GetStatisticsLeaderboardAroundPlayer operation. |
| Get Statistics Leaderboard | getStatisticsLeaderboard | Perform the GetStatisticsLeaderboard operation. |
| Get Statistics Log | getStatisticsLog | Perform the GetStatisticsLog operation. |
| Get Tag | getTag | Perform the GetTag operation. |
| Get Ts Create | getTsCreate | Perform the GetTsCreate operation. |
| Get Ts Last Login | getTsLastLogin | Perform the GetTsLastLogin operation. |
| Join Group | joinGroup | Perform the JoinGroup operation. |
| Leave Group | leaveGroup | Perform the LeaveGroup operation. |
| Remove Player Friend | removePlayerFriend | Perform the RemovePlayerFriend operation. |
| Remove Player Item | removePlayerItem | Perform the RemovePlayerItem operation. |
| Remove Segment | removeSegment | Perform the RemoveSegment operation. |
| Remove Tag | removeTag | Perform the RemoveTag operation. |
| Set Avatar | setAvatar | Perform the SetAvatar operation. |
| Set Country Code | setCountryCode | Perform the SetCountryCode operation. |
| Set Custom Data | setCustomData | Perform the SetCustomData operation. |
| Set Display Name | setDisplayName | Perform the SetDisplayName operation. |
| Set Owner | setOwner | Perform the SetOwner operation. |
| Set Player Ban | setPlayerBan | Perform the SetPlayerBan operation. |
| Set Player Data | setPlayerData | Perform the SetPlayerData operation. |
| Set Remove Status | setRemoveStatus | Perform the SetRemoveStatus operation. |
| Set Tag | setTag | Perform the SetTag operation. |