curl --request GET \
--url https://api.omnibook.xyz/v1/markets \
--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"
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', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"markets": [
{
"market_id": 123,
"status": "created",
"title": "<string>",
"best_yes_bid": 123,
"best_yes_ask": 123,
"display_tick": 123,
"last_tick_yes": 123,
"volume": "182390",
"open_interest": "182390",
"position_limit": 123,
"fee_schedule_id": 123,
"tick_size": {
"type": "tick_size",
"market_id": 123,
"policy": "<string>",
"mode": "cent",
"tick_step": 123,
"wing_lo": 123,
"wing_hi": 123
},
"close_ts": "<string>"
}
],
"cursor": "<string>",
"as_of_seq": "182390"
}{
"error": {
"code": "unknown_field",
"num": null,
"origin": "gateway",
"message": "unknown_field",
"details": null
}
}{
"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": "rate_limited",
"num": null,
"origin": "gateway",
"message": "rate limited",
"details": {
"retry_after_ms": "10"
}
}
}List markets
curl --request GET \
--url https://api.omnibook.xyz/v1/markets \
--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"
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', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"markets": [
{
"market_id": 123,
"status": "created",
"title": "<string>",
"best_yes_bid": 123,
"best_yes_ask": 123,
"display_tick": 123,
"last_tick_yes": 123,
"volume": "182390",
"open_interest": "182390",
"position_limit": 123,
"fee_schedule_id": 123,
"tick_size": {
"type": "tick_size",
"market_id": 123,
"policy": "<string>",
"mode": "cent",
"tick_step": 123,
"wing_lo": 123,
"wing_hi": 123
},
"close_ts": "<string>"
}
],
"cursor": "<string>",
"as_of_seq": "182390"
}{
"error": {
"code": "unknown_field",
"num": null,
"origin": "gateway",
"message": "unknown_field",
"details": null
}
}{
"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": "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.
Query Parameters
Comma-separated list of market statuses to filter by.
"trading,proposed"
Opaque pagination cursor from a prior response; omit for the first page.
Page size.
1 <= x <= 1000Response
A page of market objects.
Hide child attributes
Hide child attributes
created, trading, frozen, proposed, resolved, archived projection metadata (non-normative)
cumulative shares traded
^[0-9]+$"182390"
outstanding pairs (= pool / $1)
^[0-9]+$"182390"
0 = unlimited
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).
projection metadata
A u64-domain value rendered as a decimal string.
^[0-9]+$"182390"