{ "opencollection": "1.0.0", "info": { "name": "Hiro Console Rpc API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Rpc", "type": "folder" }, "items": [ { "info": { "name": "INVENTORY_LIST", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_INVENTORY_LIST?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "List all inventory items defined in the codex." }, { "info": { "name": "INVENTORY_LIST_INVENTORY", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_INVENTORY_LIST_INVENTORY?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "List all inventory items owned by the player." }, { "info": { "name": "INVENTORY_CONSUME", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_INVENTORY_CONSUME?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Consume one or more inventory items owned by the player." }, { "info": { "name": "INVENTORY_GRANT", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_INVENTORY_GRANT?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Grant one or more inventory items to the player." }, { "info": { "name": "INVENTORY_UPDATE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_INVENTORY_UPDATE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Update the properties on one or more inventory items owned by the player." }, { "info": { "name": "INVENTORY_DELETE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_INVENTORY_DELETE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Delete Items by instance id." }, { "info": { "name": "ECONOMY_DONATION_CLAIM", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_ECONOMY_DONATION_CLAIM?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Claim one or more rewards which are partially or full donated by other players." }, { "info": { "name": "ECONOMY_DONATION_GIVE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_ECONOMY_DONATION_GIVE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Donate some resource (currencies, items, etc.) to a user by donation ID." }, { "info": { "name": "ECONOMY_DONATION_GET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_ECONOMY_DONATION_GET?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Get progress on one or more donations for a set of players by their IDs." }, { "info": { "name": "ECONOMY_DONATION_REQUEST", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_ECONOMY_DONATION_REQUEST?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Request a donation which other players can contribute into." }, { "info": { "name": "ECONOMY_STORE_GET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_ECONOMY_STORE_GET?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Get all store items defined in the Virtual Store." }, { "info": { "name": "ECONOMY_GRANT", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_ECONOMY_GRANT?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Grant one or more currencies or reward modifiers to te player." }, { "info": { "name": "ECONOMY_PURCHASE_INTENT", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_ECONOMY_PURCHASE_INTENT?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Send a marker of intent to purchase by the player." }, { "info": { "name": "ECONOMY_PURCHASE_ITEM", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_ECONOMY_PURCHASE_ITEM?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Purchase a store item by the player." }, { "info": { "name": "ECONOMY_PURCHASE_RESTORE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_ECONOMY_PURCHASE_RESTORE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Restore a set of purchases." }, { "info": { "name": "ECONOMY_PLACEMENT_STATUS", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_ECONOMY_PLACEMENT_STATUS?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Get the current status on an Ad placement which may have been rewarded." }, { "info": { "name": "ECONOMY_PLACEMENT_START", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_ECONOMY_PLACEMENT_START?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Start a new Ad placement by placement ID." }, { "info": { "name": "ACHIEVEMENTS_CLAIM", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_ACHIEVEMENTS_CLAIM?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Claim one or more achievements which have completed their progress." }, { "info": { "name": "ACHIEVEMENTS_GET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_ACHIEVEMENTS_GET?unwrap" }, "docs": "Get all achievements with progress accumulated by the player." }, { "info": { "name": "ACHIEVEMENTS_UPDATE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_ACHIEVEMENTS_UPDATE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Update one or more achievements with the same progress amount." }, { "info": { "name": "ENERGY_GET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_ENERGY_GET?unwrap" }, "docs": "Get the energies and their current timers for the player." }, { "info": { "name": "ENERGY_SPEND", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_ENERGY_SPEND?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Spend one or more energies for the player." }, { "info": { "name": "ENERGY_GRANT", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_ENERGY_GRANT?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Grant one or more energies to the player." }, { "info": { "name": "ENERGY_SPEND_WITH_REFILL_START_TIME", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_ENERGY_SPEND_WITH_REFILL_START_TIME?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Spend one or more energies with custom refill start times for the player." }, { "info": { "name": "TUTORIALS_GET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TUTORIALS_GET?unwrap" }, "docs": "Get the tutorials and current progress step for the player." }, { "info": { "name": "TUTORIALS_ACCEPT", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TUTORIALS_ACCEPT?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Accept an offer to step through a tutorial." }, { "info": { "name": "TUTORIALS_DECLINE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TUTORIALS_DECLINE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Decline an offer to start a tutorial." }, { "info": { "name": "TUTORIALS_ABANDON", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TUTORIALS_ABANDON?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Abandon progress on a tutorial." }, { "info": { "name": "TUTORIALS_UPDATE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TUTORIALS_UPDATE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Update the current progress step in the tutorial by ID." }, { "info": { "name": "TUTORIALS_RESET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TUTORIALS_RESET?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Reset the state of all given tutorial IDs." }, { "info": { "name": "TEAMS_CREATE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_CREATE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Create a team which other players can join." }, { "info": { "name": "TEAMS_UPDATE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_UPDATE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Update a team's properties." }, { "info": { "name": "TEAMS_LIST", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_LIST?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "List one or more teams which the player can join." }, { "info": { "name": "TEAMS_SEARCH", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_SEARCH?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Search for teams by name or an optional short code." }, { "info": { "name": "TEAMS_GET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_GET?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Retrieves a team by its TeamID." }, { "info": { "name": "TEAMS_USER_TEAMS_LIST", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_USER_TEAMS_LIST?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve a list of teams associated with a given set of users." }, { "info": { "name": "TEAMS_WRITE_CHAT_MESSAGE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_WRITE_CHAT_MESSAGE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Write a chat message to the Team's chat channel." }, { "info": { "name": "TEAMS_STORE_GET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_STORE_GET?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Get all store items defined in the team Virtual Store." }, { "info": { "name": "TEAMS_STORE_PURCHASE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_STORE_PURCHASE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Purchase a team store item." }, { "info": { "name": "TEAMS_WALLET_GET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_WALLET_GET?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Get a team's wallet." }, { "info": { "name": "TEAMS_WALLET_GRANT", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_WALLET_GRANT?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Grant currencies to a team's wallet." }, { "info": { "name": "TEAMS_STATS_GET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_STATS_GET?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Get a team's stats." }, { "info": { "name": "TEAMS_STATS_UPDATE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_STATS_UPDATE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Update a team's stats." }, { "info": { "name": "TEAMS_INVENTORY_LIST", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_INVENTORY_LIST?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "List all inventory items defined in the team codex." }, { "info": { "name": "TEAMS_INVENTORY_LIST_INVENTORY", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_INVENTORY_LIST_INVENTORY?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "List all inventory items owned by a team." }, { "info": { "name": "TEAMS_INVENTORY_CONSUME", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_INVENTORY_CONSUME?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Consume one or more inventory items owned by a team." }, { "info": { "name": "TEAMS_INVENTORY_GRANT", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_INVENTORY_GRANT?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Grant one or more inventory items to a team." }, { "info": { "name": "TEAMS_INVENTORY_UPDATE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_INVENTORY_UPDATE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Update the properties on one or more team inventory items accessible to the player." }, { "info": { "name": "TEAMS_ACHIEVEMENTS_CLAIM", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_ACHIEVEMENTS_CLAIM?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Claim one or more team achievements which have completed their progress." }, { "info": { "name": "TEAMS_ACHIEVEMENTS_GET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_ACHIEVEMENTS_GET?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Get all team achievements with progress accumulated by the team." }, { "info": { "name": "TEAMS_ACHIEVEMENTS_UPDATE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_ACHIEVEMENTS_UPDATE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Update one or more team achievements with the same progress amount." }, { "info": { "name": "TEAMS_EVENT_LEADERBOARD_LIST", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_EVENT_LEADERBOARD_LIST?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "List available event leaderboards." }, { "info": { "name": "TEAMS_EVENT_LEADERBOARD_GET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_EVENT_LEADERBOARD_GET?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Get a specified event leaderboard defined for the game." }, { "info": { "name": "TEAMS_EVENT_LEADERBOARD_UPDATE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_EVENT_LEADERBOARD_UPDATE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Update an event leaderboard score for a user." }, { "info": { "name": "TEAMS_EVENT_LEADERBOARD_CLAIM", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_EVENT_LEADERBOARD_CLAIM?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Claim an event leaderboard reward for a user." }, { "info": { "name": "TEAMS_EVENT_LEADERBOARD_ROLL", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_EVENT_LEADERBOARD_ROLL?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Roll a new cohort for the specified event leaderboard." }, { "info": { "name": "TEAMS_EVENT_LEADERBOARD_DEBUG_FILL", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_EVENT_LEADERBOARD_DEBUG_FILL?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "DEBUG. Fill an event leaderboard with random user IDs." }, { "info": { "name": "TEAMS_EVENT_LEADERBOARD_DEBUG_RANDOM_SCORES", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_EVENT_LEADERBOARD_DEBUG_RANDOM_SCORES?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "DEBUG. Assign random scores within a given range to users within the caller's cohort, except for the caller themselves." }, { "info": { "name": "TEAMS_REWARD_MAILBOX_LIST", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_REWARD_MAILBOX_LIST?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "List rewards available in a team reward mailbox." }, { "info": { "name": "TEAMS_REWARD_MAILBOX_CLAIM", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_REWARD_MAILBOX_CLAIM?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Claim a reward from the team reward mailbox, and optionally delete it." }, { "info": { "name": "TEAMS_REWARD_MAILBOX_DELETE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_REWARD_MAILBOX_DELETE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Delete a reward from the team reward mailbox, even if it is not yet claimed." }, { "info": { "name": "TEAMS_GIFT_LIST", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_GIFT_LIST?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "List available team gifts." }, { "info": { "name": "TEAMS_GIFT_CONTRIBUTE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_GIFT_CONTRIBUTE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Contribute to an active team gift." }, { "info": { "name": "TEAMS_GIFT_CLAIM", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_TEAMS_GIFT_CLAIM?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Claim the user's reward from an eligible team gift." }, { "info": { "name": "UNLOCKABLES_CREATE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_UNLOCKABLES_CREATE?unwrap" }, "docs": "Create a random unlockable to assign to a slot (or overflow) unless there are no slots." }, { "info": { "name": "UNLOCKABLES_GET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_UNLOCKABLES_GET?unwrap" }, "docs": "Get the unlockables which are currently in progress for the player." }, { "info": { "name": "UNLOCKABLES_UNLOCK_START", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_UNLOCKABLES_UNLOCK_START?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Start the unlock timer for an unlockable in the specified slot." }, { "info": { "name": "UNLOCKABLES_PURCHASE_UNLOCK", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_UNLOCKABLES_PURCHASE_UNLOCK?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Purchase an unlockable with soft currency based on the remainder cost calculated by the offset left to wait." }, { "info": { "name": "UNLOCKABLES_PURCHASE_SLOT", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_UNLOCKABLES_PURCHASE_SLOT?unwrap" }, "docs": "Purchase a new slot to be used to store unlockables." }, { "info": { "name": "UNLOCKABLES_CLAIM", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_UNLOCKABLES_CLAIM?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Claim an unlockable whose start timer has completed or completion was fast tracked with a purchase." }, { "info": { "name": "UNLOCKABLES_QUEUE_ADD", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_UNLOCKABLES_QUEUE_ADD?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Add some set of unlockables to the unlock queue." }, { "info": { "name": "UNLOCKABLES_QUEUE_REMOVE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_UNLOCKABLES_QUEUE_REMOVE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Remove some set of unlockables from the unlock queue." }, { "info": { "name": "UNLOCKABLES_QUEUE_SET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_UNLOCKABLES_QUEUE_SET?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Replace the unlock queue with the given set of unlockables." }, { "info": { "name": "BASE_RATE_APP", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_BASE_RATE_APP?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Send feedback to the game's developers over email." }, { "info": { "name": "BASE_SET_DEVICE_PREFS", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_BASE_SET_DEVICE_PREFS?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Update or create the mobile push device tokens and preferences for the player." }, { "info": { "name": "BASE_SYNC", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_BASE_SYNC?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Sync offline state." }, { "info": { "name": "LEADERBOARDS_CONFIG_GET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_LEADERBOARDS_CONFIG_GET?unwrap" }, "docs": "Deprecated: Use RPC_ID_LEADERBOARD_LIST instead. List available leaderboards." }, { "info": { "name": "LEADERBOARD_LIST", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_LEADERBOARD_LIST?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "List available leaderboards." }, { "info": { "name": "LEADERBOARD_GET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_LEADERBOARD_GET?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Get a specified leaderboard with scores." }, { "info": { "name": "LEADERBOARD_UPDATE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_LEADERBOARD_UPDATE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Update a leaderboard score." }, { "info": { "name": "LEADERBOARD_SCORES_LIST", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_LEADERBOARD_SCORES_LIST?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "List scores on a specified leaderboard." }, { "info": { "name": "LEADERBOARD_SCORES_LIST_AROUND_OWNER", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_LEADERBOARD_SCORES_LIST_AROUND_OWNER?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "List scores on a specified leaderboard around the owner." }, { "info": { "name": "EVENT_LEADERBOARD_LIST", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_EVENT_LEADERBOARD_LIST?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "List available event leaderboards." }, { "info": { "name": "EVENT_LEADERBOARD_GET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_EVENT_LEADERBOARD_GET?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Get a specified event leaderboard defined for the game." }, { "info": { "name": "EVENT_LEADERBOARD_UPDATE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_EVENT_LEADERBOARD_UPDATE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Update an event leaderboard score for a user." }, { "info": { "name": "EVENT_LEADERBOARD_CLAIM", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_EVENT_LEADERBOARD_CLAIM?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Claim an event leaderboard reward for a user." }, { "info": { "name": "EVENT_LEADERBOARD_ROLL", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_EVENT_LEADERBOARD_ROLL?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Roll a new cohort for the specified event leaderboard." }, { "info": { "name": "EVENT_LEADERBOARD_DEBUG_FILL", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_EVENT_LEADERBOARD_DEBUG_FILL?unwrap" }, "docs": "DEBUG. Fill an event leaderboard with random user IDs." }, { "info": { "name": "EVENT_LEADERBOARD_DEBUG_RANDOM_SCORES", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_EVENT_LEADERBOARD_DEBUG_RANDOM_SCORES?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "DEBUG. Assign random scores within a given range to users within the caller's cohort, except for the caller themselves." }, { "info": { "name": "EVENT_LEADERBOARD_DEBUG_UNENROLL", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_EVENT_LEADERBOARD_DEBUG_UNENROLL?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "DEBUG. Unenroll from an event leaderboard cohort." }, { "info": { "name": "STATS_GET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_STATS_GET?unwrap" }, "docs": "Get all stats." }, { "info": { "name": "STATS_UPDATE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_STATS_UPDATE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Update stats." }, { "info": { "name": "PROGRESSIONS_GET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_PROGRESSIONS_GET?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Get progressions." }, { "info": { "name": "PROGRESSIONS_PURCHASE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_PROGRESSIONS_PURCHASE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Purchase a progression for permanent unlock, if supported." }, { "info": { "name": "PROGRESSIONS_UPDATE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_PROGRESSIONS_UPDATE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Update a progression to change its count, if supported." }, { "info": { "name": "INCENTIVES_SENDER_LIST", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_INCENTIVES_SENDER_LIST?unwrap" }, "docs": "List incentives set up by the user." }, { "info": { "name": "INCENTIVES_SENDER_CREATE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_INCENTIVES_SENDER_CREATE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new incentive set up by the user." }, { "info": { "name": "INCENTIVES_SENDER_DELETE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_INCENTIVES_SENDER_DELETE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Delete an existing incentive set up by the user." }, { "info": { "name": "INCENTIVES_SENDER_CLAIM", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_INCENTIVES_SENDER_CLAIM?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Claim rewards for an existing incentive after it has been used by some recipient(s)." }, { "info": { "name": "INCENTIVES_RECIPIENT_GET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_INCENTIVES_RECIPIENT_GET?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Get information about an existing incentive from a recipient's perspective." }, { "info": { "name": "INCENTIVES_RECIPIENT_CLAIM", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_INCENTIVES_RECIPIENT_CLAIM?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Claim an existing incentive and receive associated rewards." }, { "info": { "name": "PROGRESSIONS_RESET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_PROGRESSIONS_RESET?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Reset progression progress." }, { "info": { "name": "AUCTIONS_GET_TEMPLATES", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_AUCTIONS_GET_TEMPLATES?unwrap" }, "docs": "Fetch all available auction templates." }, { "info": { "name": "AUCTIONS_LIST", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_AUCTIONS_LIST?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "List available auctions." }, { "info": { "name": "AUCTIONS_BID", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_AUCTIONS_BID?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Bid on an active auction." }, { "info": { "name": "AUCTIONS_CLAIM_BID", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_AUCTIONS_CLAIM_BID?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Claim a completed auction where the user was the winning bidder." }, { "info": { "name": "AUCTIONS_CLAIM_CREATED", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_AUCTIONS_CLAIM_CREATED?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Claim a completed auction where the user was the seller." }, { "info": { "name": "AUCTIONS_CANCEL", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_AUCTIONS_CANCEL?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Cancel an in-progress auction." }, { "info": { "name": "AUCTIONS_CREATE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_AUCTIONS_CREATE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new auction." }, { "info": { "name": "AUCTIONS_LIST_BIDS", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_AUCTIONS_LIST_BIDS?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "List auctions the user has bid on." }, { "info": { "name": "AUCTIONS_LIST_CREATED", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_AUCTIONS_LIST_CREATED?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "List auctions the user has created." }, { "info": { "name": "STREAKS_LIST", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_STREAKS_LIST?unwrap" }, "docs": "List all available streaks, including their current state and progress if any." }, { "info": { "name": "STREAKS_UPDATE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_STREAKS_UPDATE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Update one or more streaks with the given progress amounts." }, { "info": { "name": "STREAKS_CLAIM", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_STREAKS_CLAIM?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Claim the rewards from one or more streaks." }, { "info": { "name": "STREAKS_RESET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_STREAKS_RESET?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Reset all progress for one or more streaks." }, { "info": { "name": "CHALLENGES_GET_TEMPLATES", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_CHALLENGES_GET_TEMPLATES?unwrap" }, "docs": "List all available templates for challenges." }, { "info": { "name": "CHALLENGE_GET", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_CHALLENGE_GET?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Get a challenge by id." }, { "info": { "name": "CHALLENGE_LIST", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_CHALLENGE_LIST?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "List all the user's challenges." }, { "info": { "name": "CHALLENGE_CREATE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_CHALLENGE_CREATE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new challenge based on a template." }, { "info": { "name": "CHALLENGE_JOIN", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_CHALLENGE_JOIN?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Join a challenge." }, { "info": { "name": "CHALLENGE_LEAVE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_CHALLENGE_LEAVE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Leave a challenge." }, { "info": { "name": "CHALLENGE_SUBMIT_SCORE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_CHALLENGE_SUBMIT_SCORE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Submit a score to a challenge." }, { "info": { "name": "CHALLENGE_CLAIM", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_CHALLENGE_CLAIM?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Claim a reward of a challenge." }, { "info": { "name": "CHALLENGE_SEARCH", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_CHALLENGE_SEARCH?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Search for an open challenge to join." }, { "info": { "name": "CHALLENGE_INVITE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_CHALLENGE_INVITE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Invite more users to an ongoing challenge." }, { "info": { "name": "REWARD_MAILBOX_LIST", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_REWARD_MAILBOX_LIST?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "List rewards available in a reward mailbox." }, { "info": { "name": "REWARD_MAILBOX_CLAIM", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_REWARD_MAILBOX_CLAIM?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Claim a reward from the reward mailbox, and optionally delete it." }, { "info": { "name": "REWARD_MAILBOX_DELETE", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_REWARD_MAILBOX_DELETE?unwrap", "body": { "type": "json", "data": "{}" } }, "docs": "Delete a reward from the reward mailbox, even if it is not yet claimed." }, { "info": { "name": "ECONOMY_PLACEMENT_SUCCESS", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_ECONOMY_PLACEMENT_SUCCESS?unwrap" }, "docs": "Webhook RPC to handle Rewarded Video Ad placement success callbacks." }, { "info": { "name": "ECONOMY_PLACEMENT_FAIL", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_ECONOMY_PLACEMENT_FAIL?unwrap" }, "docs": "Webhook RPC to handle Rewarded Video Ad placement failure callbacks." }, { "info": { "name": "STORAGE_PERSONALIZER_UPLOAD", "type": "http" }, "http": { "method": "POST", "url": "http://{hostAddr}:{port}/v2/rpc/RPC_ID_STORAGE_PERSONALIZER_UPLOAD?unwrap" }, "docs": "RPC to upload Hiro system configurations for the storage personalizer." } ] } ], "bundled": true }