---
title: "Get Orderbook"
method: GET
path: "/v1/orderbooks/{river_id}"
tags: ["orderbooks"]
---

# Get Orderbook

`GET /v1/orderbooks/{river_id}`

Get orderbook for a river_id.

## Path parameters

- `river_id` integer, required

## Query parameters

- `levels` integer — Number of price levels to return

## Response `200`

Successful Response

- OrderbookResponse
  - `status` 'ok' | 'pending' | 'not_found', required
  - `orderbook` OrderbookData
    - `river_id` integer, nullable
    - `generic_asset_id` string, uuid, nullable
    - `bids` PriceLevelResponse[], required
      - `price` number, required
      - `qty` number, required
      - `breakdown` object
    - `asks` PriceLevelResponse[], required
      - `price` number, required
      - `qty` number, required
      - `breakdown` object
    - `best_bid_price` number, nullable
    - `best_ask_price` number, nullable
    - `exchange_timestamp` string, date-time, nullable — Exchange orderbook timestamp (UTC)
  - `message` string, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/rivermarkets/apis/river-finance-api.md) · [All operations](https://skmtc.net/rivermarkets/apis/river-finance-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rivermarkets/river-finance-api/revisions/3776a0431319/schema)