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 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.

HTTP Success

Successful HTTP responses have the status code 200 like in this exemple :

200 : Success
200 : Success
{
"api_version": "2.0.0",
"server_time": "2020-02-25T15:48:26.538Z"
}

HTTP Errors

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 :

500 : Internal Error
500 : Internal Error
{
"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

OK

Success!

400

Bad Request

The request was unacceptable, often due to missing a required parameter. Please check the accompanying error message for further details.

401

Unauthorized

Missing or incorrect authentication credentials.

403

Forbidden

The request is fine but you doesn't have permissions to perform the request, you naughty boy.

404

Not Found

The requested ressource does not exist. Make sure there is no trailing / at the end of any endpoint.

429

Too Many Requests

Returned when a request cannot be served due to the rate limit. Too many requests hit koinju too quickly.

500

Internal Server Error

Koinju server is temporary broken for example in a high load situation or if an endpoint is temporarily having issues.

502

Bad Gateway

Koinju server is down for maintenance