API Endpoints 🌐

We've added new API Endpoints for the Economy System for you to integrate Noctaly in your applications.

Profile

GET users/{userID}/eco-profile

You can now get the items, chests and daily streak of the user.

Items

GET guilds/{guildID}/items

Returns all items configured in the guild's economy.

POST guilds/{guildID}/users/{userID}/items

Adds a quantity of an item to the member's inventory.

DELETE guilds/{guildID}/users/{userID}/items

Removes a quantity of an item from the member's inventory.

PUT guilds/{guildID}/users/{userID}/items

Sets the exact quantity of an item in the member's inventory.

POST guilds/{guildID}/users/{userID}/items/{itemID}/use

Triggers the item's actions (give/remove money, XP, roles, other items…)

Chests

GET guilds/{guildID}/chests

Returns all chests configured in the guild's economy.

POST guilds/{guildID}/users/{userID}/chests

Adds a quantity of a chest to the member's inventory.

DELETE guilds/{guildID}/users/{userID}/chests

Removes a quantity of a chest from the member's inventory.

PUT guilds/{guildID}/users/{userID}/chests

Sets the exact quantity of a chest in the member's inventory.

Documentation

You can read the documentation to use the API: https://noctaly-bot.gitbook.io/noctaly-api

JavaScript Library 📚

We've also released a JavaScript library to make it easier for you to use the API 🥳 https://www.npmjs.com/package/@noctaly/sdk

Enjoy, fellow developers ❤️