Order Updates (Real-Time)

Stream real-time order status changes (fills, partial fills, rejections and cancellations) directly into your Python strategy through the Tradeboard WebSocket feed. This is an account-level stream: unlike LTP/Quote/Depth there are no instruments to subscribe; one call covers every order in the connected broker account (and sandbox orders in analyze mode).

---

Methods

Method	Purpose
subscribe_orders(on_order_update)	Start the stream; optional callback per update
unsubscribe_orders()	Stop the stream
get_orders()	Cached updates received so far, most recent first, capped at 500

The subscription survives reconnects: the SDK's auto-reconnect replays it after re-authentication, exactly like market-data subscriptions. get_orders() returns {"orders": [...]} with the newest update first.

Both calls require an authenticated connection, so call client.connect() first; subscribe_orders() returns False if the client is not connected and authenticated.

---

Usage

from tradeboard import api
import time

client = api(
    api_key="your_api_key_here",
    host="http://127.0.0.1:5000",
    ws_url="ws://127.0.0.1:8765"
)

def on_order_update(update):
    print(
        f"{update['orderid']} | {update['symbol']} | {update['order_status']} "
        f"| filled {update['filled_quantity']}/{update['quantity']} "
        f"@ {update['average_price']}"
    )

client.connect()
client.subscribe_orders(on_order_update=on_order_update)

# ... place orders from anywhere (API, web UI, mobile app) ...
time.sleep(60)

client.unsubscribe_orders()
client.disconnect()

---

Update Format

Each callback receives Tradeboard's common order format, the same constants used by the REST order APIs:

{
  "type": "order_update",
  "user_id": "tradeboard-user",
  "mode": "live",
  "broker": "upstox",
  "orderid": "240221025997024",
  "symbol": "RELIANCE",
  "exchange": "NSE",
  "action": "BUY",
  "quantity": 10,
  "price": 1424.0,
  "trigger_price": 0,
  "pricetype": "LIMIT",
  "product": "MIS",
  "order_status": "complete",
  "filled_quantity": 10,
  "pending_quantity": 0,
  "average_price": 1423.85,
  "rejection_reason": ""
}

Field	Values
mode	live (broker feed) or analyze (sandbox engine)
action	BUY / SELL
pricetype	MARKET / LIMIT / SL / SL-M
product	CNC / NRML / MIS
order_status	open / trigger pending / complete / rejected / cancelled (+ broker extras)
rejection_reason	Populated when order_status is rejected

---

Notes

• Sandbox (analyze mode) fires the same updates for order placements (open), engine fills, rejections, and cancellations, so you can test end-to-end without a live broker.
• Broker coverage: Zerodha, Dhan, Fyers, Upstox, AliceBlue, Definedge, IndMoney, Angel One, Nubra, Arrow, IIFL Capital and Kotak stream natively through each broker's own push channel. Brokers with no push mechanism (Groww, for example) are covered by server-side orderbook polling (ORDER_POLL_INTERVAL, default 5 seconds).
• On production deployments the /postback/<broker> HTTPS webhook receivers feed the same stream. If both a broker WebSocket and a postback are configured the same transition can arrive twice, so deduplicate on orderid + order_status + filled_quantity.
• The adapter lifecycle is automatic: it starts on broker login, restarts on a real token change (daily rollover), and stops on logout. Set ORDER_UPDATES_ENABLED=FALSE in the Tradeboard server .env to disable the whole stream; it is TRUE by default, and no client-side flag is needed.
• With verbose=2, each update is also printed with the [ORDER] log tag.