HTTP Response codes
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 2xx range indicate success. Status codes in the 4xx range indicate a failed request based on client information or context (for exemple, wrong parameter or a rate limit...). Status code in the 5xx range indicate an error from the koinju's servers.
Successful HTTP responses have the status code 200 like in this exemple :
{"api_version": "2.0.0","server_time": "2020-02-25T15:48:26.538Z"}
All HTTP requests with response status codes different to 200 must 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 :
{"status_code": 500,"message": "Internal server error. Please contact the support if the problem persists."}
We use the following error codes:
Code | Message | Description |
200 |
| Success! |
400 |
| The request was unacceptable, often due to missing a required parameter. Please check the accompanying error message for further details. |
401 |
| Missing or incorrect authentication credentials. |
403 |
| The request is fine but you doesn't have permissions to perform the request, you naughty boy. |
404 |
| The requested ressource does not exist. Make sure there is no trailing |
429 |
| Returned when a request cannot be served due to the rate limit. Too many requests hit koinju too quickly. |
500 |
| Koinju server is temporary broken for example in a high load situation or if an endpoint is temporarily having issues. |
502 |
| Koinju server is down for maintenance |