API Endpoint

All your API requests should be made to the following API endpoint:

https://api.cryptohopper.com/v1/

Supported Request Methods

Request Parameters

There are four types of parameters that we use in our API: path, query string, header and request body parameters. Request body parameters are data posted in the JSON request body for POST and PATCH requests. Header parameters are obviously parameters which need to be posted in the header. More info about the Header, Path and Query string parameters can be found underneath.

Header Parameters

Every request to our API needs to be authenticated by posting the following values in the header:

• access-token - Your access token received with the Oauth2 authentication

Path Parameters

These are parameters that are supplied in the URI of the endpoint. For example the GET Hopper endpoint:

https://api.cryptohopper.com/v1/hopper/{hopper_id}

In order to retrieve a trading bot by its unique ID, you need to replace its ID value in the {hopper_id} placeholder. For example to retrieve a trading bot with ID 37, you would request the following URL:

https://api.cryptohopper.com/v1/hopper/37

Some endpoints require multiple parameters. For example if you wish to return a specific order from the previous Hopper, you need to call the following URL:

https://api.cryptohopper.com/v1//hopper/{hopperId}/order/{orderId}

And by replacing the parameters with the Hopper and Order ID you will get:

https://api.cryptohopper.com/v1//hopper/37/order/231

For a detailed list of parameters required in each API endpoint, please refer to our API reference guide.

Query String Parameters

We use these type of parameters in GET requests for filtering and/or pagination of data. These parameters are not specified in the path, but as a set of values separated by the ‘&’ character in the URL string.

For example to retrieve a trading bot’s Bitcoin buy orders, you could call the Hopper Order endpoint like this:

https://api.cryptohopper.com/v1/hopper/37/order/?order_type=buy&coin=btc

By looking at our API reference you can see that, in this case, the order_type parameter can either take the values ‘buy’ or ‘sell’, and the coin parameter could be any lower case crypto currency coin code.

Response Format

All responses are in the form of a JSON object. Thus, the MIME type you find in all of our responses will be application/json. Please refer to our API reference documentation for the specific JSON response format in the body of each request and response.

HTTP Response Codes

We use the response status codes defined by the RFC 2616 and RFC 6585 standards.

HTTP Error Codes

Error messages

Whenever the API returns an error code, it will attach a JSON object with the description of the error in its body. An error message would look something like this:

{
    "status": 400,
    "error": 1,
    "message": "Missing required request parameters: [access_token]"
}

Rate Limits

Our API has a request rate limit to provide an equal share of our bandwidth resources to all of our users. Our current rate limits are 2 request per second per user, except when it comes to placing buy orders. In that case, the maximum amount of buy orders that can be placed is one order each 8 seconds.

If you exceed the amount of available request per second, you will get a 429 error response code. Please check the Retry-After header attached to the response, which contains the amount of seconds you have to wait until you can perform another request.