Skip to main content
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

id
string
required
Unique request identifier for correlation
method
string
required
WebSocket API method. Must be order.create
params
object
required
Request parameters containing authentication and order details

Response

id
string
Request identifier for correlation
status
integer
HTTP status code (200 for success)
result
object
Order details object

Error Response

id
string
Request identifier for correlation
status
integer
HTTP error status code
result
null
Always null for error responses
error
object
Error details object

Examples

{
  "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:
  • amount, price, distance

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