CoinJar Exchange only supports JSON requests and responses. Please ensure that your
Content-Type is set to
application/json in all API requests with a payload.
We follow standard HTTP status codes for responses. If you receive a
4xx error, it is most likely a client error. If you receive a
5xx error, it is most likely a server error. All
2xx statuses should be considered successful.
Throughout this documentation, we will provide examples of common error responses in addition to example successful responses.
All requests in this documentation require an API Key. You can generate a new API key in CoinJar Exchange (Settings -> API Keys).
To authenticate your request using Bearer authentication (also called token authentication), use the
Authorization HTTP header like this:
Authorization: Bearer lVPhHnCkEHY2sq80SXTiHXj5YsRclUSWWNaKh1RKflU
The endpoint for CoinJar Exchange Trading API in production is
https://api.exchange.coinjar.com/. If you are looking to access your Sandbox account for testing, please use
https://api.exchange.coinjar-sandbox.com. Note that your production and sandbox credentials will be different.
CoinJar Exchange APIs only accept secure protocols (
wss) for all requests. Please keep your API key strictly confidential as anyone with your API key can place orders and move funds on your CoinJar Exchange account. If you believe that your API key may be compromised, your should revoke the API key on CoinJar Exchange (Settings -> API Keys).
Collection endpoints enable paging by providing the next page cursor in the response header
x-cjx-cursor. Take the following example:
$ curl \ -v \ -H 'Authorization: Bearer ...' \ https://api.exchange.coinjar.com/orders ... < x-cjx-cursor: 1 ...
x-cjx-cursor: 1 the next page request becomes:
$ curl \ -v \ -H 'Authorization: Bearer ...' \ https://api.exchange.coinjar.com/orders?cursor=1 ...