Welcome to the Ripio Trade API documentation.

Version

This API is currently in the version 4.

If there is need for any big change, a new version will be launched and this version will be maintained for at least 3 months.

If you're still using the version 3, access the old documentation and check the migration guide.

Important

Use the Market endpoints for all trading operations. The Public endpoints have a delay (cache) of up to 30 seconds.

All successful requests will result in a 200 HTTP Status.

All requests returns data in JSON format (application/json) and have a default body:

Success

{
  "error_code": null,
  "message": null,
  "data": { }
}

Error

{
  "error_code": [Error code],
  "message": "Error description",
  "data": null
}

Endpoints that have a date filter will return data for the last 6 months if no value is sent in the start_date parameter.

URL structure

The endpoints URL follow this pattern:

https://api.ripiotrade.co/{version}/{method}[/{parameter}][?parameter=value...]

https://api.ripiotrade.co/v4/tickers/BTC_BRL

Limits

The request limits are based on the user's operational limits.

There are two types of limit, one of requests per second and another of daily requests. Both of them should be taken in consideration and the requests should be balanced so the daily limit isn't reached.

Users without approved documentation have 1 request per second or 86.400 daily requests.

Users with approved documentation have 3.5 requests per second or 302.400 daily requests.

These limits can be increased, and the support team should be contacted for that.

When the requests per second limit is reached, the response HTTP Status returned is 429 and the response body is:

{
  "message": "Too many requests"
}

When the daily requests limit is reached, the response HTTP Status returned is 429 and the response body is:

{
  "message": "Limit Exceeded"
}