Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

River Markets orderbooks API

The orderbooks API from River Markets — 2 operation(s) for orderbooks.

River Markets orderbooks API is one of 13 APIs that River Markets publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include orderbooks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 2 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.rivermarkets.com.

2 operations 2 paths 6 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.rivermarkets.com
Authentication
API Key, API Key, API Key, HTTP Bearer
License
Proprietary
Resource Areas
1

Authentication & Security 4

River Markets orderbooks API declares 4 security schemes for authenticating requests. An API key is passed in the header as X-River-Key-Id (SignedRequestKeyId). An API key is passed in the header as X-River-Timestamp (SignedRequestTimestamp). An API key is passed in the header as X-River-Signature (SignedRequestSignature). It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • SignedRequestKeyId — UUID of your API key (from Settings → API Keys).
  • SignedRequestTimestamp — Current unix seconds. Must be within 30s of server time.
  • SignedRequestSignature — Base64 Ed25519 signature over the canonical request: METHOD\nPATH\nSORTEDQUERY\nTIMESTAMP\nSHA256(body) hex. See /api-reference/authentication for the full rec…
  • BearerAuth — JWT bearer token for web client authentication.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

orderbooks 2
GET
/v1/orderbooks/generic-asset/{generic_asset_id}
Get Generic Asset Orderbook
get_generic_asset_orderbook_v1_orderbooks_generic_asset__generic_asset_id__get 2 params → 200422
GET
/v1/orderbooks/{river_id}
Get Orderbook
get_orderbook_v1_orderbooks__river_id__get 2 params → 200422

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are OrderbookData (7 properties), ValidationError (5 properties), OrderbookResponse (3 properties), PriceLevelResponse (3 properties). Each schema is shown below with its type and property counts.

OrderbookStatus
string
PriceLevelResponse
object
3 properties 2 required
ValidationError
object
5 properties 3 required
OrderbookResponse
object
3 properties 1 required
OrderbookData
object
7 properties 2 required
HTTPValidationError
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

river-markets-orderbooks-api-openapi.yml Raw ↑

Other APIs River Markets publishes across the network.

River Markets balance API
River Markets complex-orders API
River Markets fair-values API
River Markets fills API
River Markets generic-assets API
River Markets markets API
River Markets orders API
River Markets positions API
River Markets prices API
River Markets subaccounts API
River Markets tradeprints API
River Markets watchlists API