We are now verified! Husqy is now a verified bot in Discord making us visible in the app discovery and enabling bigger trust to users!
Want to help us translate the Husqy responses? We can't do it without you! Please visit our translations repo!
Skip to main content

API

This section contains information about all Husqy API endpoints. Go to the Husqy API with the next page button or use one of the quick links.

warning
  • Some endpoint may be described and documented but may not be available for users or API keys to use.
  • All requested post data must be present when making a request. On some endpoints, keys may be None/Null.
  • All endpoints may return UnauthorizedError or ForbiddenError even though this is not specified.

Accessing the API​

All V1 (latest) API endpoints are located at: https://api.husqy.xyz/v1. Throughout the documentation you will come across endpoints, make sure this prefix is added before the endpoints.

Return JSON structure​

The structure of the JSON that will be returned by all API endpoints is the same and is as follows:

{
  "success": boolean value to display if the request was successfully handled, if so the data key will be filled,
  "data": empty list, list of objects or an object (which may be empty),
  "error": {
      "code": integer with the HTTP status code,
      "message": string with a description of the error and/or HTTP status code,
  },
}

Functions:

Modules: