Skip to main content
GET
cURL
2 credits per request

  • The live order book straight from the CLOB (never stored): best bid/ask, spread, midpoint, and best-first bid/ask levels per outcome.
  • Both outcome books in one call (mirrored for binary markets); use outcome to fetch just one, and depth to cap levels per side.
  • Summary fields (bidLevels, bidDepth, …) always describe the whole book; a one-sided book is normal near resolution.

Authorizations

X-API-KEY
string
header
required

API key required to access the endpoints. Generate one from your dashboard at https://openapi.coinstats.app and pass it in the X-API-KEY request header. Never expose your key in client-side code.

Path Parameters

slug
string
required

Query Parameters

depth
number

Max levels returned per side (default: all).

Required range: 1 <= x <= 500
outcome
enum<string>

Return a single outcome's book instead of both.

Available options:
yes,
no

Response

success
boolean
required

Whether the request succeeded

Example:

true

timestamp
string
required

ISO 8601 timestamp the response was generated

Example:

"2025-06-19T12:00:00.000Z"

data
object
required
cached
boolean