Order books

books.list

Every DeepBook v3 pool with its coins, book parameters, best prices and 24 hour activity.

Details

Endpoint: GET /v1/books
Credits: 2
Rate class: Light. Counts against your light requests per second.

Returns all DeepBook v3 order book pools on Sui. Each pool has its object id, base and quote coin (type, symbol, decimals), tick size in quote per base, lot size and minimum size in base units, taker and maker fee in basis points, best bid, best ask and mid price, and 24 hour volume and trade count from fill events. Prices and sizes are decimal numbers, not raw integers. Pools with an empty side have a null mid price. Volume fields are null if the history index is busy. Cached for 45 seconds.

Parameters

This method takes no parameters.

Request

Send your key in the x-api-key header, or leave it out to use the keyless tier.

curl

curl "https://api.tide.ad/v1/books" \
  -H "x-api-key: YOUR_API_KEY"

TypeScript

const res = await fetch("https://api.tide.ad/v1/books", {
  headers: {
    "x-api-key": process.env.TIDE_API_KEY!,
  },
});
const data = await res.json();

Response

JSON

{
  "items": [
    {
      "poolId": "0xe05dafb5133bcffb8d59f4e12465dc0e9faeaa05e3e342a08fe135800e3e4407",
      "base": {
        "symbol": "SUI"
      },
      "quote": {
        "symbol": "USDC"
      }
    }
  ],
  "cursor": null
}