Skip to main content
GET
/
v1
/
orderbooks
/
{river_id}
Get Orderbook
curl --request GET \
  --url https://api.rivermarkets.com/v1/orderbooks/{river_id} \
  --header 'X-River-Key-Id: <api-key>' \
  --header 'X-River-Signature: <api-key>' \
  --header 'X-River-Timestamp: <api-key>'
{
  "orderbook": {
    "bids": [
      {
        "price": 123,
        "qty": 123,
        "breakdown": {}
      }
    ],
    "asks": [
      {
        "price": 123,
        "qty": 123,
        "breakdown": {}
      }
    ],
    "river_id": 123,
    "generic_asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "best_bid_price": 123,
    "best_ask_price": 123,
    "exchange_timestamp": "2023-11-07T05:31:56Z"
  },
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.rivermarkets.com/llms.txt

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

Authorizations

X-River-Key-Id
string
header
required

UUID of your API key (from Settings → API Keys).

X-River-Timestamp
string
header
required

Current unix seconds. Must be within 30s of server time.

X-River-Signature
string
header
required

Base64 Ed25519 signature over the canonical request: METHOD\nPATH\nSORTED_QUERY\nTIMESTAMP\nSHA256(body) hex. See /api-reference/authentication for the full recipe.

Path Parameters

river_id
integer
required

Query Parameters

levels
integer
default:10

Number of price levels to return

Required range: 1 <= x <= 10

Response

Successful Response

status
enum<string>
required
Available options:
ok,
pending,
not_found
orderbook
OrderbookData · object
message
string | null