ord_ id.
Order types
| Type | Description | Requires |
|---|---|---|
market | Executes immediately at the current price | quantity or notional |
limit | Executes only at the limit price or better | quantity, limit_price |
stop | Triggers a market order when price hits the stop | quantity, stop_price |
stop_limit | Triggers a limit order when price hits the stop | quantity, stop_price, limit_price |
trailing_stop | Stop that trails the market by an offset | quantity, trail_price or trail_percent |
Sizing: quantity vs notional
quantity— number of shares (e.g."10"). The field isquantity, notqty.notional— a cash amount to invest (e.g."1000.00"),marketorders only.
quantity.
Time in force
| Value | Meaning |
|---|---|
day | Valid for the current session; canceled at close if unfilled |
gtc | Good ‘til canceled |
opg | At the opening auction |
cls | At the closing auction |
ioc | Immediate or cancel — fill what’s available now, cancel the rest |
fok | Fill or kill — fill entirely at once or cancel |
Wallet currency
Passwallet_currency (USD, NGN, GBP, EUR, KES) to settle the trade from a specific wallet. When omitted it defaults to USD.
Order lifecycle
| Status | Meaning |
|---|---|
open | Resting at the custodian, awaiting execution |
pending | Accepted and queued |
partial | Some shares filled, remainder active |
filled | Fully executed |
cancelled | Canceled by user or system |
failed | Rejected (insufficient funds, invalid symbol, market closed) |
filled_quantity, remaining_quantity, average_price, and the submitted_at / filled_at / cancelled_at timestamps. Fetch a single order at /v1/investors/{investor_id}/orders/{order_id}.
For placing, estimating, and canceling orders step by step, see the journey guide:
Place orders. Order schemas are in the
API reference.