Sandbox version
For experimental use only. Proceed with caution.
trades
Get a live orderbook snapshot
get
/trade/orderbook
operationId: trade-orderbook

Returns a live snapshot of the orderbook for the requested pair. Each side of the pair is supplied as either the literal XRP or a currency.issuer tokenSlug. Returns { bids, asks } where each entry carries a normalized price (quote per base in display units, with XRP drops converted to XRP) alongside the raw takerGets/takerPays passthrough. This is a live ledger view and does not hit the local database.

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 `indexer` audience. Present as `Authorization: Bearer <token>`.
Query Parameters
NameTypeDefaultDescription
base
required
string
Base asset. The price is expressed as quote per one unit of base.
quote
required
string
Quote asset. Priced in units of this asset per base.
limit
integer50
Responses
200
application/json
Successful response
FieldTypeDescription
bids
object[]
Buy orders — offerers holding quote and willing to receive base.
bids[].account
string
Offerer account (classic XRPL address).
bids[].sequence
integer
Offer sequence number.
bids[].price
string
Quote per base as a decimal string (display units — drops are converted to XRP).
bids[].baseAmount
string
Base-side amount in display units (XRP when base is XRP, IOU/MPT value otherwise).
bids[].quoteAmount
string
Quote-side amount in display units.
bids[].quality
string
Raw `quality` field (TakerPays/TakerGets in ledger units).
bids[].ownerFunds
string
Estimate of how much of TakerGets the owner still funds.
bids[].takerGets
object
Raw TakerGets amount from the offer (passthrough for advanced consumers).
bids[].takerPays
object
Raw TakerPays amount from the offer (passthrough).
asks
object[]
Sell orders — offerers holding base and willing to receive quote.
asks[].account
string
Offerer account (classic XRPL address).
asks[].sequence
integer
Offer sequence number.
asks[].price
string
Quote per base as a decimal string (display units — drops are converted to XRP).
asks[].baseAmount
string
Base-side amount in display units (XRP when base is XRP, IOU/MPT value otherwise).
asks[].quoteAmount
string
Quote-side amount in display units.
asks[].quality
string
Raw `quality` field (TakerPays/TakerGets in ledger units).
asks[].ownerFunds
string
Estimate of how much of TakerGets the owner still funds.
asks[].takerGets
object
Raw TakerGets amount from the offer (passthrough for advanced consumers).
asks[].takerPays
object
Raw TakerPays amount from the offer (passthrough).
Example
Json
{
  "bids": [
    {
      "account": "rExampleBidder1234567890",
      "sequence": 4501,
      "price": "0.512",
      "baseAmount": "1000",
      "quoteAmount": "512",
      "quality": "512000000",
      "ownerFunds": "1000",
      "takerGets": {
        "currency": "USD",
        "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
        "value": "512"
      },
      "takerPays": "1000000000"
    }
  ],
  "asks": [
    {
      "account": "rExampleAsker0987654321",
      "sequence": 9123,
      "price": "0.515",
      "baseAmount": "500",
      "quoteAmount": "257.5",
      "takerGets": "500000000",
      "takerPays": {
        "currency": "USD",
        "issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
        "value": "257.5"
      }
    }
  ]
}
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": []
}