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.797130963531771",
      "amount": "55.937595",
      "total": "44.589589",
      "account": "rU8QEjAbNbXDnBR7kx9TLPXsAEng3axsz4",
      "funded": true
    },
    {
      "price": "0.797130330809087",
      "amount": "2.667067",
      "total": "2.126",
      "account": "rLhB6qhWbVsRSRePxPLhXJFtpk2uLqpsQD",
      "funded": true
    },
    {
      "price": "0.796990631089331",
      "amount": "3.13679973",
      "total": "2.5",
      "account": "rKoXaBw8pzkNaaLdMpzKqNbGjBpypmVPgH",
      "funded": true
    },
    {
      "price": "0.796990563631727",
      "amount": "10017.19562854",
      "total": "7983.61039",
      "account": "rURtT5MMFzSUR54MAq9MKfzBoezTBZbKns",
      "funded": true
    },
    {
      "price": "0.796972204508928",
      "amount": "0.12547489",
      "total": "0.1",
      "account": "rKoXaBw8pzkNaaLdMpzKqNbGjBpypmVPgH",
      "funded": true
    }
  ],
  "asks": [
    {
      "price": "0.798085358318797",
      "amount": "7.77908771",
      "total": "6.208376",
      "account": "rKoXaBw8pzkNaaLdMpzKqNbGjBpypmVPgH",
      "funded": true
    },
    {
      "price": "0.79808614918958",
      "amount": "51.5380176",
      "total": "41.131778",
      "account": "rU8QEjAbNbXDnBR7kx9TLPXsAEng3axsz4",
      "funded": true
    },
    {
      "price": "0.798161038745152",
      "amount": "1579.46884",
      "total": "1260.67049",
      "account": "rpiFwLYi6Gb1ESHYorn2QG1WU5vw2u4exQ",
      "funded": true
    },
    {
      "price": "0.798245390904169",
      "amount": "1.49508035",
      "total": "1.193441",
      "account": "rKoXaBw8pzkNaaLdMpzKqNbGjBpypmVPgH",
      "funded": true
    },
    {
      "price": "0.79827572443522",
      "amount": "1.791361",
      "total": "1.43",
      "account": "rLhB6qhWbVsRSRePxPLhXJFtpk2uLqpsQD",
      "funded": true
    }
  ],
  "ledger_index": 108040165
}
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