Skip to main content
POST
Places a fill-or-kill order to buy or sell an asset between two accounts of a user. The origin and destination accounts must belong to the same user. On a sell the origin holds the base asset and the destination the quote asset, and a buy is the other way round. The order is sized by its quantity of the base asset. A 201 means the order was created, not that it traded: check its status and timeline. Replay the same clientOrderId after a 5xx or a timeout before sending a new one. Read more about orders.

Authorizations

Authorization
string
header
required

OAuth 2.0

Scopes

trading.orders:create

Grants access to create orders.

Body

application/json
clientOrderId
string
required

A unique key you choose for the order. Replaying it returns the existing order.

Required string length: 1 - 64
side
enum<string>
required

Whether the base asset is bought or sold.

Available options:
buy,
sell
type
enum<string>
required

The type of the order.

Available options:
market,
limit
origin
object
required

The account the traded amount leaves.

destination
object
required

The account the proceeds are credited to.

quantity
string
required

The quantity of the base asset to trade.

Pattern: ^(?!0+(\.0+)?$)\d+(\.\d+)?$
timeInForce
enum<string>
required

How long the order stays active. Only fok is supported for now.

Available options:
fok
price
string

The limit price, in the quote asset per one unit of the base asset. Required on a limit order, and not allowed on a market order.

Pattern: ^(?!0+(\.0+)?$)\d+(\.\d+)?$

Response

Order already existed.

order
object
required