GET /orderbook
GET

/v1/orderbook

Live DEX orderbook

AuthNone — works without a key

Request

GEThttps://api.xrpl.to/v1/orderbook?base=0dd550278b74cb6690fdae351e8e0df3&quote=XRP&limit=5
Query parameterValueDescription
basetoken id
quotetoken id
limitint (max 400, default 20)
curl 'https://api.xrpl.to/v1/orderbook?base=0dd550278b74cb6690fdae351e8e0df3&quote=XRP&limit=5'

Response

200Example response6 ms · just now · 2.1 KB · 89 lines
https://api.xrpl.to/v1/orderbook?base=0dd550278b74cb6690fdae351e8e0df3&quote=XRP&limit=5
{
  "success": true,
  "pair": "RLUSD/XRP",
  "base": {
    "currency": "RLUSD",
    "issuer": "rMxCKbEDwqr76QuheSUMdEGf4B9xJ8m5De",
    "md5": "0dd550278b74cb6690fdae351e8e0df3"
  },
  "quote": {
    "currency": "XRP",
    "issuer": null,
    "md5": null
  },
  "bids": [
    {
      "price": "0.762020879372095",
      "amount": "105.180845",
      "total": "80.15",
      "account": "rfPXopKnvj6wjfFnutf6WvRWiX7Uk7AJzY",
      "funded": true
    },
    {
      "price": "0.761500455509969",
      "amount": "290.93765",
      "total": "221.549153",
      "account": "r3drY2fHEEzFiU1EHpw2Qjpa2EHGs8cMHo",
      "funded": true
    },
    {
      "price": "0.761269245869071",
      "amount": "3.51541194",
      "total": "2.676175",
      "account": "rKoXaBw8pzkNaaLdMpzKqNbGjBpypmVPgH",
      "funded": true
    },
    {
      "price": "0.761243567491855",
      "amount": "10008.11836756",
      "total": "7618.61573",
      "account": "rURtT5MMFzSUR54MAq9MKfzBoezTBZbKns",
      "funded": true
    },
    {
      "price": "0.761217234938097",
      "amount": "3.50223153",
      "total": "2.665959",
      "account": "rKoXaBw8pzkNaaLdMpzKqNbGjBpypmVPgH",
      "funded": true
    }
  ],
  "asks": [
    {
      "price": "0.762322386804219",
      "amount": "7.23740913",
      "total": "5.517239",
      "account": "rKoXaBw8pzkNaaLdMpzKqNbGjBpypmVPgH",
      "funded": true
    },
    {
      "price": "0.762335303753294",
      "amount": "0.00969783",
      "total": "0.007393",
      "account": "rU8QEjAbNbXDnBR7kx9TLPXsAEng3axsz4",
      "funded": true
    },
    {
      "price": "0.762426906333783",
      "amount": "0.69992546",
      "total": "0.533642",
      "account": "rU8QEjAbNbXDnBR7kx9TLPXsAEng3axsz4",
      "funded": true
    },
    {
      "price": "0.762427569380909",
      "amount": "719.47818",
      "total": "548.55",
      "account": "rLVkkxk7THbb3dCZ6aETvLnzc8HabyubEs",
      "funded": true
    },
    {
      "price": "0.762427994161662",
      "amount": "0.70000053",
      "total": "0.5337",
      "account": "rU8QEjAbNbXDnBR7kx9TLPXsAEng3axsz4",
      "funded": true
    }
  ],
  "ledger_index": 107756484
}
Shapeas documented
{
  success,
  pair,
  base,
  quote,
  bids[],
  asks[],
  ledger_index (falls back to ledger_current_index)
}

What it does

Live DEX orderbook

A token id can be its md5, slug or issuer_currency. How to build an md5 →
OpenAPI