Atomic orders

🚧

This endpoint is currently non-functional as the method has not yet been implemented. Please avoid using it for now.

This endpoint is designed to execute a combination of orders atomically. If any order in the batch is rejected for any reason, all orders are simultaneously rejected. Please note that only one order per contract can be executed in an atomic batch.

Required Request Headers:

• X-Signature: The required digital signature of the request.

Body parameters

• orders: array of order objects.
• timestamp : Time of request creation, required for all trading requests. In milliseconds.
• recv_window: The number of milliseconds after timestamp the request is valid for.

Order Parameters (for each order):

• customer_id: A unique identifier for the order provided by the API customer. This ID must be unique to prevent duplication.
• contract: The symbol or numeric ID of the contract for which the order is being placed.
• type: Specifies the type of order, such as limit or market"
• limit_price: (Optional) The limit price for the order, applicable only if the order type is limit.
• time_in_force: Defines how long the order remains valid before expiration. Options include "GTC" (Good Till Canceled), "IOC" (Immediate or Cancel), "FOK" (Fill or Kill), and "PO" (Post Only).
• reduce_only: A boolean flag indicating whether the order should only reduce a position, not increase it.
• quantity_steps: The size of the order expressed in the smallest tradable increments, always an integer. Only one quantity parameter should be provided.
• quantity_contracts: The size of the order in terms of contracts. Only one quantity parameter should be provided.
• quantity_assets: The size of the order in units of the underlying asset. Only one quantity parameter should be provided.

Responses:

• 201 Created: Successfully created order details including status, order ID, transaction hash, and associated events.
• 422 Unprocessable Entity: Order was rejected by the protocol.
• 409 Conflict: A conflict occurred, typically due to an existing order with the same customer ID.

🚧

Undocumented

All possible API behavior is not documented yet.

Each request to this endpoint costs 1 API credit.