Skip to content

User API

GET /api/user/:userKey:

Description: Returns ApiUser object.

POST /api/user/:userKey:/buy

Description: Buys an item or pack (chest) from the shop.
Query Parameters:

NAMEDESCRIPTIONREQUIRED
quantityItem countyes
timedDealIdDeal IDno*
itemIdItem IDno*
packIdPack (chest) IDno*

* one of these must me present

POST /api/user/:userKey:/clear-sessions

Description: Revokes all user keys.

POST /api/user/:userKey:/delete-account

Description: Deletes account.
Query Parameters:

NAMEDESCRIPTIONREQUIRED
confirmationKeyAnother user tokenyes

POST /api/user/:userKey:/friend-code/update

Description: Changes friend code & charges gems.
Query Parameters:

NAMEDESCRIPTIONREQUIRED
nameNew nameyes

POST /api/user/:userKey:/pack/open

Description: Opens an available chest (pack).
Query Parameters:

NAMEDESCRIPTIONREQUIRED
packIdPack IDyes

GET /api/user/:userKey:/rewards

Description: Returns ApiUserRewardsResponse object.

POST /api/user/:userKey:/rewards/claim

Description: Claims a reward.
Query Parameters:

NAMEDESCRIPTIONREQUIRED
typeOptions: first, gift, recurring, bonus, instagram, nitro, coming_soonyes

GET /api/profile/:friendCode:

Description: Returns ApiProfileResponse object.
Query Parameters:

NAMEDESCRIPTIONREQUIRED
userKeyAccount tokenyes*

* used not to be authenticated