---
title: "Get orderbook snapshot"
method: GET
path: "/v1/orderbook/snapshot"
tags: ["Market"]
---

# Get orderbook snapshot

`GET /v1/orderbook/snapshot`

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

## Query parameters

- `instType` 'perpetual' | 'spot' | 'btc' | 'digital' | 'stock' | 'index', required
- `levels` integer, nullable
- `symbol` string, required
- `unit` 'sats' | 'btc'

## Response `200`

- ApiResponseForOrderbookSnapshot — Represents a successful API response wrapper
  - `data` OrderbookSnapshot, required
    - `buySellVersus` BuyVsSells, required
      - `buy` string, required — The total buy amount
      - `sell` string, required — The total sell amount
    - `buys` PriceLevel[], required — The list of buy price levels and their quantities
      - `price` string, required
      - `size` string, required
      - `total` string, required
    - `instrumentId` string, required — The UUID of the instrument this snapshot is for
    - `sells` PriceLevel[], required — The list of sell price levels and their quantities
      - `price` string, required
      - `size` string, required
      - `total` string, required
  - `error` boolean, required

---

[API](https://skmtc.net/roxom/apis/portico-api.md) · [All operations](https://skmtc.net/roxom/apis/portico-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/roxom/portico-api/revisions/a7839cbefd8e/schema)