Decrease an order's quantity (absolute target)
curl --request POST \
--url https://api.omnibook.xyz/v1/portfolio/orders/{order_id}/decrease \
--header 'Content-Type: application/json' \
--header 'DX-ACCESS-KEY: <api-key>' \
--header 'DX-ACCESS-SIGNATURE: <api-key>' \
--header 'DX-ACCESS-TIMESTAMP: <api-key>' \
--data '{
"new_qty": 1
}'import requests
url = "https://api.omnibook.xyz/v1/portfolio/orders/{order_id}/decrease"
payload = { "new_qty": 1 }
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({new_qty: 1})
};
fetch('https://api.omnibook.xyz/v1/portfolio/orders/{order_id}/decrease', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "decreased",
"new_qty": 300,
"seq": "182402"
}{
"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": "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"
}
}
}{
"error": {
"code": "sequencing_timeout",
"num": null,
"origin": "gateway",
"message": "sequencing_timeout",
"details": null
}
}Decrease an order's quantity (absolute target)
new_qty is an absolute target, not a delta — idempotent resends.
Decrease-in-place keeps time priority; there is no amend endpoint
(increase or reprice = cancel + new).
POST
/
v1
/
portfolio
/
orders
/
{order_id}
/
decrease
Decrease an order's quantity (absolute target)
curl --request POST \
--url https://api.omnibook.xyz/v1/portfolio/orders/{order_id}/decrease \
--header 'Content-Type: application/json' \
--header 'DX-ACCESS-KEY: <api-key>' \
--header 'DX-ACCESS-SIGNATURE: <api-key>' \
--header 'DX-ACCESS-TIMESTAMP: <api-key>' \
--data '{
"new_qty": 1
}'import requests
url = "https://api.omnibook.xyz/v1/portfolio/orders/{order_id}/decrease"
payload = { "new_qty": 1 }
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({new_qty: 1})
};
fetch('https://api.omnibook.xyz/v1/portfolio/orders/{order_id}/decrease', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"status": "decreased",
"new_qty": 300,
"seq": "182402"
}{
"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": "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"
}
}
}{
"error": {
"code": "sequencing_timeout",
"num": null,
"origin": "gateway",
"message": "sequencing_timeout",
"details": null
}
}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
A u64-domain value rendered as a decimal string.
Pattern:
^[0-9]+$Example:
"182390"
Body
application/json
absolute target
Required range:
x >= 0⌘I