Note
For complete request/response schema definitions, refer to the godoc documentation instead.
Request and response bodies are example payloads, not full schemas.
Collects rewards for a completed challenge.
{
"PlayerID": "<player id>",
"ID": 3751
}{
"Result": {}
}Retrieves all available challenges for the authenticated player.
{
"Challenges": [],
"Folders": []
}{
"Result": {
"Challenges": [
{
"ID": 387,
"Title": "New Driver Challenge",
"Description": "Complete the Basic Tutorial in the Training Playlist",
"Sort": 0,
"GroupID": 8,
"XPUnlockLevel": 0,
"bIsRepeatable": false,
"RepeatLimit": 0,
"IconURL": "https://rl-cdn.psyonix.com/ChallengeIcons/Challenge_Play.jpg",
"BackgroundURL": null,
"BackgroundColor": 0,
"Requirements": [
{
"RequiredCount": 1
}
],
"Rewards": {
"XP": 0,
"Currency": [],
"Products": [
{
"ID": "861",
"ChallengeID": 387,
"ProductID": 29,
"InstanceID": null,
"Attributes": [],
"SeriesID": 861
}
],
"Pips": 0
},
"bAutoClaimRewards": false,
"bIsPremium": false,
"UnlockChallengeIDs": []
}
// ... additional challenges
]
}
}Retrieves progress information for specific challenges.
{
"PlayerID": "<player id>",
"ChallengeIDs": [387, 388, 389, 390]
}{
"Result": {
"ProgressData": [
{
"ID": 387,
"CompleteCount": 1,
"bIsHidden": false,
"bNotifyCompleted": false,
"bNotifyAvailable": false,
"bNotifyNewInfo": false,
"bRewardsAvailable": false,
"bComplete": true,
"RequirementProgress": [
{
"ProgressCount": 0,
"ProgressChange": 0
}
],
"ProgressResetTimeUTC": 0
}
// ... additional challenge progress data
]
}
}Accepts a club invitation and joins the club.
{
"ClubID": 123456
}{
"Result": {
"ClubDetails": {
// ... same structure as GetPlayerClubDetails response
}
}
}Creates a new club with specified name, tag, and colors.
{
"ClubName": "amongus",
"ClubTag": "TAG",
"PrimaryColor": 0,
"AccentColor": 0
}{
"Result": {
"ClubDetails": {
// ... same structure as GetPlayerClubDetails response
}
}
}Retrieves detailed information about a specific club by ID.
{
"ClubID": 1120447
}{
"Result": {
"ClubDetails": {
// ... same structure as GetPlayerClubDetails response
}
}
}Retrieves pending club invitations for the authenticated player.
{}{
"Result": {
"ClubInvites": []
}
}Retrieves all available club titles that can be equipped.
{}{
"Result": {
"ClubTitles": [
"Club_Supersonic_Acrobatic_Battle_Cars",
// ... additional titles
]
}
}Retrieves detailed information about the club that a specific player belongs to.
{
"PlayerID": "<player id>"
}{
"Result": {
"ClubDetails": {
"ClubID": 1120447,
"ClubName": "<club name>",
"ClubTag": "<tag>",
"PrimaryColor": 0,
"AccentColor": 0,
"EquippedTitle": "Club_Supersonic_Acrobatic_Battle_Cars",
"OwnerPlayerID": "<player id>",
"Members": [
{
"PlayerID": "<player id>",
"PlayerName": "<player name>",
"EpicPlayerID": "<player id>",
"EpicPlayerName": "<epic name>",
"RoleID": 1,
"CreatedTime": 1750299549,
"DeletedTime": 0,
"PsyonixID": null
}
// ... additional members
],
"Badges": [
{
"Stat": "Goal",
"Badge": 2
}
// ... additional badges
],
"Flags": [],
"bVerified": false,
"CreatedTime": 1750299549,
"LastUpdatedTime": 1750299580,
"NameLastUpdatedTime": 0,
"DeletedTime": 0
}
}
}Invites a player to join the club.
{
"PlayerID": "<player id>"
}{
"Result": {}
}Leaves the current club.
{}{
"Result": {}
}Rejects a club invitation.
{
"ClubID": 1120447
}{
"Result": {}
}Updates club settings like colors and other properties.
{
"PrimaryColor": -10879077,
"AccentColor": 0
}{
"Result": {
"ClubDetails": {
// ... same structure as GetPlayerClubDetails response
}
}
}Retrieves club statistics and achievements for the authenticated player's club.
{}{
"Result": {
"CareerStats": {
"TimePlayed": 181826,
"Goal": 1736,
"AerialGoal": 190,
"LongGoal": 79,
"BackwardsGoal": 9,
"OvertimeGoal": 60,
"TurtleGoal": 3,
"Assist": 931,
"Playmaker": 42,
"Save": 1564,
"EpicSave": 406,
"Savior": 144,
"Shot": 4372,
"Center": 5319,
"Clear": 3608,
"AerialHit": 5578,
"BicycleHit": 162,
"JuggleHit": 33,
"Demolish": 1048,
"Demolition": 0,
"FirstTouch": 2121,
"PoolShot": 6,
"LowFive": 20,
"HighFive": 1,
"BreakoutDamage": 0,
"BreakoutDamageLarge": 0,
"HoopsSwishGoal": 4,
"MatchPlayed": 662,
"Win": 325
},
"SeasonalStats": [
{
"Stat": "Goal",
"Milestones": [225, 675, 2025],
"Value": 1736,
"Badge": 2
}
],
"PreviousSeasonalBadges": [],
"SeasonalTitles": [
{
"Badge": 1,
"Title": "Club_S19_M1"
}
]
}
}Retrieves available trade-in categories and their eligible item series.
{}{
"Result": {
"TradeInFilters": [
{
"ID": 1,
"Label": "Core Items",
"SeriesIDs": [1, 47, 191, 207, 300, 443, 541, 542, 635, 902],
"bBlueprint": false,
"TradeInQualities": [
"Uncommon",
"Rare",
"VeryRare",
"Import",
"Exotic"
]
},
{
"ID": 2,
"Label": "Tournament Items",
"SeriesIDs": [855, 1147, 1204, 1761, 2281, 2717],
"bBlueprint": false,
"TradeInQualities": ["Uncommon", "Rare", "VeryRare", "Import", "Exotic"]
},
{
"ID": 3,
"Label": "Blueprints",
"SeriesIDs": [],
"bBlueprint": true,
"TradeInQualities": ["Rare", "VeryRare", "Import", "Exotic"]
}
]
}
}Retrieves available private matches hosted by clubs.
{}{
"Result": {
"Servers": []
}
}Retrieves ping measurements to available game server regions.
{}{
"Result": {
"Regions": [
{
"Region": "USE",
"Label": "US-East",
"SubRegions": ["USE1", "USE3"]
},
{
"Region": "EU",
"Label": "Europe",
"SubRegions": ["EU5", "EU1", "EU3", "EU7", "EU9"]
},
{
"Region": "OCE",
"Label": "Oceania",
"SubRegions": ["OCE1"]
}
// ... additional regions
]
}
}Retrieves recent match history for the authenticated player.
{
"PlayerID": "<player id>"
}{
"Result": {
"Matches": [
{
"ReplayUrl": "http://api.rlpp.psynet.gg/Match.replay?MatchGUID=...&Timestamp=...&Expiration=...&Signature=...",
"Match": {
"MatchGUID": "<guid>",
"RecordStartTimestamp": 1756529579,
"MapName": "Wasteland_P",
"Playlist": 6,
"SecondsPlayed": 14.9421,
"OvertimeSecondsPlayed": 0,
"WinningTeam": -1,
"Team0Score": 0,
"Team1Score": 0,
"bOverTime": false,
"bNoContest": false,
"bForfeit": false,
"CustomMatchCreatorPlayerID": "<player id>",
"bClubVsClub": false,
"Mutators": [""],
"Players": [
{
"PlayerID": "<player id>",
"PlayerName": "<player name>",
"ConnectTimestamp": 1756529580,
"JoinTimestamp": 1756529581,
"LeaveTimestamp": 1756529586,
"PartyLeaderID": "<player id>",
"InParty": false,
"bAbandoned": false,
"bMvp": false,
"LastTeam": 1,
"TeamColor": "Orange",
"SecondsPlayed": 0,
"Score": 0,
"Goals": 0,
"Assists": 0,
"Saves": 0,
"Shots": 0,
"Demolishes": 0,
"OwnGoals": 0,
"Skills": {
"Mu": null,
"Sigma": null,
"Division": null,
"PrevMu": null,
"PrevSigma": null,
"PrevTier": null,
"PrevDivision": null,
"bValid": false
}
}
]
}
}
]
}
}Cancels the current matchmaking search.
{}{
"Result": {}
}Searches for available private matches in a specific region and playlist.
{
"Region": "USE1",
"PlaylistID": 6
}{
"Result": {}
}Initiates matchmaking for specified playlists and regions.
{
"Regions": [
{
"Name": "USE1",
"Ping": 33
},
{
"Name": "USE3",
"Ping": 33
}
],
"Playlists": [11],
"SecondsSearching": 1,
"CurrentServerID": "",
"bDisableCrossplay": false,
"PartyID": "<party id>",
"PartyMembers": [
"<player id>"
]
}{
"Result": {
"EstimatedQueueTime": 32
}
}Retrieves available starter packs for purchase.
{
"PlayerID": "<player id>",
"Category": "StarterPack"
}{
"Result": {
"MTXProducts": [
{
"ID": 139,
"Title": "Season 19 Veteran Pack",
"Description": "LIMITED TIME",
"TabTitle": "Season 19 Veteran Pack",
"PriceDescription": "",
"ImageURL": "",
"PlatformProductID": "<product id>",
"bIsOwned": false,
"Items": [
{
"ProductID": 4284,
"InstanceID": null,
"Attributes": [
{
"Key": "Painted",
"Value": "9"
}
],
"SeriesID": 8365
}
// ... additional items
],
"Currencies": [
{
"ID": 13,
"CurrencyID": 13,
"Amount": 500
}
]
}
]
}
}Initiates a purchase transaction for catalog items.
{
"Language": "INT",
"PlayerID": "<player id>",
"CartItems": [
{
"CatalogID": 13,
"Count": 1
}
]
}Changes the owner of a party to another member.
{
"NewOwnerID": "<player id>",
"PartyID": "<party id>"
}{
"Result": {}
}Creates a new party.
{
"bForcePartyonix": true
}{
"Result": {
"PartyID": "<party id>",
"CreatedAt": 1750299549,
"CreatedByUserID": 1750299549,
"JoinID": "<join id>"
}
}Retrieves current party information and pending invitations for the authenticated player.
{}{
"Result": {
"Invites": []
}
}Joins an existing party.
{
"JoinID": "",
"PartyID": "<party id>"
}{
"Result": {
// ... same structure as CreateParty response
}
}Kicks members from a party (owner only).
{
"Members": ["<player id>"],
"KickReason": 1,
"PartyID": "<party id>"
}{
"Result": {}
}Leaves the current party.
{
"PartyID": "<party id>"
}{
"Result": {}
}Sends a text chat message to party members.
{
"Message": "amongus",
"PartyID": "<party id>"
}{
"Result": {}
}Sends a party invitation to another player.
{
"InviteeID": "<player id>",
"PartyID": "<party id>"
}{
"Result": {}
}Sends a request to join another player's party.
{
"PlayerID": "<player id>"
}{
"Result": {}
}Sends an encoded message (?) to party members.
{
"Message": "", // Base64-encoded message
"PartyID": "<party id>"
}{
"Result": {}
}Retrieves ban status information for specified players.
{
"Players": ["<player id>"]
}{
"Result": {
"BanMessages": []
}
}Retrieves the player's creator code information.
Retrieves basic profile information and presence status for multiple players. Works with any valid player ID.
{
"PlayerIDs": [
"<player id>",
// ... additional player IDs
]
}{
"Result": {
"PlayerData": [
{
"PlayerID": "<player id>",
"PlayerName": "<player name>",
"PresenceState": "Online",
"PresenceInfo": ""
}
// ... additional players
]
}
}Retrieves the authenticated player's XP level and progress information.
{
"PlayerID": "<player id>"
}{
"Result": {
"XPInfoResponse": {
"TotalXP": 12345,
"XPLevel": 123,
"XPTitle": "",
"XPProgressInCurrentLevel": 123,
"XPRequiredForNextLevel": 123
}
}
}Reports a player.
{
"Reports": [
{
"Reporter": "<player id>",
"Offender": "<player id>",
"ReasonIDs": [3],
"ReportTimeStamp": 0.0
}
],
"GameID": ""
}{
"Result": {}
}Retrieves all available playlists.
{}{
"Result": {
"CasualPlaylists": [
{
"NodeID": "OnesCasual",
"Playlist": 1,
"Type": 1,
"StartTime": null,
"EndTime": null
},
{
"NodeID": "ArcadeCasual1",
"Playlist": 50,
"Type": 3,
"StartTime": 1756310400,
"EndTime": 1757001600
}
// ... additional casual playlists
],
"RankedPlaylists": [
{
"NodeID": "OnesCompetitive",
"Playlist": 10,
"Type": 1,
"StartTime": null,
"EndTime": null
}
// ... additional ranked playlists
],
"XPLevelUnlocked": 20
}
}Retrieves current player counts across all playlists.
{}{
"Result": {
"Playlists": [
{
"Playlist": 10,
"PlayerCount": 10615
},
{
"Playlist": 11,
"PlayerCount": 90079
},
{
"Playlist": 13,
"PlayerCount": 29329
}
// ... additional playlists
]
}
}Updates the player's current playlist for population tracking.
{
"Playlist": 0,
"NumLocalPlayers": 1
}{
"Result": {}
}Retrieves the drop table for containers.
{}{
"Result": {
"ContainerDrops":[
{
"ProductID": 1009,
"SeriesID": 2,
"Drops": [
// ... same structure as GetPlayerProducts response
]
}
// ... additional containers
]
}
}Retrieves a player's inventory.
{
"PlayerID": "<player id>",
"UpdatedTimestamp": "<timestamp>"
}{
"Result": {
"ProductData": [
{
"ProductID": 7076,
"InstanceID": "<instance id>",
"Attributes": [
{
"Key": "Painted",
"Value": 11
},
{
"Key": "Quality",
"Value": "Import"
},
{
"Key": "Blueprint",
"Value": 7073
},
{
"Key": "BlueprintCost",
"Value": "500"
}
],
"SeriesID": 4,
"AddedTimestamp": 1755399374,
"UpdatedTimestamp": 1755399374
}
// ... additional inventory items
]
}
}Trades in multiple items for a higher-tier item.
{
"PlayerID": "<player id>",
"ProductInstances": [
"62d1e4bc3f5b4076bba8ea044a14a36c",
"b3f60779705f4c8a926a14d6899bad70",
"e610e81c23904c0696a25e9537aff4ba",
"a10e3fa58af141b3829fec050889c967",
"7cf368745031457dbfa7ec8ae4ab316f"
]
}{
"Result": {
"Drops":[
// ... same structure as GetPlayerProducts response
]
}
}Unlocks/opens loot containers to receive items.
{
"PlayerID": "<player id>",
"InstanceIDs": ["90a79f045cad4556b95eea1270be0e76"],
"KeyInstanceIDs": []
}{
"Result": {
"Drops": [
// ... same structure as GetPlayerProducts response
]
}
}Retrieves all available server regions and their sub-regions.
{
"RequestRegions": [],
"Regions": []
}{
"Result": {
"Regions": [
{
"Region": "USE",
"Label": "US-East",
"SubRegions": ["USE1", "USE3"]
},
{
"Region": "EU",
"Label": "Europe",
"SubRegions": ["EU5", "EU1", "EU3", "EU7", "EU9"]
},
{
"Region": "OCE",
"Label": "Oceania",
"SubRegions": ["OCE1"]
}
// ... additional regions
]
}
}Join a private match by server name and password.
{
"JoinType": "JoinPrivate",
"ServerName": "<server name>",
"Password": "<password>"
}Retrieves the authenticated player's Rocket Pass progress and available purchase options.
{
"PlayerID": "<player id>",
"RocketPassID": 25,
"RocketPassInfo": {},
"RocketPassStore": {}
}{
"Result": {
"StartTime": 1750258800,
"EndTime": 1758031200,
"RocketPassInfo": {
"TierLevel": 74,
"bOwnsPremium": false,
"XPMultiplier": 0,
"Pips": 730,
"PipsPerLevel": 10
},
"RocketPassStore": {
"Tiers": [
{
"PurchasableID": 144,
"CurrencyID": 13,
"CurrencyCost": 200,
"OriginalCurrencyCost": null,
"Tiers": 1,
"Savings": 0,
"ImageUrl": null
}
// ... additional tier skip options
],
"Bundles": [
{
"PurchasableID": 142,
"CurrencyID": 13,
"CurrencyCost": 1000,
"OriginalCurrencyCost": null,
"Tiers": 0,
"Savings": 0,
"ImageUrl": "https://rl-cdn.psyonix.com/RocketPass/Images/S19/..."
}
// ... additional bundle options
]
}
}
}Retrieves prestige rewards for a player in the specified Rocket Pass.
{
"PlayerID": "<player id>",
"RocketPassID": 25
}{
"Result": {
"PrestigeRewards": [
{
"Tier": 71,
"ProductData": [
// ... same structure as GetPlayerProducts response
],
"RewardDrops": [],
"CurrencyDrops": [],
"ContainerDrops": [],
"ItemSetDrops": []
}
// ... additional prestige rewards
]
}
}Retrieves reward content and tier information for a Rocket Pass.
{
"RocketPassID": 25,
"TierCap": 0,
"FreeMaxLevel": 0,
"PremiumMaxLevel": 0
}{
"Result": {
"TierCap": 70,
"FreeMaxLevel": 307,
"PremiumMaxLevel": 307,
"FreeRewards": [
// ... same structure as GetPlayerPrestigeRewards response
],
PremiumRewards: [
// ... same structure as GetPlayerPrestigeRewards response
]
}
}Retrieves the authenticated player's currency balances (credits, tokens, etc.).
{
"PlayerID": "<player id>"
}{
"Result": {
"Currencies": [
{
"ID": 13,
"Amount": 0,
"ExpirationTime": null,
"UpdatedTimestamp": 1752883359,
"IsTradable": false,
"TradeHold": null
}
]
}
}Retrieves available items and their prices from specified shop IDs.
{
"ShopIDs": [52, 397, 354, 382, 220, 51, 55, 357, 358, 359, 360, 361, 362, 363, 364, 365, 366, 367, 368]
}{
"Result": {
"Catalogues": [
{
"ShopID": 354,
"ShopItems": [
{
"ShopItemID": 12387,
"StartDate": 1756771200,
"EndDate": 1757203200,
"MaxQuantityPerPlayer": 1,
"ImageURL": null,
"DeliverableProducts": [
{
"Count": 1,
"Product": {
"ProductID": 11499,
"InstanceID": null,
"Attributes": [],
"SeriesID": 1
},
"SortID": 1,
"IsOwned": false
}
],
"DeliverableCurrencies": [],
"Costs": [
{
"ResetTime": null,
"ShopItemCostID": 23839,
"Discount": null,
"BulkDiscounts": null,
"StartDate": 1756771200,
"EndDate": 1757203200,
"Price": [
{
"ID": 13,
"Amount": 1500
}
],
"SortID": 1,
"DisplayTypeID": 0
}
],
"Title": "ADVENTURE TIME + MAMBA",
"Description": "BUNDLE",
"Purchasable": true,
"PurchasedQuantity": 0
}
// ... additional shop items
]
}
// ... additional catalogues
]
}
}Retrieves shop-related notifications and alerts.
{}{
"Result": {
"ShopNotifications": {
"ShopNotificationID": 51,
"ShopItemCostID": 23795,
"StartTime": 1756339200,
"EndTime": 1756771200,
"ImageURL": null,
"Title":"JACKAL + ONE-PUNCH MAN",
"DeliverableProducts": [
// ... same structure as GetShopCatalogue response
]
}
}
}Retrieves information about item shops.
{}{
"Result": {
"Shops": [
{
"ID": 52,
"Type": "Featured",
"StartDate": 1568070623,
"EndDate": null,
"LogoURL": null,
"Name": "Featured Shop",
"Title": null
}
// ... additional shops
]
}
}Retrieves skill data (rank, MMR, etc.) for a specific player across all playlists. Works with any valid player ID.
{
"PlayerID": "<player id>"
}{
"Result": {
"Skills": [
{
"Playlist": 10,
"Mu": 30.4646,
"Sigma": 2.5,
"Tier": 11,
"Division": 1,
"MMR": 30.4646,
"WinStreak": 3,
"MatchesPlayed": 81,
"PlacementMatchesPlayed": 10
}
// ... additional playlists
],
"RewardLevels": {
"SeasonLevel": 6,
"SeasonLevelWins": 0
}
}
}Retrieves skill data for multiple players. Works with any valid player ID.
{
"PlayerIDs": ["<player id>"]
}{
"Result": {
"Skills": [
// ... same structure as GetPlayerSkill response
]
}
}Retrieves skill-based leaderboard for a specific playlist.
{
"Playlist": 10,
"bDisableCrossplay": false
}{
"Result": {
"LeaderboardID": "Skill10",
"Platforms": [
{
"Platform": "Epic",
"Players": [
{
"PlayerID": "Epic|6ea3d3d4f992494dacd7f757ff4e2b1a|0",
"PlayerName": "mawkzy",
"MMR": 81.8645,
"Value": 22
}
// ... additional players
]
}
// ... additional platforms
]
}
}Retrieves leaderboard ranks for specific players in a playlist.
{
"Playlist": 30,
"PlayerIDs": [
"<player id>"
]
}{
"Result": {
"Playlist": 30,
"PlayerIDs": [
// ... player ids
]
}
}Retrieves leaderboard value/position for a specific player.
{
"Playlist": 10,
"PlayerID": "<player id>"
}{
"Result": {
"LeaderboardID": "Skill10",
"bHasSkill": true,
"MMR": 30.4646,
"Value": 11
}
}Retrieves global leaderboard data for a specific statistic.
{
"Stat": "Wins",
"bDisableCrossplay": false
}{
"Result": {
"LeaderboardID": "Wins",
"Platforms": [
{
"Platform": "Epic",
"Stat": "Wins",
"Players": [
{
"PlayerID": "<player id>",
"PlayerName": "<player name>",
"Value": 35128
}
// ... additional players
]
},
{
"Platform": "PS4",
"Stat": "Wins",
"Players": [
// ...
]
}
// ... additional platforms (Steam, XboxOne, Switch)
]
}
}Retrieves leaderboard ranks for specific players in a stat category.
{
"Stat": "Wins",
"PlayerIDs": [
"<player id>"
],
"bDisableCrossplay": false
}{
"Result": {
"LeaderboardID": "Assists",
"Players":[
{
"PlayerID": "<player id>",
"PlayerName": "<player name>",
"Value": 1234
}
// ... additional players
]
}
}Retrieves leaderboard value/position for a specific player in a stat category.
{
"Stat": "Wins",
"PlayerID": "<player id>",
"bDisableCrossplay": false
}{
"Result": {
"LeaderboardID": "Wins",
"bHasValue": true,
"Value": "123"
}
}Registers the authenticated player for a tournament.
{
"PlayerID": "<player id>",
"TournamentID": "<tournament id>",
"Credentials": {
"Title": "",
"Password": ""
}
}{
"Result": {
"Tournament": {
"ID": 44289515,
"Title": "2v2",
"CreatorName": "Psyonix",
"CreatorPlayerID": "Steam|0|0",
"StartTime": 1756850400,
"GenerateBracketTime": null,
"MaxBracketSize": 32,
"RankMin": 0,
"RankMax": 22,
"Region": "USC",
"Platforms": ["Steam", "PS4", "XboxOne", "Switch", "Epic"],
"GameTags": "",
"GameMode": 0,
"GameModes": [],
"TeamSize": 2,
"MapSetName": null,
"DisabledMaps": [
"ARC_P",
"EuroStadium_SnowNight_P",
"labs_circlepillars_p"
// ... additional disabled maps
],
"SeriesLength": 1,
"FinalSeriesLength": 3,
"SeriesRoundLengths": [3, 3, 1],
"SeedingType": 2,
"TieBreaker": 0,
"bPublic": false,
"TeamsRegistered": 0,
"ScheduleID": 39147,
"IsSchedulingTournament": true
}
}
}Retrieves scheduled tournaments for a specific region.
{
"PlayerID": "<player id>",
"Region": "USE"
}{
"Result": {
"Schedules": [
{
"Time": 1756843200,
"ScheduleID": 39143,
"bUpdateSkill": false,
"Tournaments": [
{
"ID": 44287528,
"Title": "2v2 Pentathlon",
"CreatorName": "Psyonix",
"CreatorPlayerID": "Steam|0|0",
"StartTime": 1756843200,
"GenerateBracketTime": null,
"MaxBracketSize": 32,
"RankMin": 0,
"RankMax": 22,
"Region": "USC",
"Platforms": ["Steam", "PS4", "XboxOne", "Switch", "Epic"],
"GameTags": "",
"GameMode": 27,
"GameModes": [12, 25, 6, 8, 0],
"TeamSize": 2,
"MapSetName": null,
"DisabledMaps": [],
"SeriesLength": 1,
"FinalSeriesLength": 3,
"SeriesRoundLengths": [3, 3, 1],
"SeedingType": 2,
"TieBreaker": 0,
"bPublic": false,
"TeamsRegistered": 0,
"ScheduleID": 39143,
"IsSchedulingTournament": true
}
// ... additional tournaments in this time slot
]
}
// ... additional schedules
]
}
}Retrieves tournament cycle information including weekly and seasonal data.
{
"PlayerID": "<player id>"
}{
"Result": {
"CycleID": 19,
"CycleEndTime": 1757916000,
"WeekID": 11,
"WeekEndTime": 1757311200,
"WeeklyCurrencies": [],
"Weeks": [
{"Results": []},
{"Results": []}
// ... additional weeks
],
"TournamentCurrencyID": 35
}
}Retrieves the player's current tournament schedule region.
{
"PlayerID": "<player id>"
}{
"Result": {
"ScheduleRegion": "USE"
}
}Browses available training packs with filtering options.
{
"bFeaturedOnly":true
}{
"Result": {
"TrainingData": [
{
"Code": "4CA7-FADD-0DF1-AEC2",
"TM_Name": "Diamond Pack May 2023",
"Type": 3,
"Difficulty": 2,
"CreatorName": "Psyonix",
"MapName": "cs_p",
"Tags": [],
"NumRounds": 9,
"TM_Guid": "<guid>",
"CreatedAt": 1683788495,
"UpdatedAt": 1756388418
}
// ... additional training packs
]
}
}Retrieves metadata for specific training packs by their codes.
{
"Codes": ["2BFC-F8D6-22AC-2AFE"]
}{
"Result": {
"TrainingData": [
// ... same structure as BrowseTrainingData response
]
}
}Checks which players from a list are allowed to display avatars.
{
"PlayerIDs": [
"<player id>",
"<player id>"
// ... additional player IDs to check
]
}{
"Result": {
"AllowedPlayerIDs": [
"<player id>",
"<player id>"
],
"HiddenPlayerIDs": []
}
}Sent when joining a server
Unknown purpose
Periodically report metrics
Unknown purpose, non-standard schema
Non-standard schema, PsyPing header and empty body. Sent every 20 seconds