List the caller's orders

curl --request GET \
  --url https://api.omnibook.xyz/v1/portfolio/orders \
  --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/portfolio/orders"

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/portfolio/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "orders": [
    {
      "order_id": "182390",
      "client_order_id": "182390",
      "market_id": 123,
      "side": "buy",
      "outcome": "yes",
      "tick": 5000,
      "qty": 123,
      "tif": "gtc",
      "expiry_ts": "182390",
      "max_cost": "182390",
      "group_id": 123,
      "flags": 123,
      "status": "resting",
      "reason": "<string>",
      "filled_qty": 123,
      "remaining_qty": 123,
      "created_seq": "182390",
      "created_ts": "182390",
      "last_update_seq": "182390"
    }
  ],
  "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"
    }
  }
}

GET

portfolio

orders

List the caller's orders

curl --request GET \
  --url https://api.omnibook.xyz/v1/portfolio/orders \
  --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/portfolio/orders"

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/portfolio/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "orders": [
    {
      "order_id": "182390",
      "client_order_id": "182390",
      "market_id": 123,
      "side": "buy",
      "outcome": "yes",
      "tick": 5000,
      "qty": 123,
      "tif": "gtc",
      "expiry_ts": "182390",
      "max_cost": "182390",
      "group_id": 123,
      "flags": 123,
      "status": "resting",
      "reason": "<string>",
      "filled_qty": 123,
      "remaining_qty": 123,
      "created_seq": "182390",
      "created_ts": "182390",
      "last_update_seq": "182390"
    }
  ],
  "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

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.

Query Parameters

market_id

integer

status

string

Comma-separated list of order statuses to filter by.

Example:

"resting,partially_filled"

client_order_id

string

A u64-domain value rendered as a decimal string.

Pattern: ^[0-9]+$

Example:

"182390"

cursor

string

Opaque pagination cursor from a prior response; omit for the first page.

limit

integer

default:100

Page size.

Required range: 1 <= x <= 1000

Response

A page of order objects.

orders

object[]

required

Hide child attributes

orders.order_id

string | null

required

null until the order reaches the stream

Pattern: ^[0-9]+$

Example:

"182390"

orders.client_order_id

string

required

A u64-domain value rendered as a decimal string.

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.tick

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

orders.qty

integer

required

orders.tif

enum<string>

required

Available options:

gtc,

gtt,

ioc,

fok

orders.expiry_ts

string

required

ns; "0" when not gtt

Pattern: ^[0-9]+$

Example:

"182390"

orders.max_cost

string

required

pips; "0" when unset

Pattern: ^[0-9]+$

Example:

"182390"

orders.group_id

integer

required

orders.flags

integer

required

bitfield: bit0 post_only, bit1 reduce_only, bit2 cancel_on_pause, bit3 stp_maker

orders.status

enum<string>

required

Available options:

resting,

partially_filled,

executed,

canceled,

expired,

rejected

orders.reason

string | null

required

CANCELED/REJECTED reason name when terminal

orders.filled_qty

integer

required

orders.remaining_qty

integer

required

orders.created_seq

string

required

A u64-domain value rendered as a decimal string.

Pattern: ^[0-9]+$

Example:

"182390"

orders.created_ts

string

required

A u64-domain value rendered as a decimal string.

Pattern: ^[0-9]+$

Example:

"182390"

orders.last_update_seq

string

required

A u64-domain value rendered as a decimal string.

Pattern: ^[0-9]+$

Example:

"182390"

cursor

string

required

as_of_seq

string

required

A u64-domain value rendered as a decimal string.

Pattern: ^[0-9]+$

Example:

"182390"

REST

Endpoints

List the caller's orders

Authorizations

Query Parameters

Response