Place up to 20 orders

curl --request POST \
  --url https://api.omnibook.xyz/v1/portfolio/orders/batch \
  --header 'Content-Type: application/json' \
  --header 'DX-ACCESS-KEY: <api-key>' \
  --header 'DX-ACCESS-SIGNATURE: <api-key>' \
  --header 'DX-ACCESS-TIMESTAMP: <api-key>' \
  --data '
{
  "orders": [
    {
      "client_order_id": "182390",
      "market_id": 123,
      "qty": 2,
      "tick": 5000,
      "worst_tick": 5000,
      "expiry_ts": "182390",
      "max_cost": "182390",
      "group_id": 0,
      "post_only": false,
      "reduce_only": false,
      "cancel_on_pause": false,
      "stp_maker": false
    }
  ]
}
'

import requests

url = "https://api.omnibook.xyz/v1/portfolio/orders/batch"

payload = { "orders": [
        {
            "client_order_id": "182390",
            "market_id": 123,
            "qty": 2,
            "tick": 5000,
            "worst_tick": 5000,
            "expiry_ts": "182390",
            "max_cost": "182390",
            "group_id": 0,
            "post_only": False,
            "reduce_only": False,
            "cancel_on_pause": False,
            "stp_maker": False
        }
    ] }
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({
    orders: [
      {
        client_order_id: '182390',
        market_id: 123,
        qty: 2,
        tick: 5000,
        worst_tick: 5000,
        expiry_ts: '182390',
        max_cost: '182390',
        group_id: 0,
        post_only: false,
        reduce_only: false,
        cancel_on_pause: false,
        stp_maker: false
      }
    ]
  })
};

fetch('https://api.omnibook.xyz/v1/portfolio/orders/batch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "order_id": "182390",
    "client_order_id": "182390",
    "status": "resting",
    "seq": "182390",
    "filled_qty": 123,
    "resting_qty": 123,
    "fills": [
      {
        "tick_yes": 5000,
        "qty": 123,
        "path": "direct"
      }
    ],
    "reason": "<string>"
  }
]

{
  "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"
    }
  }
}

{
  "error": {
    "code": "shed",
    "num": null,
    "origin": "gateway",
    "message": "shed",
    "details": null
  }
}

POST

portfolio

orders

batch

Place up to 20 orders

curl --request POST \
  --url https://api.omnibook.xyz/v1/portfolio/orders/batch \
  --header 'Content-Type: application/json' \
  --header 'DX-ACCESS-KEY: <api-key>' \
  --header 'DX-ACCESS-SIGNATURE: <api-key>' \
  --header 'DX-ACCESS-TIMESTAMP: <api-key>' \
  --data '
{
  "orders": [
    {
      "client_order_id": "182390",
      "market_id": 123,
      "qty": 2,
      "tick": 5000,
      "worst_tick": 5000,
      "expiry_ts": "182390",
      "max_cost": "182390",
      "group_id": 0,
      "post_only": false,
      "reduce_only": false,
      "cancel_on_pause": false,
      "stp_maker": false
    }
  ]
}
'

import requests

url = "https://api.omnibook.xyz/v1/portfolio/orders/batch"

payload = { "orders": [
        {
            "client_order_id": "182390",
            "market_id": 123,
            "qty": 2,
            "tick": 5000,
            "worst_tick": 5000,
            "expiry_ts": "182390",
            "max_cost": "182390",
            "group_id": 0,
            "post_only": False,
            "reduce_only": False,
            "cancel_on_pause": False,
            "stp_maker": False
        }
    ] }
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({
    orders: [
      {
        client_order_id: '182390',
        market_id: 123,
        qty: 2,
        tick: 5000,
        worst_tick: 5000,
        expiry_ts: '182390',
        max_cost: '182390',
        group_id: 0,
        post_only: false,
        reduce_only: false,
        cancel_on_pause: false,
        stp_maker: false
      }
    ]
  })
};

fetch('https://api.omnibook.xyz/v1/portfolio/orders/batch', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "order_id": "182390",
    "client_order_id": "182390",
    "status": "resting",
    "seq": "182390",
    "filled_qty": 123,
    "resting_qty": 123,
    "fills": [
      {
        "tick_yes": 5000,
        "qty": 123,
        "path": "direct"
      }
    ],
    "reason": "<string>"
  }
]

{
  "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"
    }
  }
}

{
  "error": {
    "code": "shed",
    "num": null,
    "origin": "gateway",
    "message": "shed",
    "details": null
  }
}

Authorizations

DX-ACCESS-KEY

string

header

required

The public API key (alphanumeric access_key string).

DX-ACCESS-TIMESTAMP

string

header

required

Request timestamp, Unix milliseconds (decimal). ±5000 ms replay window.

DX-ACCESS-SIGNATURE

string

header

required

base64(HMAC-SHA256(secret, "timestamp\nMETHOD\npath?query\nbody")). For the WS handshake the body is empty and the path is /v1/ws.

Body

application/json

orders

object[]

required

Required array length: 1 - 20 elements

Hide child attributes

orders.client_order_id

string

required

idempotency key

Pattern: ^[0-9]+$

Example:

"182390"

orders.market_id

integer

required

orders.side

enum<string>

required

Available options:

buy,

sell

orders.outcome

enum<string>

required

Available options:

yes,

no

orders.type

enum<string>

required

Available options:

limit,

market

orders.qty

integer

required

Required range: x >= 1

orders.tick

integer

limit only

Required range: 1 <= x <= 9999

orders.worst_tick

integer

market only, optional; marketable-limit bound (default 9999 buy / 1 sell)

Required range: 1 <= x <= 9999

orders.tif

enum<string>

limit only; market ⇒ forced ioc

Available options:

gtc,

gtt,

ioc,

fok

orders.expiry_ts

string

ns; gtt only

Pattern: ^[0-9]+$

Example:

"182390"

orders.max_cost

string

pips; required for market buys

Pattern: ^[0-9]+$

Example:

"182390"

orders.group_id

integer

default:0

orders.post_only

boolean

default:false

orders.reduce_only

boolean

default:false

orders.cancel_on_pause

boolean

default:false

orders.stp_maker

boolean

default:false

Response

Per-item, index-aligned results.

Option 1
Option 2

The sequenced placement outcome.

order_id

string

required

A u64-domain value rendered as a decimal string.

Pattern: ^[0-9]+$

Example:

"182390"

client_order_id

string

required

A u64-domain value rendered as a decimal string.

Pattern: ^[0-9]+$

Example:

"182390"

status

enum<string>

required

Available options:

resting,

partially_filled,

executed,

canceled

seq

string

required

the NEW_ORDER's stamp

Pattern: ^[0-9]+$

Example:

"182390"

filled_qty

integer

required

resting_qty

integer

required

fills

object[]

required

Hide child attributes

fills.tick_yes

integer

required

Price tick in pips, in the outcome's own space. 1 pip = 0.01¢. Domain 1–9999 (4700 = 47.00¢). Old 1–99 cents are rejected.

Required range: 1 <= x <= 9999

fills.qty

integer

required

fills.path

enum<string>

required

The FILL path flag.

Available options:

direct,

mint,

merge

reason

string | null

present when status is canceled

REST

Endpoints

Place up to 20 orders

Authorizations

Body

Response