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-api-key: <api-key>'
{
  "status": "ok",
  "orderbook": {
    "bids": [
      {
        "price": 123,
        "qty": 123
      }
    ],
    "asks": [
      {
        "price": 123,
        "qty": 123
      }
    ],
    "river_id": 123,
    "custom_asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "best_bid_price": 123,
    "best_ask_price": 123,
    "exchange_timestamp": "2023-11-07T05:31:56Z"
  },
  "message": "<string>"
}

Authorizations

x-api-key
string
header
required

API key for programmatic access. Generate one at app.rivermarkets.com under Settings → API Keys.

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