Multi Order

Operations for interacting with multi orders.

Get Multi Order

GET /api/multi_order/{id}

Get detailed information about a specific multi-order including its child orders, execution status, and key parameters. This endpoint provides comprehensive information about the multi-order structure and its current state.

Path Parameters

Name

Type

Description

id

string

UUID of multi order. Required.

Query Parameters

Name

Type

include_child_orders

boolean

Include full child order details in the response (default: false).

Example Request

GET /api/multi_order/6debb950-614a-4366-b73b-7d7574fd9e15?include_child_orders=true
Authorization: Bearer <token>

Response Codes

{
    "id": "397e42c1-a617-458b-9db9-dc51f326b918",
    "created_at": "2025-01-13T20:33:22.331268Z",
    "updated_at": "2025-01-13T20:33:22.331288Z",
    "start_datetime": "2025-01-13T20:33:22.323949Z",
    "duration": 600,
    "exposure_tolerance": "0.50000000000000000000",
    "notional_exposure": 34.554926518,
    "executed_notional": 93712.607473482,
    "is_active": false,
    "child_order_ids": [
        "5ee11fdd-334d-418a-b138-7df74f17e417",
        "54509111-7204-4626-8513-d7f040f76bf3"
    ],
    "strategy": "ccb82677-249d-4b01-8f60-7a02379e963a",
    "strategy_params": {},
    "engine_passiveness": "0.02000000000000000000",
    "schedule_discretion": "0.06000000000000000000",
    "alpha_tilt": "0.00000000000000000000",
    "pov_limit": null,
    "limit_price_spread": null,
    "order_condition": "ETH-USDT@Binance ETH:PERP-USDT@Binance - 1 >",
    "order_condition_vars": {},
    "order_condition_expiry": null,
    "user": "13",
    "status": "SCHEDULED",
    "failure_reason": "",
    "completely_filled": true,
    "is_paused": false,
    "pct_filled": 100.0,
    "account_names": [
        "mock"
    ],
    "pairs": "BTC-USDT,BTC:PERP-USDT",
    "calculated_status": "COMPLETE",
    "sell_token_amount": "0.50000000000000000000, 46871.66540000000000000000",
    "buy_token": "USDT, BTC:PERP",
    "sell_token": "BTC, USDT"
}

{
    "error": "unable to get multi order"
}

{
    "error": "multi order not found"
}

Get Multi Orders

GET /api/multi_orders/

Paginated multi orders fetched given the filter options

Query Parameters

Name

Type

include_child_orders

boolean

Include full child order details in the response (default: false).

custom_order_ids

string

comma separated list of values

statuses

string

comma separated list of order statusesMultiOrderStatus [Enum]

before

string

iso format datetime ex. 2025-08-11T12:00:00

after

string

iso format datetime ex. 2025-08-11T12:00:00

page_number

integer

default: 1

page_size

integer

default: 100

Example Request

GET /api/multi_order/6debb950-614a-4366-b73b-7d7574fd9e15?include_child_orders=true
Authorization: Bearer <token>

Response Codes

{
  "multi_orders": [
    {
      "id": "6debb950-614a-4366-b73b-7d7574fd9e15",
      "created_at": "2023-12-01T10:00:00Z",
      "updated_at": "2023-12-01T10:30:00Z",
      "start_timedate": "2023-12-01T10:00:00Z",
      "duration": 3600,
      "exposure_tolerance": "0.05",
      "notional_exposure": "22500.00",
      "executed_notional": "22500.00",
      "child_order_ids": [
        "7fecb951-725b-5477-c84c-8e8685ge0f26",
        "8gfdca62-836c-6588-d95d-9f9796hf1g37"
      ],
      "accounts": ["binance_main", "coinbase_pro"],
      "strategy": "TWAP",
      "strategy_params": {
        "interval": 300,
        "slices": 12
      },
      "engine_passiveness": "0.5",
      "schedule_discretion": "0.3",
      "alpha_tilt": "0.1",
      "limit_price_spread": null,
      "failure_reason": null,
      "pct_filled": "100.00",
      "account_names": ["binance_main", "coinbase_pro"],
      "pairs": "BTC-USD,ETH-USD",
      "status": "COMPLETED",
      "is_active": false,
      "is_paused": false,
      "fee_notional": "22.50",
      "order_condition": "",
      "custom_order_id": "multi_order_123",
      "child_orders": [
        {
          "id": "7fecb951-725b-5477-c84c-8e8685ge0f26",
          "custom_order_id": "child_order_1",
          "parent_order_id": "6debb950-614a-4366-b73b-7d7574fd9e15",
          "notes": "",
          "pair": "BTC-USD",
          "side": "buy",
          "exchanges": ["binance"],
          "buy_token": "BTC",
          "buy_token_amount": "0.25",
          "sell_token": "USD",
          "sell_token_amount": "11250.00",
          "strategy": "TWAP",
          "strategy_params": {
            "interval": 300,
            "slices": 6
          },
          "status": "COMPLETED",
          "executed_notional": "11250.00",
          "pct_filled": "100.00",
          "created_at": "2023-12-01T10:00:00Z",
          "updated_at": "2023-12-01T10:30:00Z",
          "time_start": "2023-12-01T10:00:00Z",
          "duration": 1800,
          "limit_price": "45000.00",
          "engine_passiveness": "0.5",
          "schedule_discretion": "0.3",
          "alpha_tilt": "0.1",
          "is_active": false,
          "is_paused": false,
          "failure_reason": null,
          "fee": "11.25",
          "fills": [
            {
              "id": "fill_001",
              "timestamp": "2023-12-01T10:05:00Z",
              "quantity": "0.04166667",
              "price": "45000.00",
              "notional": "1875.00",
              "venue": "binance",
              "fee": "1.875"
            }
          ]
        }
      ]
    }
  ],
  "page_number": 1,
  "page_size": 100,
  "num_pages": 2,
  "multi_order_count": 144
}

{
    "errors": ["<field_name> is invalid"]
}

Submit Multi Order

POST /api/multi_orders/

Submit a multi-order containing multiple child orders for scheduling and execution. This endpoint allows you to create a group of related orders that share common parameters while allowing individual customization for each child order.

Request Body

Name

Type

Required

Description

accounts

array[string]

Yes

List of account names to use for the multi-order

duration

integer

Yes

Duration of the multi-order in seconds

strategy

string

Yes

Strategy name to use for execution. Ex. VWAP

engine_passiveness

decimal

Yes

Engine passiveness value (0.0 to 1.0)

schedule_discretion

decimal

Yes

Schedule discretion value (0.0 to 1.0)

child_orders

array[object]

Yes

Array of child order objects

strategy_params

object

Strategy-specific parameters

alpha_tilt

decimal

Alpha tilt value for order execution

exposure_tolerance

decimal

Exposure tolerance for the multi-order

limit_price_spread

decimal

Dynamic limit price spread for spread trades

order_condition

string

Conditional order expression

start_timedate

string

ISO 8601 timestamp for order start (defaults to now)

custom_order_id

string

Custom identifier for the multi-order

notes

string

Additional notes for the multi-order

Child Order Object

Name

Type

Required

Description

pair

string

Yes

Trading pair symbol

side

string

Yes

Order side: buy or sell

base_asset_qty

decimal

Yes

Base asset quantity

accounts

array[string]

Specific accounts for this child order (overrides parent accounts)

quote_asset_qty

decimal

Quote asset quantity (alternative to base_asset_qty)

notes

string

Notes specific to this child order

alpha_tilt

decimal

Alpha tilt specific to this child order

pos_side

string

Position side: long or short. Required if exchange account is configured to be in Hedge Mode.

Example Request

POST /api/multi_orders/
Authorization: Bearer <token>
Content-Type: application/json

{
  "accounts": ["binance_main"],
  "duration": 3600,
  "strategy": "TWAP",
  "engine_passiveness": 0.5,
  "schedule_discretion": 0.3,
  "alpha_tilt": 0.1,
  "exposure_tolerance": 0.05,
  "custom_order_id": "multi_order_123",
  "notes": "for xyz",
  "child_orders": [
    {
      "pair": "BTC:PERP-USDT",
      "side": "buy",
      "quote_asset_qty": 100000,
    },
    {
      "pair": "ETH:PERP-USDT",
      "side": "sell",
      "quote_asset_qty": 100000,
    }
  ]
}

Response

{
    "id": "397e42c1-a617-458b-9db9-dc51f326b918",
    "created_at": "2025-01-13T20:33:22.331268Z",
    "updated_at": "2025-01-13T20:33:22.331288Z",
    "start_datetime": "2025-01-13T20:33:22.323949Z",
    "duration": 600,
    "exposure_tolerance": "0.50000000000000000000",
    "notional_exposure": 34.554926518,
    "executed_notional": 93712.607473482,
    "is_active": false,
    "child_order_ids": [
        "5ee11fdd-334d-418a-b138-7df74f17e417",
        "54509111-7204-4626-8513-d7f040f76bf3"
    ],
    "strategy": "ccb82677-249d-4b01-8f60-7a02379e963a",
    "strategy_params": {},
    "engine_passiveness": "0.02000000000000000000",
    "schedule_discretion": "0.06000000000000000000",
    "alpha_tilt": "0.00000000000000000000",
    "pov_limit": null,
    "limit_price_spread": null,
    "order_condition": "ETH-USDT@Binance ETH:PERP-USDT@Binance - 1 >",
    "order_condition_vars": {},
    "order_condition_expiry": null,
    "user": "13",
    "status": "SCHEDULED",
    "failure_reason": "",
    "completely_filled": true,
    "is_paused": false,
    "pct_filled": 100.0,
    "account_names": [
        "mock"
    ],
    "pairs": "BTC-USDT,BTC:PERP-USDT",
    "calculated_status": "COMPLETE",
    "sell_token_amount": "0.50000000000000000000, 46871.66540000000000000000",
    "buy_token": "USDT, BTC:PERP",
    "sell_token": "BTC, USDT"
}

{
  "errors": [
    "Need at least one top level account or individual child order accounts",
    "Cannot have more than one of the qty fields: ['base_asset_qty', 'quote_asset_qty', 'sell_token_amount']"
  ]
}

Cancel Multi Orders

POST /api/cancel_multi_orders/

Cancel multi orders identified by the provided list of order IDs or custom order IDs, canceling all child orders and their active placements. Must provide either order_ids or custom_order_ids.

Request Body

Name

Type

Description

order_ids

array[string]

list of multi order UUIDs

custom_order_ids

array[string]

array of user specified custom order IDs

Response

{
  "message": "Multi orders canceled!"
}

{
  "errors": ["Missing required field: order_ids or custom_order_ids"]
}

{
  "errors": ["Unexpected failure while cancelling order"]
}

Pause Multi Order

POST /api/pause_multi_order/

Pause a multi-order and all its child orders, canceling all active placements and stopping execution until resumed. The multi-order will maintain its current state and can be resumed later.

Request Body

Name

Type

Description

multi_order_id*

string

Name of the user

Example Request

POST /api/pause_multi_order/
Authorization: Bearer <token>
Content-Type: application/json

{
  "multi_order_id": "6debb950-614a-4366-b73b-7d7574fd9e15"
}

Response Codes

{
    "message": "Successfully paused multi order."
}

Occurs when:

The multi_order_id field is missing from the request body
The multi-order is already paused or terminated

{
    "error": "Multi Order already paused or terminated"
}

Occurs when:

The user does not have permission to pause the specified multi-order (not the owner or not a superuser)

Sample Error Message

{
    "error": "Unauthorized"
}

Occurs when:

No multi-order exists with the given multi_order_id

Sample Error Message

{
    "error": "No multi order found with given ID!"
}

Sample Error Message

{
    "error": "Failed to pause all child orders: <error details>"
}

{
  "error": "Internal server error"
}

Resume Multi Order

POST /api/resume_multi_order/

Resume all legs of the multi order

Request Body

Name

Type

Description

multi_order_id*

string

UUID of the multi-order to resume. Required Field

Example Request

POST /api/resume_multi_order/
Authorization: Bearer <token>
Content-Type: application/json

{
  "multi_order_id": "6debb950-614a-4366-b73b-7d7574fd9e15"
}

Response Codes

{
    "message": "Successfully resumed multi order."
}

Occurs when:

The multi_order_id field is missing from the request body
The multi-order is not currently paused

Sample Error Messages

{
  "error": "Missing required field: multi_order_id"
}

Occurs when:

The user does not have permission to resume the specified multi-order (not the owner or not a superuser)

Sample Error Message

{
    "example": "Unauthorized"
}

Occurs when:

An error occurs while resuming one or more child orders
There is a backend error during the resume operation

Sample Error Message

{
    "error": "Failed to resume all child orders: <error details>"
}

PreviousAlgorithmic Orders (VWAP, TWAP, POV)NextAccounts

Last updated 1 month ago

Was this helpful?