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.0 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.710404995918599",
      "amount": "62.766435",
      "total": "44.589589",
      "account": "rU8QEjAbNbXDnBR7kx9TLPXsAEng3axsz4",
      "funded": true
    },
    {
      "price": "0.7104038",
      "amount": "5",
      "total": "3.552019",
      "account": "raRiscpYKJCueDMtC9DDkgEfhExSYBGCUs",
      "funded": true
    },
    {
      "price": "0.710131445330531",
      "amount": "10006.85720471",
      "total": "7106.18397",
      "account": "rURtT5MMFzSUR54MAq9MKfzBoezTBZbKns",
      "funded": true
    },
    {
      "price": "0.710025560920193",
      "amount": "715.439032",
      "total": "507.98",
      "account": "rLVkkxk7THbb3dCZ6aETvLnzc8HabyubEs",
      "funded": true
    },
    {
      "price": "0.709980193220276",
      "amount": "1910.99717",
      "total": "1356.77014",
      "account": "rpiFwLYi6Gb1ESHYorn2QG1WU5vw2u4exQ",
      "funded": true
    }
  ],
  "asks": [
    {
      "price": "0.71086705307504",
      "amount": "3.516832",
      "total": "2.5",
      "account": "rJ4AgDd1ZqTqSgQ7YoA26tRNK3gTz6hCCm",
      "funded": true
    },
    {
      "price": "0.710867120452642",
      "amount": "2.110099",
      "total": "1.5",
      "account": "rLtdxMMXPs21PYnnSiwm85EabdHDH4oVhi",
      "funded": true
    },
    {
      "price": "0.710867168579509",
      "amount": "4.923564",
      "total": "3.5",
      "account": "rGAs3npYy1VwLPE92kvKvA2QYLR6FSA9n6",
      "funded": true
    },
    {
      "price": "0.710867204674663",
      "amount": "2.813465",
      "total": "2",
      "account": "rFHVbyAUMtAyctsHCETi2RQGUE3jGZQaF",
      "funded": true
    },
    {
      "price": "0.711085890963076",
      "amount": "163.009",
      "total": "115.9134",
      "account": "rL589u2EpwGS9zUcnzJmxkyqqQP4Q7Nqn5",
      "funded": true
    }
  ],
  "ledger_index": 107595264
}
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