Responses

What our API responses look like.

In order to remain consistent, our API will always return roughly the same response for each request you send us. You will mostly (and hopefully) receive 3 properties from our payload, depending on the status of your request.

Property	Type	Description
status	Number	The HTTP status code representing the state of the response. See more about HTTP status codes here.
error	String?	Sometimes your request will result in an error (otherwise this property will have the value of null), meaning the value of this property will contain a short error message in aid of helping you understand what went wrong.
message	String	If the request is successful, you should see Successful request. If not, you'll get a short message in aid of what went wrong.
data	Object?	If the request was successful, then the data of the request will always be contained within this object. This property will have a value of null if there was an error with the request.

As you should know, the ? after String, and Object shown above showcase that due to their value possibly being null, they may not be received in the response from us. You may also view a different response if our API service is offline or in maintenance. Please join our Discord server to see updates and status on our API.