Skip to main content

Documentation Index

Fetch the complete documentation index at: https://apidocs.ripio.com/llms.txt

Use this file to discover all available pages before exploring further.

The Ripio Retail API provides a unified programmatic interface for accessing Ripio’s public retail services. It exposes a set of HTTP (REST) and WebSocket (WS) endpoints that allow clients to interact with Ripio systems in a consistent and structured way. All API access is authenticated and authorized, and requests are validated at the API boundary to ensure correctness, security, and predictable behavior. The API is designed to provide stable contracts across releases.
This API is intended for retail products. If you are looking for enterprise, CaaS (Crypto as a Service), or Ramps integrations, please refer to the B2B documentation.

Products

This API covers two core retail products: Ripio Wallet — Ripio’s wallet service for retail users. Use this API to access wallet data on behalf of users, including account balances and wallet information. Designed for third-party integrations that need read access to user wallet state. Ripio Trade — Ripio’s cryptocurrency exchange platform. Use this API to manage orders, access orderbooks, retrieve real-time market data, check balances, and review transaction history. Designed for users who want to programmatically buy, sell, and trade digital assets on the exchange.

What you can build

What you can build with Ripio Retail API:
  • Access user wallet balances and account data (Ripio Wallet)
  • Manage crypto buy and sell orders programmatically (Ripio Trade)
  • Retrieve real-time market data, orderbooks, and ticker information
  • Review transaction history and wallet activity

Where to start

Usage

  • Using the service path in combination with the endpoint path will redirect the request to the desired API:
METHOD https://api.ripio.com/:service/:path
  • Example:
curl -X GET https://api.ripio.com/trade/public/server-time

Response Patterns

All responses share a common envelope:
{
  "error_code": null,
  "message": null,
  "data": {},
  "timestamp": 1713278400000
}
  • error_codenull on success; an error code on failure.
  • messagenull on success; a human-readable error description on failure.
  • data – The response payload on success; null or an object with additional error details on failure.
  • timestamp – Unix timestamp in milliseconds of when the response was generated.

Single Object

{
  "error_code": null,
  "message": null,
  "data": {
    "id": "...",
    "..."
  },
  "timestamp": 1713278400000
}

List

Some endpoints return a flat array directly in data:
{
  "error_code": null,
  "message": null,
  "data": [
    { "..." },
    { "..." }
  ],
  "timestamp": 1713278400000
}

List (Paginated)

List endpoints return the collection alongside pagination metadata inside data. Pagination is cursor-based — pass the cursor value as the c query parameter to navigate pages.
{
  "error_code": null,
  "message": null,
  "data": {
    "<resource>": [...],
    "nc": "<next_cursor or null>",
    "pc": "<prev_cursor or null>"
  },
  "timestamp": 1713278400000
}
  • nc – Cursor for the next page. null if there are no more results.
  • pc – Cursor for the previous page. null if on the first page.

Errors

{
  "error_code": 1001,
  "message": "<Detailed error description>",
  "data": null,
  "timestamp": 1713278400000
}
  • error_code – An error code identifying the failure type.
  • message – A human-readable explanation to help diagnose and resolve the issue.
  • data – Usually null, but may contain additional details about the error (e.g. field-level validation errors).
  • timestamp – Unix timestamp in milliseconds of when the response was generated.