curl --request GET \
--url https://api.omnibook.xyz/v1/markets/{market_id}/orderbook \
--header 'DX-ACCESS-KEY: <api-key>' \
--header 'DX-ACCESS-SIGNATURE: <api-key>' \
--header 'DX-ACCESS-TIMESTAMP: <api-key>'import requests
url = "https://api.omnibook.xyz/v1/markets/{market_id}/orderbook"
headers = {
"DX-ACCESS-KEY": "<api-key>",
"DX-ACCESS-TIMESTAMP": "<api-key>",
"DX-ACCESS-SIGNATURE": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'DX-ACCESS-KEY': '<api-key>',
'DX-ACCESS-TIMESTAMP': '<api-key>',
'DX-ACCESS-SIGNATURE': '<api-key>'
}
};
fetch('https://api.omnibook.xyz/v1/markets/{market_id}/orderbook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"market_id": 71,
"yes": [
[
2400,
1200
],
[
2300,
800
]
],
"no": [
[
6500,
950
],
[
6400,
400
]
],
"tick_size": {
"type": "tick_size",
"market_id": 71,
"policy": "narrow",
"mode": "cent",
"tick_step": 10,
"wing_lo": 400,
"wing_hi": 9600
},
"as_of_seq": "182390"
}{
"error": {
"code": "unauthorized",
"num": null,
"origin": "gateway",
"message": "unauthorized",
"details": null
}
}{
"error": {
"code": "missing_scope",
"num": null,
"origin": "gateway",
"message": "missing_scope",
"details": null
}
}{
"error": {
"code": "unknown_order",
"num": 260,
"origin": "core",
"message": "unknown_order",
"details": null
}
}{
"error": {
"code": "rate_limited",
"num": null,
"origin": "gateway",
"message": "rate limited",
"details": {
"retry_after_ms": "10"
}
}
}L2 orderbook (bids-only, both sides)
Bids only, both sides. yes = YES bids at YES-space
ticks; no = NO bids at NO-space ticks; each best-first. A NO bid at
t is the YES ask at 10000 − t — asks are derivable, never sent.
Ticks are pips (3500 = 35.00¢). Level entries are
[tick, aggregate_qty]; per-order data is never published. The
snapshot includes tick_size (live rest grid).
curl --request GET \
--url https://api.omnibook.xyz/v1/markets/{market_id}/orderbook \
--header 'DX-ACCESS-KEY: <api-key>' \
--header 'DX-ACCESS-SIGNATURE: <api-key>' \
--header 'DX-ACCESS-TIMESTAMP: <api-key>'import requests
url = "https://api.omnibook.xyz/v1/markets/{market_id}/orderbook"
headers = {
"DX-ACCESS-KEY": "<api-key>",
"DX-ACCESS-TIMESTAMP": "<api-key>",
"DX-ACCESS-SIGNATURE": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'DX-ACCESS-KEY': '<api-key>',
'DX-ACCESS-TIMESTAMP': '<api-key>',
'DX-ACCESS-SIGNATURE': '<api-key>'
}
};
fetch('https://api.omnibook.xyz/v1/markets/{market_id}/orderbook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"market_id": 71,
"yes": [
[
2400,
1200
],
[
2300,
800
]
],
"no": [
[
6500,
950
],
[
6400,
400
]
],
"tick_size": {
"type": "tick_size",
"market_id": 71,
"policy": "narrow",
"mode": "cent",
"tick_step": 10,
"wing_lo": 400,
"wing_hi": 9600
},
"as_of_seq": "182390"
}{
"error": {
"code": "unauthorized",
"num": null,
"origin": "gateway",
"message": "unauthorized",
"details": null
}
}{
"error": {
"code": "missing_scope",
"num": null,
"origin": "gateway",
"message": "missing_scope",
"details": null
}
}{
"error": {
"code": "unknown_order",
"num": 260,
"origin": "core",
"message": "unknown_order",
"details": null
}
}{
"error": {
"code": "rate_limited",
"num": null,
"origin": "gateway",
"message": "rate limited",
"details": {
"retry_after_ms": "10"
}
}
}Authorizations
The public API key (alphanumeric access_key string).
Request timestamp, Unix milliseconds (decimal). ±5000 ms replay window.
base64(HMAC-SHA256(secret, "timestamp\nMETHOD\npath?query\nbody")). For the WS handshake the body is empty and the path is /v1/ws.
Path Parameters
Query Parameters
Levels per side.
1 <= x <= 99Response
The L2 book.
Bids only, both sides.
Advertised rest grid (live v1 policy is narrow: whole cents on [wing_lo, wing_hi], wing_step pips outside). Present on market and orderbook snapshots.
Hide child attributes
Hide child attributes
tick_size Named grid (narrow, medium, broadband, custom). Live v1 is narrow.
cent, subcent Wing step in pips. v1 is 10 (0.10¢).
Interior lower bound in pips (400 = 4.00¢ on narrow).
Interior upper bound in pips (9600 = 96.00¢ on narrow).
A u64-domain value rendered as a decimal string.
^[0-9]+$"182390"