Sandbox version
For experimental use only. Proceed with caution.
XRPL
Get OHLCV candles for an XRPL currency, in a chosen denomination
get
/xrpl/quote/ohlcv
operationId: xrpl-quoteOhlcv

Returns OHLCV candles (open/high/low/close/volume/tradeCount per bucket) for an XRPL IOU (or XRP) denominated in the requested currency. Each candle is computed by joining the IOU/XRP candle from ohlcv_<interval> with the matching cex_ohlcv_<interval> bridge candle on bucket; when the CEX bucket is missing (feed outage) the bridge value is carried forward from the most recent prior CEX close. Inverted pairs (XRP stored as base) are flipped automatically so OHLC is always in IOU-quoted units.

Unlock protected endpoints

Enter your Bearer token once to enable every protected route in this API reference.

HTTP bearer

Saved for this browser tab only. The credential is never sent until you test an endpoint.

Authorizations
NameLocationDetails
BearerAuthAuthorization header · bearerJWT issued by the Honeycluster auth service for the `oracle` audience. Present as `Authorization: Bearer <token>`.
Query Parameters
NameTypeDefaultDescription
currency
string
issuer
object
tokenSlug
string
denomination
string"USD"
interval
enum<string>"1h"
Available
1m3m5m15m30m1h2h4h
startTime
integer
endTime
integer
limit
integer500
Responses
200
application/json
Successful response
FieldTypeDefaultDescription
items
object[]
items[].bucket
integer
Start of the candle interval, Unix-seconds.
items[].open
string
Opening denominated price (decimal string).
items[].high
string
Highest denominated price seen in the interval (decimal string).
items[].low
string
Lowest denominated price seen in the interval (decimal string).
items[].close
string
Closing denominated price (decimal string).
items[].volume
string
Total volume traded in the interval, expressed in the requested `denomination` (decimal string). Approximated as native base-side volume × bucket close × bridge factor — the OHLCV view stores `sum(base_amount)` only, so an exact figure would require summing quote amounts per trade.
items[].tradeCount
number
Number of trades that make up the native candle.
pair
object
Trade pair (markets row).
pair.id
string
pair.baseCurrency
string
pair.baseIssuer
object
pair.quoteCurrency
string
pair.quoteIssuer
object
pair.createdAt
string
pair.updatedAt
string
inverted
booleanfalse
True when the source pair stored XRP on the base side.
denomination
string
bridgeBase
object
Example
Json
{
  "pair": {
    "id": "3c4a3de8-4218-400c-8c55-87dc27206753",
    "baseCurrency": "USD",
    "baseIssuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
    "quoteCurrency": "XRP",
    "quoteIssuer": null,
    "createdAt": "2025-04-26T00:00:00.000Z",
    "updatedAt": "2025-04-26T00:00:00.000Z"
  },
  "inverted": false,
  "denomination": "USD",
  "bridgeBase": "USD",
  "items": [
    {
      "bucket": 1745798400,
      "open": "0.205",
      "high": "0.213",
      "low": "0.198",
      "close": "0.207",
      "volume": "128450.32",
      "tradeCount": 312
    }
  ]
}
400
application/json
Invalid input data
FieldTypeDescription
message
string
The error message
code
string
The error code
issues
object[]
An array of issues that were responsible for the error
issues[].message
string
Example
Json
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
401
application/json
Authorization not provided
FieldTypeDescription
message
string
The error message
code
string
The error code
issues
object[]
An array of issues that were responsible for the error
issues[].message
string
Example
Json
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
403
application/json
Insufficient access
FieldTypeDescription
message
string
The error message
code
string
The error code
issues
object[]
An array of issues that were responsible for the error
issues[].message
string
Example
Json
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
404
application/json
Not found
FieldTypeDescription
message
string
The error message
code
string
The error code
issues
object[]
An array of issues that were responsible for the error
issues[].message
string
Example
Json
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
500
application/json
Internal server error
FieldTypeDescription
message
string
The error message
code
string
The error code
issues
object[]
An array of issues that were responsible for the error
issues[].message
string
Example
Json
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}