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 response3 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.695060995861529",
      "amount": "3.75460142",
      "total": "2.609677",
      "account": "r9LhaYT6Zpw3MZnMnXPRqTtonscbQePGyJ",
      "funded": false
    },
    {
      "price": "0.69459397509186",
      "amount": "100.10056593",
      "total": "69.52925",
      "account": "rURtT5MMFzSUR54MAq9MKfzBoezTBZbKns",
      "funded": false
    },
    {
      "price": "0.694565028650807",
      "amount": "100.10105193",
      "total": "69.52669",
      "account": "rURtT5MMFzSUR54MAq9MKfzBoezTBZbKns",
      "funded": false
    },
    {
      "price": "0.694388664008412",
      "amount": "1729.5789264",
      "total": "1201",
      "account": "rfPBiFvFeBQ9j5WJFqrDeTN1gsDW3Vrbqj",
      "funded": false
    },
    {
      "price": "0.694357650665999",
      "amount": "1911.00167",
      "total": "1326.91863",
      "account": "rpiFwLYi6Gb1ESHYorn2QG1WU5vw2u4exQ",
      "funded": false
    }
  ],
  "asks": [
    {
      "price": "0.695615870863713",
      "amount": "4.887515",
      "total": "3.399833",
      "account": "rh31W8kCp35z1kswFz4UFzHpFtMzkecxcW",
      "funded": false
    },
    {
      "price": "0.695647334627237",
      "amount": "2.156265",
      "total": "1.5",
      "account": "rMJ1ejWzy5AEF2tzFrv8FQpeR83DMLUQYq",
      "funded": false
    },
    {
      "price": "0.695652173913043",
      "amount": "890.33",
      "total": "619.36",
      "account": "rLtCVnojydtQy7GYGTmDegkM15hLX8VuZk",
      "funded": false
    },
    {
      "price": "0.695748974778449",
      "amount": "1165.57977",
      "total": "810.95093",
      "account": "rpiFwLYi6Gb1ESHYorn2QG1WU5vw2u4exQ",
      "funded": false
    },
    {
      "price": "0.695903909090909",
      "amount": "11",
      "total": "7.654943",
      "account": "rPU3jDj7QtHgaU9CHzYjyW6FcCx3dop2ZL",
      "funded": false
    }
  ],
  "ledger_index": 107131944
}
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