GEgemini
Market Data

Get Current Order Book

This will return the current order book as two arrays (bids / asks).

<p class="p-4 text-sm section-icon section-info rounded-sm flex" role="alert"> <svg view-box="0 0 24 24" > <path fill-rule="evenodd" clip-rule="evenodd" d="M11.1258 5.63252C11.5068 4.94671 12.4932 4.94671 12.8742 5.63252L19.4751 17.5143C19.8454 18.1808 19.3635 18.9999 18.601 18.9999H5.39903C4.63655 18.9999 4.15458 18.1808 4.52487 17.5143L11.1258 5.63252ZM14.6225 4.66123C13.4795 2.6038 10.5205 2.60381 9.37753 4.66124L2.77656 16.543C1.66567 18.5426 3.11158 20.9999 5.39903 20.9999H18.601C20.8884 20.9999 22.3343 18.5426 21.2234 16.543L14.6225 4.66123ZM11 7.99991V13.9999H13V7.99991H11ZM11 15.9999V17.9999H13V15.9999H11Z" /> </svg> The quantities and prices returned are returned as strings rather than numbers. The numbers returned are exact, not rounded, and it can be dangerous to treat them as floating point numbers. </p>
get/v1/book/{symbol}

Request

  • Base URL
    https://api.gemini.com
  • URL
    https://api.gemini.com/v1/book/{symbol}
  • Auth
    none declared

Path parameters

symbolstring required

Trading pair symbol <br /> <br />

BTCUSD, etc. See <u>symbols and minimums</u>.

Query parameters

limit_bidsnumber

Limit the number of bid (offers to buy) price levels returned. Default is 50. May be 0 to return the full order book on this side.

limit_asksnumber

Limit the number of ask (offers to sell) price levels returned. Default is 50. May be 0 to return the full order book on this side.

Response

The response will be two arrays. The bids and the asks are grouped by price, so each entry may represent multiple orders at that price. Each element of the array will be a JSON object.

Changes

No recorded changes to this operation across all 1 revision of this API.