Create Order

curl --request POST \
  --url https://api.orderly.org/v1/order \
  --header 'Content-Type: application/json' \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>' \
  --data '
{
  "symbol": "PERP_ETH_USDC",
  "order_type": "<string>",
  "side": "<string>",
  "client_order_id": "<string>",
  "order_price": 123,
  "order_quantity": 123,
  "order_amount": 123,
  "visible_quantity": 123,
  "reduce_only": true,
  "slippage": 123,
  "order_tag": "<string>",
  "level": 123,
  "post_only_adjust": true
}
'

{
  "success": true,
  "data": {
    "order_id": 13,
    "client_order_id": "testclientid",
    "order_type": "LIMIT",
    "order_price": 100.12,
    "order_quantity": 0.987654,
    "order_amount": 0.8,
    "error_message": "none"
  },
  "timestamp": 1702989203989
}

Order Management

Create Order

Limit: 10 requests per 1 second

POST /v1/order

Place order maker/taker, the order executed information will be update from websocket stream. will response immediately with an order created message.

MARKET type order behavior: it matches until the full size is executed. If the size is too large (larger than whole book) or the matching price exceeds the price limit (refer to price_range), then the remaining quantity will be cancelled.

IOC type order behavior: it matches as much as possible at the order_price. If not fully executed, then remaining quantity will be cancelled.

FOK type order behavior: if the order can be fully executed at the order_price then the order gets fully executed otherwise would be cancelled without any execution.

POST_ONLY type order behavior: if the order will be executed with any maker trades at the time of placement, then it will be cancelled without any execution.

ASK type order behavior: the order price is guranteed to be the best ask price of the orderbook at the time it gets accepted.

BID type order behavior: the order price is guranteed to be the best bid price of the orderbook at the time it gets accepted.

visible_quantity behavior: it sets the maximum quantity to be shown on orderbook. By default, it is equal to order_quantity, negative number and number larger than order_quantity is not allowed. If it sets to 0, the order would be hidden from the orderbook. It doesn’t work for MARKET/IOC/FOK orders since orders with these types would be executed and cancelled immediately and not be shown on orderbook. For LIMIT order, as long as it’s not complete, visible_quantity is the maximum quantity that shown on orderbook.

order_amount behavior: for MARKET/BID/ASK order, order can be placed by order_amount instead of order_quantity. It’s the size of the order in terms of the quote currency instead of the base currency. The order would be rejected if both order_amount and order_quantity are provided. The precision of the number should be within 8 digits.

client_order_id behavior: customized order_id, a unique id among open orders. Orders with the same client_order_id can be accepted only when the previous one if completed, otherwise the order will be rejected.

For MARKET/BID/ASK order, order_amount is not supported when placing SELL order while order_quantity is not supported when placing BUY order.

Note: This endpoint requires trading scope in Orderly Key.

POST

order

Create Order

curl --request POST \
  --url https://api.orderly.org/v1/order \
  --header 'Content-Type: application/json' \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>' \
  --data '
{
  "symbol": "PERP_ETH_USDC",
  "order_type": "<string>",
  "side": "<string>",
  "client_order_id": "<string>",
  "order_price": 123,
  "order_quantity": 123,
  "order_amount": 123,
  "visible_quantity": 123,
  "reduce_only": true,
  "slippage": 123,
  "order_tag": "<string>",
  "level": 123,
  "post_only_adjust": true
}
'

{
  "success": true,
  "data": {
    "order_id": 13,
    "client_order_id": "testclientid",
    "order_type": "LIMIT",
    "order_price": 100.12,
    "order_quantity": 0.987654,
    "order_amount": 0.8,
    "error_message": "none"
  },
  "timestamp": 1702989203989
}

Headers

orderly-timestamp

string

required

orderly-account-id

string

required

orderly-key

string

required

orderly-signature

string

required

x-recv-window

number

Use this parameter to control the timeout threshold for placing order, unit in miliseconds

Body

application/json

symbol

string

required

Example:

"PERP_ETH_USDC"

order_type

string

required

LIMIT/MARKET/IOC/FOK/POST_ONLY/ASK/BID

side

string

required

SELL/BUY

client_order_id

string

36 length, accepts hyphen but cannot be the first character, default: null

order_price

number

If order_type is MARKET/ASK/BID, then is not required, otherwise this parameter is required.

order_quantity

number

For MARKET/ASK/BID order, if order_amount is given, it is not required.

order_amount

number

For MARKET/ASK/BID order, the order size in terms of quote currency

visible_quantity

number

The order quantity shown on orderbook. (default: equal to order_quantity) Visible quantity is not supported for post-only orders.

reduce_only

boolean

Default false

slippage

number

MARKET orders beyond this slippage will not be executed

order_tag

string

level

number

Integer value from 0 to 4. This parameter controls wether to present the price of bid0 to bid4 or ask0 to ask4. Only allowed when order_type is BID or ASK.

post_only_adjust

boolean

If set to true, then price will be adjusted to 1 tick close to current best price. Only supported for POST_ONLY type orders

Response

200 - application/json

success

boolean

required

Example:

true

data

object

required

Show child attributes

data.order_id

number

Example:

13

data.client_order_id

string

Example:

"testclientid"

data.order_type

string

Example:

"LIMIT"

data.order_price

number

Example:

100.12

data.order_quantity

number

Example:

0.987654

data.order_amount

number

Example:

0.8

data.error_message

string

Example:

"none"

timestamp

integer

Example:

1702989203989

Settle sub-account PnL Batch Create Order

⌘I

Getting Started

Partner Support

User Flows

About APIs

General API

User API

Trading API

Strategy Vault API

Staking & Valor API

Builder API

Market Data API

Websocket API

Create Order

Headers

Body

Response