Skip to main content
GET
/
api
/
v1
/
orderbook
/
snapshot
curl -X GET "https://api.roxom.com/api/v1/orderbook/snapshot?symbol=OIL-BTC&instType=perpetual&levels=50" \
  -H "Content-Type: application/json"

{
    "data": {
        "instrumentId": "01963bbe-299e-70b5-8ae1-a914270647ef",
        "buys": [
            {
                "price": "0.030067",
                "size": "1",
                "total": "0.030067"
            }
        ],
        "sells": [
            {
                "price": "0.030164",
                "size": "1",
                "total": "0.030164"
            }
        ],
        "buySellVersus": {
            "buy": "0.030067",
            "sell": "0.030164"
        }
    },
    "error": false
}

​
Get Order Book Snapshot

Retrieve the current order book snapshot with bid and ask orders for a specific trading symbol.

​
Endpoint

GET /api/v1/orderbook/snapshot

​
Parameters

​
symbol
string
required
Trading symbol (e.g., “OIL-BTC”, “GOLD-BTC”, “US500-BTC”, “US100-BTC”)
​
instType
string
required
Instrument type: “perpetual”
​
levels
integer
default:"20"
Number of price levels to return per side (max: 100)
​
unit
string
default:"btc"
Units for price values: “sats” or “btc”

​
Example Request

curl -X GET "https://api.roxom.com/api/v1/orderbook/snapshot?symbol=OIL-BTC&instType=perpetual&levels=50" \
  -H "Content-Type: application/json"

​
Response

{
    "data": {
        "instrumentId": "01963bbe-299e-70b5-8ae1-a914270647ef",
        "buys": [
            {
                "price": "0.030067",
                "size": "1",
                "total": "0.030067"
            }
        ],
        "sells": [
            {
                "price": "0.030164",
                "size": "1",
                "total": "0.030164"
            }
        ],
        "buySellVersus": {
            "buy": "0.030067",
            "sell": "0.030164"
        }
    },
    "error": false
}
​
data
object
Order book response container

​
Understanding Order Books

  • Bids: Buy orders showing the price buyers are willing to pay
  • Asks: Sell orders showing the price sellers are asking for
  • Spread: The difference between the highest bid and lowest ask
  • Prices: Expressed as strings in BTC
  • Quantities: Also expressed as strings in BTC
Orders are sorted by:
  1. Price priority: Best prices first (highest bids, lowest asks)
  2. Time priority: Earlier orders at the same price level come first
Use order book data to:
  • Estimate market impact of large orders
  • Find optimal execution prices
  • Assess market liquidity and depth

​
Available Symbols

Currently supported trading symbols:
  • US100-BTC: QQQ (Invesco Nasdaq-100 ETF) perpetual futures.
  • US500-BTC: SPY (SPDR S&P 500 ETF) perpetual futures.
  • GOLD-BTC: PAXG (Tokenized Gold) perpetual futures.
  • OIL-BTC: USO (United States Oil Fund) perpetual futures.
For real-time order book updates, use the WebSocket API which provides live depth streams for faster updates.

Trading Instruments

Get available trading symbols

WebSocket Order Book

Real-time order book updates
⌘I