Skip to main content
GET
/
api
/
v1
/
order-book?market=ETH-USD
Retrieve order book snapshot for the given market
curl --request GET \
  --url 'https://market-data.trade.rails.xyz/api/v1/order-book?market=ETH-USD'
[
  {
    "quantity": "0.1",
    "price": "4355.1",
    "orderType": "buy"
  },
  {
    "quantity": "0.2",
    "price": "4355.2",
    "orderType": "sell"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.rails.xyz/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint returns a flat array. For a wrapped response with a snapshot timestamp, see Get Order Book v2.

Query Parameters

​
market
string
required

Market name. Example value: ETH-USD. To get all supported markets, call /api/v1/markets endpoint.

Response

200 - application/json
​
quantity
string
required

Total quantity at this price level.

​
price
string
required

Price level.

​
orderType
enum<string>
required

Side of the book: 'buy' for bids, 'sell' for asks.

Available options:
buy,
sell