Place Order

post/api/prime/trading/v1/accounts/{accountId}/orders

Places a new order. There are several types of orders available - Market, Limit, and TWAP (with or without a limit). Orders can only be placed if your account has a sufficient balance. When an order is placed, funds will be reserved for the amount of the order.

Path Parameters

  • accountIdstringRequired
    The id of the trading account to retrieve

Request Body

One of
clientOrderId string
product string required
Product name e.g. BTC-USD
type string required
Must be set to "market"
side string required
Allowed values: buy sell
quantity string <decimal>required
quantityCurrency string required
The quantity currency must be in quote currency for buy and base currency for sell. e.g. If product is BTC-USD, the base currency will be BTC.

200 Response

id string <uuid>required
accountId string required
clientOrderId string
time string <date-time>required
DEPRECATED
creationDate string <date-time>required
scheduledDate string <date-time>
lastFillDate string <date-time>
completionDate string <date-time>required
settleDate string <date-time>
type string required
fundingType string required
Allowed values: margin funded
status string required
Allowed values: pending_open open completed pending_cancel canceled error
product string required
Product name e.g. BTC-USD
side string required
Allowed values: buy sell
quantity string <decimal>required
The specified quantity.
quantityCurrency string required
The specified quantity currency.
filledQuantity string <decimal>required
averagePrice string <decimal>required

default Response

error string required
errorName string required
reqId string required