Creates a new trading order via WebSocket API. Supports all order types available in the REST API including limit, market, stop-limit, trailing, ceiling, and iceberg orders.
Request
Unique request identifier for correlation
WebSocket API method. Must be order.create
Request parameters containing authentication and order details API Token for authentication
Timestamp in milliseconds (UTC)
HMAC SHA256 signature of the request
Trading pair code (e.g., BTC_BRL, ETH_BRL)
Order type: limit, market, stop_limit, trailing, ceiling, or iceberg
Order amount in base currency
Limit price (required for limit, stop_limit, trailing, ceiling, and iceberg orders)
Order value in quote currency (required for market and ceiling orders)
Stop price (required for stop_limit orders)
Distance from market price (required for trailing orders)
Step amount (required for iceberg orders) (the ratio of amount to step_amount must be less than or equal to 10)
Order external identifier (maximum of 36 chars) (optional)
If set to true, the order will be added directly to the order book without an initial match, provided the request is valid
If a valid timestamp is provided, the order will be created with an expiration date and time
params.immediate_or_cancel
If set to true, the order will not be added to the order book after the initial match, any remaining unfilled amount will result in the order being canceled
If set to true, the order will either be completely filled or canceled
Response
Request identifier for correlation
HTTP status code (200 for success)
Order details object Order status: open, executed_partially, executed_completely, or canceled
Order creation datetime (ISO 8601 format)
External order identifier
Amount that has been executed
Amount remaining to be executed
Value remaining to be executed
Error Response
Request identifier for correlation
Always null for error responses
Error details object Error code (e.g., 40011 for insufficient funds)
Human-readable error message
Examples
Limit Buy Order
Market Sell Order
Stop Limit Buy Order
Trailing Buy Order
Ceiling Buy Order
Iceberg Buy Order
{
"id" : "req-001" ,
"method" : "order.create" ,
"params" : {
"api_token" : "your-api-token" ,
"timestamp" : 1634567890000 ,
"signature" : "calculated-signature" ,
"pair" : "BTC_BRL" ,
"side" : "buy" ,
"type" : "limit" ,
"amount" : 0.001 ,
"price" : 100000 ,
"external_id" : "my-order-123"
}
}
Success Response Example
{
"id" : "req-001" ,
"status" : 200 ,
"result" : {
"id" : "7155ED34-9EC4-4733-8B32-1E4319CB662F" ,
"status" : "open" ,
"create_date" : "2024-03-27T13:27:19.853Z" ,
"external_id" : "my-order-123" ,
"pair" : "BTC_BRL" ,
"side" : "buy" ,
"executed_amount" : 0 ,
"remaining_amount" : 0.001 ,
"remaining_value" : 100 ,
"requested_amount" : 0.001 ,
"requested_value" : 100
}
}
Error Response Example
{
"id" : "req-001" ,
"status" : 400 ,
"result" : null ,
"error" : {
"error_code" : 40011 ,
"message" : "Insufficient funds."
}
}
Supported Order Types
Limit Orders
Buy and sell orders with a specified price. Available parameters:
amount, price
Optional: post_only, expiration, immediate_or_cancel, fill_or_kill
Market Orders
Buy and sell orders executed at current market price. Available parameters:
amount, value
Optional: fill_or_kill
Stop Limit Orders
Buy and sell orders that trigger at a specified stop price and then execute at the limit price. Available parameters:
amount, price, stop_price
Trailing Orders
Buy and sell orders that follow the price at a specified distance. Available parameters:
Ceiling Orders
Buy and sell orders up to a specified value at any price. Available parameters:
value
Optional: fill_or_kill
Iceberg Orders
Large orders that are split into smaller visible chunks. Available parameters:
amount, step_amount, price