Jump to Content
GitHub
NPM
Website
Blog
Integration Steps
API Reference
Changelog
Discussions
v1.10.0
v1.11.0
v1.12.0
v1.13.0
v1.14.0
GitHub
NPM
Website
Blog
Dashboard Login
API Reference
Dashboard Login
Moon (Dark Mode)
Sun (Light Mode)
v1.14.0
Integration Steps
API Reference
Changelog
Discussions
P2e
Search
JUMP TO
Admin API
Authentification
Auth
Returns the current user information
get
Set user property
put
Feedback
Create a feedback
post
I18n
Get a language bundle
get
Integrations
Record a rewardable event
post
Record batch of rewardable events
post
Create a user if not exists. Returns the user access.
post
Rewarder
Returns information about used rewarder key
get
Widgets
Get the active widget config
get
RewarderKey
Player API
Users
Get player stats
get
Level up user
post
Get game information for user, use this for displaying game things
get
Charge user tokens API
post
Get player's profile
get
Get current player's profile
get
Perks
Activate a perk. If perk can't be activated, potential replacements will be sent
post
Deactivate a perk
post
Level up a perk
post
Get user perks
get
System
Get information about all game levels
get
Quests
Get all available quests for the player
get
Accept quest
post
Cancel quest
post
Claim quest reward
post
Daily
Claim daily bonus
post
Rewards
Get all reward definitions
get
Get all modifiers definitions
get
Achievements
Get all achievements
get
Get an achievement
get
Get all achievements for the player
get
Claim achievement reward
post
Reward Rules
Get visible and enabled reward rules info
get
Leaderboards
/players/@me/leaderboards
get
/players/@me/leaderboards/{id}
get
/players/@me/leaderboards/{id}/position
get
/players/@me/leaderboards/{id}/position/neighbors
get
/players/@/leaderboards/{id}
get
P2e
Player
Inventory
Get player inventory activity
get
Get user inventory history
get
UserRewards
Choose a reward
post
Get all pending rewards
get
Polls
Get all available polls for the player
get
Submit a vote
post
Remove a vote
delete
Cancel a poll
post
Get poll results
get
Assignments
Get all user assignments
get
Accept an assignment
post
Claim an assignment
post
Redeem Options API
Redeem Options
Get redeem options available for user
get
Get transaction by id
get
Redeem Providers
Handle external event
post
Handle user event
post
P2e