Skip to main content
POST
/
exchange
/
orders
Create an order
curl --request POST \
  --url https://api.example.com/exchange/orders \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "qty": 1,
  "symbol": "USD-NGN",
  "type": "buy"
}
'
{
  "data": {
    "accepted_at": "2023-12-23T17:55:42.919523",
    "average_fill_price": 80000,
    "business_id": "dd625bec-b1a3-466e-867e-c91ae0b6e71e",
    "correlation_id": "7da742ea-a1bc-11ee-b907-560f156a658b",
    "created_at": "2023-12-23T17:55:42.911",
    "expires_at": null,
    "id": "7da75a46-a1bc-11ee-9a32-560f156a658b",
    "min_qty": null,
    "min_quote_qty": null,
    "percent_filled": 10000,
    "price": 80000,
    "price_type": "market",
    "qty": 1,
    "quote_qty": null,
    "status": "filled",
    "symbol": "USD-NGN",
    "time_in_force": "gtc",
    "trades": [
      {
        "buy_order_id": "7da75a46-a1bc-11ee-9a32-560f156a658b",
        "commission": 0,
        "correlation_id": "7da742ea-a1bc-11ee-b907-560f156a658b",
        "created_at": "2023-12-23T17:55:42.921",
        "id": "7da8e726-a1bc-11ee-80cf-560f156a658b",
        "price": 80000,
        "sell_order_id": "7d97c0b8-a1bc-11ee-b240-560f156a658b",
        "size": 1,
        "symbol": "USD-NGN"
      }
    ],
    "type": "buy",
    "updated_at": "2023-12-23T17:55:42.911",
    "user_id": "b101f718-d133-450c-a572-c281c7341803"
  }
}

Headers

​
Idempotency-Key
string
required

Body

application/json

Order params

Order creation params

​
symbol
string
required

Currency pair

​
type
enum<string>
required

Order type

Available options:
sell,
buy
​
min_qty
number | null

Minimum quantity to be traded at a go, in base currency

​
min_quote_qty
number | null

Minimum quantity to be traded at a go, in quote currency

​
price
integer

Order price, in minor units

​
price_type
enum<string>

Price type

Available options:
limit,
market
​
qty
number

Order quantity, denominated in the base currency

​
quote_qty
number | null

Order quantity, denominated in the quote currency

​
time_in_force
enum<string>
Available options:
gtc,
gtt,
ioc,
fok

Response

Order

Response schema for a single order

​
data
Order · object

An order

Example:
{
  "accepted_at": "2023-12-23T17:55:42.919523",
  "average_fill_price": 80000,
  "business_id": "dd625bec-b1a3-466e-867e-c91ae0b6e71e",
  "correlation_id": "7da742ea-a1bc-11ee-b907-560f156a658b",
  "created_at": "2023-12-23T17:55:42.911",
  "expires_at": null,
  "id": "7da75a46-a1bc-11ee-9a32-560f156a658b",
  "min_qty": null,
  "min_quote_qty": null,
  "percent_filled": 10000,
  "price": 80000,
  "price_type": "market",
  "qty": 1,
  "quote_qty": null,
  "status": "filled",
  "symbol": "USD-NGN",
  "time_in_force": "gtc",
  "trades": [
    {
      "buy_order_id": "7da75a46-a1bc-11ee-9a32-560f156a658b",
      "commission": 0,
      "correlation_id": "7da742ea-a1bc-11ee-b907-560f156a658b",
      "created_at": "2023-12-23T17:55:42.921",
      "id": "7da8e726-a1bc-11ee-80cf-560f156a658b",
      "price": 80000,
      "sell_order_id": "7d97c0b8-a1bc-11ee-b240-560f156a658b",
      "size": 1,
      "symbol": "USD-NGN"
    }
  ],
  "type": "buy",
  "updated_at": "2023-12-23T17:55:42.911",
  "user_id": "b101f718-d133-450c-a572-c281c7341803"
}