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

# Get Orderbook

`GET /v1/orderbooks/{river_id}`

## Request

- Base URL: `https://api.rivermarkets.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.rivermarkets.com/v1/orderbooks/{river_id}`
- Auth: none declared

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, nullable: Exchange orderbook timestamp (UTC)
  - `message` string, nullable

## Other responses

- `422`: Validation Error

## Changes

- **2026-10-07** `7fb1b5dd2cae`: 1 breaking
  - the `orderbook/anyOf[subschema #1: OrderbookData]/exchange_timestamp/anyOf[subschema #1]/` response's property format changed from `date-time` to no format for status `200`

[Operation history](https://skmtc.dev/rivermarkets/apis/river-finance-api/changes/v1/orderbooks/:river_id/get.md)

---

[API](https://skmtc.dev/rivermarkets/apis/river-finance-api.md) - [All operations](https://skmtc.dev/rivermarkets/apis/river-finance-api/llms.txt) - [OpenAPI document](https://skmtc.dev/rivermarkets/apis/river-finance-api/revisions/3732aea08430?raw)