EX5 API · REST & WEBSOCKET

Trading

Place and cancel orders through the order-entry API, and read your orders and trades through the history endpoints. All trading endpoints need a signed API key; placing orders needs account level 2.

Order lifecycle

POST /api/v2/finex/market/orders answers 201 with state pending and a uuid. This means the order was accepted for processing, not that it is on the book.
The matching engine then checks your balance. The order becomes wait (open), done (filled) or reject (for example, insufficient balance).
Follow it with GET /api/v2/peatio/market/orders/{uuid} or the private order WebSocket stream. Right after creation the lookup can briefly return 404 while the order is being recorded.

State	Meaning
`pending`	Accepted, not yet processed by the engine.
`wait`	Open on the order book.
`done`	Completely filled.
`cancel`	Cancelled (possibly after a partial fill).
`reject`	Rejected by the engine, for example for insufficient balance.

Prices and amounts must respect each market's price_precision, amount_precision, min_price, max_price and min_amount from GET /api/v2/peatio/public/markets; the order API answers only a generic error.invalid_request when a value breaks these rules, so validate before sending.

Create an order

POST/api/v2/finex/market/ordersAPI key

Submits a new order to the matching engine. The body must be JSON. Write amounts and prices as plain decimal strings (e.g. "0.00007", never 7e-05) that respect the market's amount_precision, price_precision, min_amount, min_price and max_price (GET /api/v2/peatio/public/markets). HTTP 201 means the order was accepted for processing, not that it is on the book: the engine checks your balance afterwards and may reject it. Follow the order with GET /api/v2/peatio/market/orders/{uuid} or the private order WebSocket stream.

Requires account level 2 (verified phone number).
Rate limit: 50 requests per 10 seconds per account, shared by create, cancel and cancel-all. Excess requests return 429.
A market buy order reserves your entire available quote-currency balance until it completes.
Use this endpoint for order entry: POST /api/v2/peatio/market/orders is not available to regular accounts.

Parameters

Name	In	Type	Description
`market`required	body	string	Market id, e.g. `btcusdt`. Must be an active spot market.
`side`required	body	string	Order side. One of: `buy`, `sell`.
`type`required	body	string	Order type: `limit` (needs `price`) or `market`. One of: `limit`, `market`.
`amount`required	body	string	Order volume in the base currency; > 0, plain decimal notation, at most amount_precision decimals, >= min_amount.
`price`	body	string	Limit price in the quote currency. Required for `limit` orders, ignored for `market` orders. At most `price_precision` decimals, between `min_price` and `max_price`.

Responses

Status	Description
`201`	Accepted for processing (state `pending`).
`400`	Malformed JSON or a missing/invalid field (including exponent notation): `{"error":"error.bad_request"}`.
`401`	Gateway authentication failure (see Authentication errors), or account not allowed to trade: `{"error":"order.action_level.not_permitted"}` (level < 2) / `{"error":"order.action_role.not_permitted"}`.
`422`	Rejected by validation (inactive market, precision, min/max price, min amount): `{"error":"error.invalid_request"}`.
`429`	Rate limit exceeded; body is the JSON string "Too Many Requests".

Response fields

Field	Type	Description
`uuid`	string (UUID)	Order UUID; use it with GET /api/v2/peatio/market/orders/{uuid}.
`side`	string	"buy" or "sell".
`type`	string	Order type as sent.
`market`	string	Market id.
`origin_volume`	string (decimal)	Requested amount.
`remaining_volume`	string (decimal)	Equals origin_volume at creation.
`executed_volume`	string (decimal)	"0" at creation.
`price`	string (decimal)	Limit price ("0" for market orders).
`state`	string	Always "pending" in this response.
`trades_count`	integer	0 at creation.
`created_at`	integer (unix seconds)	Acceptance time.

Example response

JSON

{
  "uuid": "5c0de1a2-ba95-11f1-aa4a-000000000001",
  "side": "buy",
  "type": "limit",
  "market": "btcusdt",
  "origin_volume": "0.01",
  "remaining_volume": "0.01",
  "executed_volume": "0",
  "price": "84000",
  "state": "pending",
  "trades_count": 0,
  "created_at": 1790530000
}

Example request

KID="your-api-key-id"; SECRET="your-api-secret"
NONCE=$(date +%s%3N)   # Unix time in milliseconds (GNU date)
SIG=$(printf '%s' "$NONCE$KID" | openssl dgst -sha256 -hmac "$SECRET" | awk '{print $NF}')
curl -s -X POST "https://exchange.ex5.com/api/v2/finex/market/orders" \
  -H "X-Auth-Apikey: $KID" -H "X-Auth-Nonce: $NONCE" -H "X-Auth-Signature: $SIG" \
  -H "Content-Type: application/json" -d '{"market":"btcusdt","side":"buy","type":"limit","amount":"0.01","price":"84000"}'

# ex5_request(): see /docs/authentication
print(ex5_request("POST", "/api/v2/finex/market/orders", body={"market": "btcusdt", "side": "buy", "type": "limit", "amount": "0.01", "price": "84000"}))

// ex5Request(): see /docs/authentication
console.log(await ex5Request("POST", "/api/v2/finex/market/orders", {"market":"btcusdt","side":"buy","type":"limit","amount":"0.01","price":"84000"}));

Cancel an order

POST/api/v2/finex/market/orders/cancel/{id}API key

Requests cancellation of one of your open orders, identified by numeric id or UUID. Cancellation is asynchronous: confirm the final state with GET /api/v2/peatio/market/orders/{id} or the private order stream. A 200 body is the engine's internal order record (see FinexOrderRecord); do not rely on fields other than id and uuid.

The response is the engine's internal order record (side is OrderBid/OrderAsk, state is numeric, 100 = wait). Read the order with GET /api/v2/peatio/market/orders/{id} for the standard representation.

Parameters

Name	In	Type	Description
`id`required	path	string	Order id (integer) or order UUID.

Responses

Status	Description
`200`	Cancellation requested; returns the stored order record.
`422`	`{"error":"order is not found"}`, `{"error":"order is already closed"}` or `{"error":"error.invalid_request"}` (malformed id).
`401`	Rejected by the API gateway: missing/invalid API-key headers, nonce outside the 5 s window, bad signature, inactive key, 2FA disabled on the account, or no permission for this path. Body `{"errors":["authz.<reason>"]}` (Content-Type is text/plain).
`429`	Rate limit exceeded ("Too Many Requests").

Response fields

Field	Type	Description
`id`	integer	Order id.
`uuid`	string (UUID)	Order UUID.
`side`	string	"OrderBid" (buy) or "OrderAsk" (sell).
`type`	string	Order type.
`market_id`	string	Market id.
`state`	integer	0 pending, 100 wait, 200 done, -100 cancel, -200 reject.
`price`	string (decimal)	Price.
`volume`	string (decimal)	Remaining amount.
`origin_volume`	string (decimal)	Original amount.
`locked`	string (decimal)	Funds currently reserved.
`created_at`	integer (unix seconds)	Creation time.
`other`	various	member_uid, member_id, ask, bid, remote_id, MarketType, Notional, origin_locked, funds_received, maker_fee, taker_fee, trades_count, username.

Example response

JSON

{
  "id": 444677012,
  "uuid": "5c0de1a2-ba95-11f1-aa4a-000000000001",
  "remote_id": {
    "String": "",
    "Valid": false
  },
  "member_uid": "ID1234567890",
  "username": "",
  "member_id": 1001,
  "ask": "btc",
  "bid": "usdt",
  "side": "OrderBid",
  "type": "limit",
  "MarketType": "",
  "price": "84000",
  "volume": "0.01",
  "origin_volume": "0.01",
  "Notional": "0",
  "market_id": "btcusdt",
  "state": 100,
  "locked": "840",
  "origin_locked": "840",
  "funds_received": "0",
  "maker_fee": "0.002",
  "taker_fee": "0.002",
  "created_at": 1790530000,
  "trades_count": 0
}

Example request

KID="your-api-key-id"; SECRET="your-api-secret"
NONCE=$(date +%s%3N)   # Unix time in milliseconds (GNU date)
SIG=$(printf '%s' "$NONCE$KID" | openssl dgst -sha256 -hmac "$SECRET" | awk '{print $NF}')
curl -s -X POST "https://exchange.ex5.com/api/v2/finex/market/orders/cancel/5c0de1a2-ba95-11f1-aa4a-000000000001" \
  -H "X-Auth-Apikey: $KID" -H "X-Auth-Nonce: $NONCE" -H "X-Auth-Signature: $SIG"

# ex5_request(): see /docs/authentication
print(ex5_request("POST", "/api/v2/finex/market/orders/cancel/5c0de1a2-ba95-11f1-aa4a-000000000001"))

// ex5Request(): see /docs/authentication
console.log(await ex5Request("POST", "/api/v2/finex/market/orders/cancel/5c0de1a2-ba95-11f1-aa4a-000000000001"));

Cancel all orders

POST/api/v2/finex/market/orders/cancelAPI key

Requests cancellation of all your open orders, optionally only in one market and/or on one side. Send {} (or an empty body) to cancel everything. Asynchronous; the response only confirms the request was queued.

Parameters

Name	In	Type	Description
`market`	body	string	Only cancel orders in this market, e.g. `btcusdt`.
`side`	body	string	Only cancel buy or sell orders. One of: `buy`, `sell`.

Responses

Status	Description
`200`	The JSON string "orders.cancel.accepted".
`422`	Body is not valid JSON: `{"error":"error.bad_request"}`.
`401`	Rejected by the API gateway: missing/invalid API-key headers, nonce outside the 5 s window, bad signature, inactive key, 2FA disabled on the account, or no permission for this path. Body `{"errors":["authz.<reason>"]}` (Content-Type is text/plain).
`429`	Rate limit exceeded ("Too Many Requests").

Example response

JSON

"orders.cancel.accepted"

Example request

KID="your-api-key-id"; SECRET="your-api-secret"
NONCE=$(date +%s%3N)   # Unix time in milliseconds (GNU date)
SIG=$(printf '%s' "$NONCE$KID" | openssl dgst -sha256 -hmac "$SECRET" | awk '{print $NF}')
curl -s -X POST "https://exchange.ex5.com/api/v2/finex/market/orders/cancel" \
  -H "X-Auth-Apikey: $KID" -H "X-Auth-Nonce: $NONCE" -H "X-Auth-Signature: $SIG" \
  -H "Content-Type: application/json" -d '{"market":"btcusdt"}'

# ex5_request(): see /docs/authentication
print(ex5_request("POST", "/api/v2/finex/market/orders/cancel", body={"market": "btcusdt"}))

// ex5Request(): see /docs/authentication
console.log(await ex5Request("POST", "/api/v2/finex/market/orders/cancel", {"market":"btcusdt"}));

List your orders

GET/api/v2/peatio/market/ordersAPI key

Returns your orders, most recently updated first by default. Paginated with Page and Per-Page headers (this endpoint does not send Total). Time filters apply to the creation time.

Parameters

Name	In	Type	Description
`market`	query	string	Market id, e.g. `btcusdt`.
`base_unit`	query	string	Only orders whose base currency is this code, e.g. `btc`.
`state`	query	string	Filter by state. One of: `pending`, `wait`, `done`, `cancel`, `reject`.
`ord_type`	query	string	Filter by order type. One of: `limit`, `market`.
`type`	query	string	Filter by side. One of: `buy`, `sell`.
`time_from`	query	integer	Unix time in seconds; only orders created at or after this time.
`time_to`	query	integer	Unix time in seconds; only orders created before this time.
`order_by`	query	string	Sort by update time (default `desc`). One of: `asc`, `desc`.
`limit`	query	integer	Page size, 0-1000 (default 100).
`page`	query	integer	Page number, starting at 1 (default 1).

Responses

Status	Description
`200`	Array of orders.
`401`	Rejected by the API gateway: missing/invalid API-key headers, nonce outside the 5 s window, bad signature, inactive key, 2FA disabled on the account, or no permission for this path. Body `{"errors":["authz.<reason>"]}` (Content-Type is text/plain).
`403`	Account level below 1: `{"errors":["market.trade.not_permitted"]}`.
`422`	Validation error, e.g. `{"errors":["public.market.doesnt_exist"]}`.

Response fields

Field	Type	Description
`id`	integer	Order id (assigned by the engine).
`uuid`	string (UUID)	Order UUID (returned by the create call).
`side`	string	"buy" or "sell".
`ord_type`	string	"limit" or "market".
`price`	string (decimal) \| null	Limit price; null for market orders.
`avg_price`	string (decimal)	Average execution price ("0.0" until filled).
`state`	string	"pending" (accepted, not yet on the book), "wait" (open), "done" (filled), "cancel", "reject".
`market`	string	Market id.
`market_type`	string	"spot".
`created_at`	string (ISO 8601 datetime, UTC)	Creation time.
`updated_at`	string (ISO 8601 datetime, UTC)	Last update time.
`origin_volume`	string (decimal)	Original amount (base currency).
`remaining_volume`	string (decimal)	Amount still open.
`executed_volume`	string (decimal)	Amount filled.
`maker_fee`	string (decimal)	Maker fee rate as a fraction (e.g. "0.002" = 0.2%).
`taker_fee`	string (decimal)	Taker fee rate as a fraction.
`trades_count`	integer	Number of trades.
`trades`	array<Trade>	Only in GET /market/orders/{id}.

Example response

JSON

[
  {
    "id": 444677012,
    "uuid": "5c0de1a2-ba95-11f1-aa4a-000000000001",
    "side": "buy",
    "ord_type": "limit",
    "price": "84000.0",
    "avg_price": "0.0",
    "state": "wait",
    "market": "btcusdt",
    "market_type": "spot",
    "created_at": "2026-09-27T17:07:34Z",
    "updated_at": "2026-09-27T17:07:34Z",
    "origin_volume": "0.01",
    "remaining_volume": "0.01",
    "executed_volume": "0.0",
    "maker_fee": "0.002",
    "taker_fee": "0.002",
    "trades_count": 0
  }
]

Example request

KID="your-api-key-id"; SECRET="your-api-secret"
NONCE=$(date +%s%3N)   # Unix time in milliseconds (GNU date)
SIG=$(printf '%s' "$NONCE$KID" | openssl dgst -sha256 -hmac "$SECRET" | awk '{print $NF}')
curl -s "https://exchange.ex5.com/api/v2/peatio/market/orders?market=btcusdt&limit=50" \
  -H "X-Auth-Apikey: $KID" -H "X-Auth-Nonce: $NONCE" -H "X-Auth-Signature: $SIG"

# ex5_request(): see /docs/authentication
print(ex5_request("GET", "/api/v2/peatio/market/orders", params={"market": "btcusdt", "limit": "50"}))

// ex5Request(): see /docs/authentication
console.log(await ex5Request("GET", "/api/v2/peatio/market/orders", undefined, {"market":"btcusdt","limit":"50"}));

Get one order

GET/api/v2/peatio/market/orders/{id}API key

Returns one of your orders by numeric id or UUID (the UUID is returned when you create an order), including its trades.

Parameters

Name	In	Type	Description
`id`required	path	string	Order id (integer) or order UUID.

Responses

Status	Description
`200`	Order with `trades`.
`401`	Rejected by the API gateway: missing/invalid API-key headers, nonce outside the 5 s window, bad signature, inactive key, 2FA disabled on the account, or no permission for this path. Body `{"errors":["authz.<reason>"]}` (Content-Type is text/plain).
`403`	Account level below 1: `{"errors":["market.trade.not_permitted"]}`.
`404`	Record not found: `{"errors":["record.not_found"]}`.
`422`	Malformed id: `{"errors":["market.order.invaild_id_or_uuid"]}`.

Response fields

Field	Type	Description
`id`	integer	Order id (assigned by the engine).
`uuid`	string (UUID)	Order UUID (returned by the create call).
`side`	string	"buy" or "sell".
`ord_type`	string	"limit" or "market".
`price`	string (decimal) \| null	Limit price; null for market orders.
`avg_price`	string (decimal)	Average execution price ("0.0" until filled).
`state`	string	"pending" (accepted, not yet on the book), "wait" (open), "done" (filled), "cancel", "reject".
`market`	string	Market id.
`market_type`	string	"spot".
`created_at`	string (ISO 8601 datetime, UTC)	Creation time.
`updated_at`	string (ISO 8601 datetime, UTC)	Last update time.
`origin_volume`	string (decimal)	Original amount (base currency).
`remaining_volume`	string (decimal)	Amount still open.
`executed_volume`	string (decimal)	Amount filled.
`maker_fee`	string (decimal)	Maker fee rate as a fraction (e.g. "0.002" = 0.2%).
`taker_fee`	string (decimal)	Taker fee rate as a fraction.
`trades_count`	integer	Number of trades.
`trades`	array<Trade>	Only in GET /market/orders/{id}.

Example response

JSON

{
  "id": 444677012,
  "uuid": "5c0de1a2-ba95-11f1-aa4a-000000000001",
  "side": "buy",
  "ord_type": "limit",
  "price": "84000.0",
  "avg_price": "84000.0",
  "state": "done",
  "market": "btcusdt",
  "market_type": "spot",
  "created_at": "2026-09-27T17:07:34Z",
  "updated_at": "2026-09-27T17:07:34Z",
  "origin_volume": "0.01",
  "remaining_volume": "0.0",
  "executed_volume": "0.01",
  "maker_fee": "0.002",
  "taker_fee": "0.002",
  "trades_count": 1,
  "trades": [
    {
      "id": 5131106,
      "price": "84000.0",
      "amount": "0.01",
      "total": "840.0",
      "fee_currency": "btc",
      "fee": "0.002",
      "fee_amount": "0.00002",
      "market": "btcusdt",
      "market_type": "spot",
      "created_at": "2026-09-27T17:10:02Z",
      "taker_type": "buy",
      "side": "buy",
      "order_id": 444677012
    }
  ]
}

Example request

KID="your-api-key-id"; SECRET="your-api-secret"
NONCE=$(date +%s%3N)   # Unix time in milliseconds (GNU date)
SIG=$(printf '%s' "$NONCE$KID" | openssl dgst -sha256 -hmac "$SECRET" | awk '{print $NF}')
curl -s "https://exchange.ex5.com/api/v2/peatio/market/orders/5c0de1a2-ba95-11f1-aa4a-000000000001" \
  -H "X-Auth-Apikey: $KID" -H "X-Auth-Nonce: $NONCE" -H "X-Auth-Signature: $SIG"

# ex5_request(): see /docs/authentication
print(ex5_request("GET", "/api/v2/peatio/market/orders/5c0de1a2-ba95-11f1-aa4a-000000000001"))

// ex5Request(): see /docs/authentication
console.log(await ex5Request("GET", "/api/v2/peatio/market/orders/5c0de1a2-ba95-11f1-aa4a-000000000001"));

List your trades

GET/api/v2/peatio/market/tradesAPI key

Returns your executed trades, newest first by default, with the fee you paid. side is your side of the trade; taker_type is the taker's side. Paginated with Page and Per-Page headers (no Total).

Parameters

Name	In	Type	Description
`market`	query	string	Market id, e.g. `btcusdt`.
`type`	query	string	Only trades where your side was buy or sell. One of: `buy`, `sell`.
`time_from`	query	integer	Unix time in seconds; only trades executed at or after this time.
`time_to`	query	integer	Unix time in seconds; only trades executed before this time.
`order_by`	query	string	Sort by trade id (default `desc`). One of: `asc`, `desc`.
`limit`	query	integer	Page size, 1-1000 (default 100).
`page`	query	integer	Page number, starting at 1 (default 1).

Responses

Status	Description
`200`	Array of trades.
`401`	Rejected by the API gateway: missing/invalid API-key headers, nonce outside the 5 s window, bad signature, inactive key, 2FA disabled on the account, or no permission for this path. Body `{"errors":["authz.<reason>"]}` (Content-Type is text/plain).
`403`	Account level below 1: `{"errors":["market.trade.not_permitted"]}`.
`422`	Validation error, e.g. `{"errors":["public.market.doesnt_exist"]}`.

Response fields

Field	Type	Description
`id`	integer	Trade id.
`price`	string (decimal)	Price.
`amount`	string (decimal)	Amount (base currency).
`total`	string (decimal)	price x amount (quote currency).
`fee_currency`	string	Currency the fee was charged in (the currency you received).
`fee`	string (decimal)	Fee rate applied, as a fraction.
`fee_amount`	string (decimal)	Fee charged.
`market`	string	Market id.
`market_type`	string	"spot".
`created_at`	string (ISO 8601 datetime, UTC)	Execution time.
`taker_type`	string	Side of the taker order.
`side`	string	Your side: "buy" or "sell".
`order_id`	integer	Your order id.

Example response

JSON

[
  {
    "id": 5131106,
    "price": "84420.55",
    "amount": "0.01",
    "total": "844.2055",
    "fee_currency": "btc",
    "fee": "0.002",
    "fee_amount": "0.00002",
    "market": "btcusdt",
    "market_type": "spot",
    "created_at": "2026-09-27T17:10:02Z",
    "taker_type": "buy",
    "side": "buy",
    "order_id": 444677012
  }
]

Example request

KID="your-api-key-id"; SECRET="your-api-secret"
NONCE=$(date +%s%3N)   # Unix time in milliseconds (GNU date)
SIG=$(printf '%s' "$NONCE$KID" | openssl dgst -sha256 -hmac "$SECRET" | awk '{print $NF}')
curl -s "https://exchange.ex5.com/api/v2/peatio/market/trades?market=btcusdt&limit=50" \
  -H "X-Auth-Apikey: $KID" -H "X-Auth-Nonce: $NONCE" -H "X-Auth-Signature: $SIG"

# ex5_request(): see /docs/authentication
print(ex5_request("GET", "/api/v2/peatio/market/trades", params={"market": "btcusdt", "limit": "50"}))

// ex5Request(): see /docs/authentication
console.log(await ex5Request("GET", "/api/v2/peatio/market/trades", undefined, {"market":"btcusdt","limit":"50"}));