Place a new order

Creates a new order with EIP-712 signature for on-chain settlement. Supports limit, market, and conditional orders with various execution policies. GTT orders' exp_ts must be at most 30 days in the future.

Requires authentication.

Authorization

ApiKeyAuth ApiSignatureAuth ApiTimestampAuth

x-api-key<token>

API key for authentication

In: header

x-api-signature<token>

HMAC-SHA256 signature: base64(HMAC(timestamp + method + path + body, secret))

In: header

x-api-timestamp<token>

Unix timestamp in seconds

In: header

Request Body

application/json

PlaceOrderRequest creates a new order.

TypeScript Definitions

Use the request body type in TypeScript.

mkt_id?string

Market ID (e.g., "BTC-PERP").

sd?string

Order side (BUY, SELL, etc.).

Default"ORDER_SIDE_UNSPECIFIED"

Value in"ORDER_SIDE_UNSPECIFIED" | "ORDER_SIDE_BUY" | "ORDER_SIDE_SELL"

ot?string

Order type (LIMIT, MARKET, STOP, etc.).

Default"ORDER_TYPE_UNSPECIFIED"

Value in"ORDER_TYPE_UNSPECIFIED" | "ORDER_TYPE_LIMIT" | "ORDER_TYPE_MARKET" | "ORDER_TYPE_STOP" | "ORDER_TYPE_TWAP"

sz?number

Order quantity in base asset units.

Formatdouble

px?number

Limit price in quote asset units.

Formatdouble

tif?string

Time-in-force policy. Defaults to GTC.

Default"TIME_IN_FORCE_UNSPECIFIED"

Value in"TIME_IN_FORCE_UNSPECIFIED" | "TIME_IN_FORCE_GTC" | "TIME_IN_FORCE_IOC" | "TIME_IN_FORCE_FOK" | "TIME_IN_FORCE_GTT"

po?boolean

Post-only flag. If true, order will only add liquidity.

ro?boolean

Reduce-only flag. If true, order can only reduce position.

stp?string

Self-trade prevention mode.

Default"SELF_TRADE_PREVENTION_UNSPECIFIED"

Value in

"SELF_TRADE_PREVENTION_UNSPECIFIED" | "SELF_TRADE_PREVENTION_CANCEL_TAKER" | "SELF_TRADE_PREVENTION_CANCEL_MAKER" | "SELF_TRADE_PREVENTION_CANCEL_BOTH"

cl_oid?string

Client-assigned order identifier (max 32 chars, alphanumeric and -_: only).

nonce?string

Unique nonce (typically Unix timestamp in nanoseconds).

Formatuint64

sig?string

EIP-712 signature of the order payload.

stop_t?string

Type of stop order (stop_loss or take_profit). For STOP orders.

Default"STOP_TYPE_UNSPECIFIED"

Value in"STOP_TYPE_UNSPECIFIED" | "STOP_TYPE_STOP_LOSS" | "STOP_TYPE_TAKE_PROFIT"

stop_px?number

Price at which the stop order triggers. For STOP orders.

Formatdouble

stop_px_type?string

Price source for stop evaluation. For STOP orders.

Default"STOP_PRICE_TYPE_UNSPECIFIED"

Value in"STOP_PRICE_TYPE_UNSPECIFIED" | "STOP_PRICE_TYPE_LAST" | "STOP_PRICE_TYPE_MARK"

exp_ts?string

Expiration timestamp in nanoseconds. For GTT orders.

Formatuint64

sched_ts?string

Scheduled execution timestamp in nanoseconds.

Formatint64

await?boolean

If true, wait for matching engine confirmation before returning. Only for MARKET and LIMIT orders.

Response Body

`application/json`

Request

curl -X POST "https://api.obsdn.trade/orders" \  -H "Content-Type: application/json" \  -d '{}'

Response

{
  "ord": {
    "oid": "string",
    "mkt_id": "string",
    "sd": "ORDER_SIDE_UNSPECIFIED",
    "ot": "ORDER_TYPE_UNSPECIFIED",
    "sz": "string",
    "px": "string",
    "sndr": "string",
    "nonce": "string",
    "stp": "SELF_TRADE_PREVENTION_UNSPECIFIED",
    "po": true,
    "tif": "TIME_IN_FORCE_UNSPECIFIED",
    "ro": true,
    "st": "ORDER_STATUS_UNSPECIFIED",
    "done_rsn": "string",
    "stop_px": "string",
    "stop_px_type": "STOP_PRICE_TYPE_UNSPECIFIED",
    "stop_t": "STOP_TYPE_UNSPECIFIED",
    "is_liq": true,
    "liq_fee_rt": "string",
    "mkr_fee_rt": "string",
    "tkr_fee_rt": "string",
    "filled_sz": "string",
    "avg_px": "string",
    "tot_fees": "string",
    "crt_ts": "string",
    "upd_ts": "string",
    "cancel_req_ts": "string",
    "exp_ts": "string",
    "cl_oid": "string",
    "cancel_req": true,
    "sched_ts": "string"
  }
}

Authorization

Request Body

Response Body

200application/json

`application/json`