Skip to content

Orders

/v1/orders — place, list, get, and cancel equity orders. Create and cancel are signed money endpoints.

The order object

FieldTypeNotes
order_idstringord_…
client_order_idstring?tenant-unique idempotency key, if supplied
investor_idstring
market_idstringEGX
symbolstring
asset_classstringegx_equity
sidestringbuy | sell
typestringmarket | limit
order_classstringsimple
time_in_forcestringday | gtc | ioc | fok
qtyintwhole shares
limit_price_microsint?for limit orders
statestringinternal lifecycle (see below)
statusstringAlpaca-aligned status
filled_qtyint
avg_price_microsint?filled average price
reason_codestring?on rejection/cancel
created_attimestamp
submitted_attimestamp?
filled_attimestamp?
canceled_attimestamp?
expired_attimestamp?

statestatus: received/transmittedpending_new, validatedaccepted, ackednew, cancel_requestedpending_cancel, cancelledcanceled; partially_filled/filled/rejected/expired pass through.

POST /v1/orders

Create an order. Signed. Body documented in Placing orders.

422 codes: INVALID_SIDE, INVALID_TYPE, INVALID_QTY, INVALID_PRICE, INVALID_TIME_IN_FORCE, TICK_VIOLATION, PRICE_BAND_EXCEEDED, INSUFFICIENT_SETTLED_CASH, INSUFFICIENT_SETTLED_SECURITIES, SUITABILITY_REQUIRED, RISK_ACK_REQUIRED, INVESTOR_RESTRICTED, SHARIAH_RESTRICTED, MARKET_CLOSED (only when not queueable), INSTRUMENT_HALTED, CLIENT_ORDER_ID_EXISTS.

GET /v1/orders

List orders. Query: investor_id, status (open|closed), limit (1–200).

json
{ "orders": [ { …order… } ] }

GET /v1/orders/{id}

The single order object.

DELETE /v1/orders/{id}

Request cancellation (signed, async). The order moves to pending_cancel, then canceled — unless a fill wins the race. 422 ORDER_NOT_CANCELLABLE if it's already terminal.

GET /v1/orders/{id}/contract-note

The settlement contract note for a filled order (trade/settlement dates, fees, withholding, net consideration, per-fill breakdown). 422 NO_EXECUTIONS before the first fill.

Embedded investing infrastructure for the Egyptian Exchange. Sandbox runs on simulated money.