curl --request POST \
--url https://api.omnibook.xyz/v1/portfolio/deadman \
--header 'Content-Type: application/json' \
--header 'DX-ACCESS-KEY: <api-key>' \
--header 'DX-ACCESS-SIGNATURE: <api-key>' \
--header 'DX-ACCESS-TIMESTAMP: <api-key>' \
--data '
{
"timeout_ms": 30500
}
'import requests
url = "https://api.omnibook.xyz/v1/portfolio/deadman"
payload = { "timeout_ms": 30500 }
headers = {
"DX-ACCESS-KEY": "<api-key>",
"DX-ACCESS-TIMESTAMP": "<api-key>",
"DX-ACCESS-SIGNATURE": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'DX-ACCESS-KEY': '<api-key>',
'DX-ACCESS-TIMESTAMP': '<api-key>',
'DX-ACCESS-SIGNATURE': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({timeout_ms: 30500})
};
fetch('https://api.omnibook.xyz/v1/portfolio/deadman', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"timeout_ms": 5000,
"armed": true
}{
"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"
}
}
}Arm / refresh the dead-man switch
Arm (or heartbeat-refresh) the caller’s gateway dead-man switch. Sets the deadline to now + timeout_ms;
calling again refreshes it. When a tick reaches an armed deadline the
gateway fires one user-wide MASS_CANCEL and disarms (fire-once). This is
the gateway fairy dead-man, NOT Kalshi order-group fill-velocity limiting
(which stays deferred). Closed schema — an unknown field is 400 unknown_field; a timeout_ms outside 1000..=60000 is 400 invalid_timeout.
curl --request POST \
--url https://api.omnibook.xyz/v1/portfolio/deadman \
--header 'Content-Type: application/json' \
--header 'DX-ACCESS-KEY: <api-key>' \
--header 'DX-ACCESS-SIGNATURE: <api-key>' \
--header 'DX-ACCESS-TIMESTAMP: <api-key>' \
--data '
{
"timeout_ms": 30500
}
'import requests
url = "https://api.omnibook.xyz/v1/portfolio/deadman"
payload = { "timeout_ms": 30500 }
headers = {
"DX-ACCESS-KEY": "<api-key>",
"DX-ACCESS-TIMESTAMP": "<api-key>",
"DX-ACCESS-SIGNATURE": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'DX-ACCESS-KEY': '<api-key>',
'DX-ACCESS-TIMESTAMP': '<api-key>',
'DX-ACCESS-SIGNATURE': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({timeout_ms: 30500})
};
fetch('https://api.omnibook.xyz/v1/portfolio/deadman', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"timeout_ms": 5000,
"armed": true
}{
"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.
Body
Arm / refresh the dead-man switch.
Heartbeat budget in milliseconds. On the first tick at or after now + timeout_ms the gateway fires one user-wide MASS_CANCEL and disarms (fire-once). Re-arm to refresh the deadline.
1000 <= x <= 60000