HTTP Response codes
The koinju API returns HTTP status codes in addition to JSON-based error codes and messages.
The koinju REST API attempts to return conventional HTTP status codes to indicate the success or failure of an API request. In general: Codes in the
2xxrange indicate success. Status codes in the
4xxrange indicate a failed request based on client information or context (for exemple, wrong parameter or a rate limit...). Status code in the
5xxrange indicate an error from the koinju's servers.
Successful HTTP responses have the status code
200like in this exemple :
200 : Success
All HTTP requests with response status codes different to
200must be considered as failed and you should expect additional JSON inside the body of the response with the error message encapsulated inside it as shown in the example :
500 : Internal Error
"message": "Internal server error. Please contact the support if the problem persists."
We use the following error codes:
The request was unacceptable, often due to missing a required parameter. Please check the accompanying error message for further details.
Missing or incorrect authentication credentials.
The request is fine but you doesn't have permissions to perform the request, you naughty boy.
The requested ressource does not exist. Make sure there is no trailing
Returned when a request cannot be served due to the rate limit. Too many requests hit koinju too quickly.
Koinju server is temporary broken for example in a high load situation or if an endpoint is temporarily having issues.
Koinju server is down for maintenance