v1

latestOpenAPI 3.1.02026-07-24680631.6 KB

Create Order

Create an order for a particular account.

post/orders

Headers

api-keystring required

API key

auth-keystring required

Auth key generated using API key & secret

Request body

customerIdstring required

Customer identifier

symbolstring required

Stock/Stack ticker

typestring required

Order type. Options: •"MARKET" - Market order •"STOP" - Stop order •"LIMIT" - Limit order

sidestring required

Order side. Options: •"BUY" - Buy •"SELL" - Sell

quantitynumber float

Order quantity in share amounts for all order types. Only required if amount is null. Required when type is LIMIT or STOP

amountnumber float

Order quantity in USD cash amount for "MARKET" order type. Only required if quantity is null

categorystring

Options: •"EQUITY" •"STACK"

pricenumber float

Price for either non-MARKET order types. Required when type is LIMIT or STOP

sellOptionstring

Applicable in case of STACK SellOption = ALL (while selling the whole quantity) SellOption = “” (otherwise)

Response

200

OR

Example response

{
  "status": 200,
  "orderId": "<Order Identifier>"
}