The authenticated key's own scopes and rate limits
curl --request GET \
--url https://api.omnibook.xyz/v1/account/limits \
--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/account/limits"
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/account/limits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"scopes": [
"read",
"trade"
],
"read": {
"sustained_rate_per_s": 100,
"burst": 200
},
"write": {
"sustained_rate_per_s": 50,
"burst": 50
},
"cancel": {
"sustained_rate_per_s": 100,
"burst": 100
},
"trailing_volume_30d": "0",
"write_floor": 20,
"usd_per_extra_rps": 100000,
"batch_cap": 20,
"response_budget_ms": 2000
}{
"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"
}
}
}The authenticated key's own scopes and rate limits
Reports the calling key’s scopes, effective read/write/cancel token
buckets, trailing 30-day fill volume, write-rate floor, dollars per extra
write/s, batch cap, and per-request response budget.
Answered from the key record + gateway config, so it carries no
as_of_seq. There are no named usage tiers.
GET
/
v1
/
account
/
limits
The authenticated key's own scopes and rate limits
curl --request GET \
--url https://api.omnibook.xyz/v1/account/limits \
--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/account/limits"
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/account/limits', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"scopes": [
"read",
"trade"
],
"read": {
"sustained_rate_per_s": 100,
"burst": 200
},
"write": {
"sustained_rate_per_s": 50,
"burst": 50
},
"cancel": {
"sustained_rate_per_s": 100,
"burst": 100
},
"trailing_volume_30d": "0",
"write_floor": 20,
"usd_per_extra_rps": 100000,
"batch_cap": 20,
"response_budget_ms": 2000
}{
"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.
Response
The key's scopes and limits.
The authenticated key's scopes and limits.
Available options:
read, trade, withdraw Trailing 30-day fill shares (SUM qty) for this user_id.
Pattern:
^[0-9]+$Example:
"182390"
⌘I