User API
GET /api/user/:userKey:
Section titled “GET /api/user/:userKey:”Description: Returns ApiUser object.
POST /api/user/:userKey:/buy
Section titled “POST /api/user/:userKey:/buy”Description: Buys an item or pack (chest) from the shop.
Query Parameters:
| NAME | DESCRIPTION | REQUIRED |
|---|---|---|
| quantity | Item count | yes |
| timedDealId | Deal ID | no* |
| itemId | Item ID | no* |
| packId | Pack (chest) ID | no* |
* one of these must me present
POST /api/user/:userKey:/clear-sessions
Section titled “POST /api/user/:userKey:/clear-sessions”Description: Revokes all user keys.
POST /api/user/:userKey:/delete-account
Section titled “POST /api/user/:userKey:/delete-account”Description: Deletes account.
Query Parameters:
| NAME | DESCRIPTION | REQUIRED |
|---|---|---|
| confirmationKey | Another user token | yes |
POST /api/user/:userKey:/friend-code/update
Section titled “POST /api/user/:userKey:/friend-code/update”Description: Changes friend code & charges gems.
Query Parameters:
| NAME | DESCRIPTION | REQUIRED |
|---|---|---|
| name | New name | yes |
POST /api/user/:userKey:/pack/open
Section titled “POST /api/user/:userKey:/pack/open”Description: Opens an available chest (pack).
Query Parameters:
| NAME | DESCRIPTION | REQUIRED |
|---|---|---|
| packId | Pack ID | yes |
GET /api/user/:userKey:/rewards
Section titled “GET /api/user/:userKey:/rewards”Description: Returns ApiUserRewardsResponse object.
POST /api/user/:userKey:/rewards/claim
Section titled “POST /api/user/:userKey:/rewards/claim”Description: Claims a reward.
Query Parameters:
| NAME | DESCRIPTION | REQUIRED |
|---|---|---|
| type | Options: first, gift, recurring, bonus, instagram, nitro, coming_soon | yes |
GET /api/profile/:friendCode:
Section titled “GET /api/profile/:friendCode:”Description: Returns ApiProfileResponse object.
Query Parameters:
| NAME | DESCRIPTION | REQUIRED |
|---|---|---|
| userKey | Account token | yes* |
* used not to be authenticated