Skip to main content
GET
Order book at a point in time

Authorizations

X-API-Key
string
header
required

Your Hypedexer API key. Create one in the console at https://app.hypedexer.com. Authorization: Bearer <key> and the api_key query parameter are accepted as well.

Path Parameters

coin
string
required

Coin symbol (e.g. BTC, @107 for a spot pair, xyz:TSLA for HIP-3)

Query Parameters

at
string<date-time>
required

Timestamp (ISO UTC); the book as of the end of that minute is returned

levels
integer
default:20

Levels per side (max 20 from minute states, 50 from full snapshots)

Required range: 1 <= x <= 50
source
enum<string>
default:minute

minute = end-of-minute reconstructed state (default); snapshot = nearest full snapshot at or before at (~every 10 min)

Available options:
minute,
snapshot

Response

OK

The response is of type object.