https://your-site.com with your site and YOUR_API_KEY with the key from Settings → API.
Client setup
Users and balance
GET /users response contains the account without the password, plus a linkedAccounts object (e.g. { "discord": "1234…" }).
Credit operations
Buying products with credits
Products are sent as a form array:INSUFFICIENT_BALANCE, OUT_OF_STOCK, REQUIRED_PRODUCT, REQUIRED_LINKED_ACCOUNT, DOWNGRADE_NOT_ALLOWED, INVALID_VARIABLE.
For an in-game store menu, GET /store/listing?username=Steve returns the category tree for that player with final prices and upgrade info.
Roles
Support tickets
Discord bot
discordRoleID mapping.
Donor board (scoreboard, hologram)
type: top-alltime, top-annual, top-monthly, top-daily, latest. limit: 1–10.
Error handling
Error messages are in English and may change. Build the text you show players from the
error code, in your own language.Tips
- Caching: cache data that rarely changes, such as
/store/listing,/store/productsand/vote-links, for a few minutes in your plugin. - Async calls: do not call the API on the game server’s main thread; the server may freeze.
- Usernames: on Minecraft sites
usernameparameters match the player’s real name (realname); on other games, the account username. - Time zone: dates are in the site’s time zone (except role expiry dates in the Discord user endpoint, which are UTC).
