Skip to main content
POST
/
api
/
v1
/
order
/
place
Place Order
curl --request POST \
  --url https://api.ekiden.fi/api/v1/order/place \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "close_on_trigger": true,
  "margin_mode": "Cross",
  "order_type": "Limit",
  "post_only": true,
  "price": "<string>",
  "qty": "<string>",
  "reduce_only": true,
  "side": "Sell",
  "sub_account_address": "<string>",
  "symbol": "BTCUSDC",
  "time_in_force": "GTC",
  "expire_time": "1672531200000",
  "order_link_id": "<unknown>",
  "slippage_tolerance": "<unknown>",
  "smp_group": 1,
  "smp_type": "<unknown>",
  "tpsl": "<unknown>",
  "trigger": "<unknown>"
}
'
{
  "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "order_link_id": "<unknown>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request to place an order.

​
close_on_trigger
boolean
required
​
margin_mode
enum<string>
required
Available options:
Cross,
Isolated
​
order_type
enum<string>
required

Order type: Limit, Market.

Available options:
Limit,
Market
​
post_only
boolean
required
​
price
string
required
​
qty
string
required
​
reduce_only
boolean
required
​
side
enum<string>
required

Order side: buy or sell.

Available options:
Sell,
Buy
​
sub_account_address
string
required
​
symbol
string
required
Example:

"BTCUSDC"

​
time_in_force
required

Time in Force instructions.

Available options:
GTC
​
expire_time
string<date-time> | null
Example:

"1672531200000"

​
order_link_id
null | string
​
slippage_tolerance
object
​
smp_group
integer<int64> | null

Self-match prevention group id. Orders with the same (user_id, smp_group) are eligible for SMP checks.

Required range: x >= 0
​
smp_type
null | enum<string>

Self-match prevention (SMP/STP) strategy. If unset, SMP is disabled.

Available options:
CancelMaker,
CancelTaker,
CancelBoth
​
tpsl
object
​
trigger
object

Response

200 - application/json

Order placed

Response for placing an order.

​
order_id
string<uuid>
required
​
order_link_id
null | string