For the complete documentation index, see llms.txt. This page is also available as Markdown.

Edit Algo Order

Update a pending algorithmic order and its child orders.

Endpoint

PUT /v1/algo/order

Mainnet: PUT https://api.orderly.org/v1/algo/order

Testnet: PUT https://testnet-api.orderly.org/v1/algo/order

Rate limit: 5 requests per second. Use this signed endpoint to amend a pending algorithmic order by its order ID. Only the price or quantity can be changed. The API key must have the trading scope.

Authentication headers

  • orderly-timestamp — signed-request timestamp in milliseconds.

  • orderly-account-id — PangoPerps account ID.

  • orderly-key — public API key.

  • orderly-signature — request signature.

  • Content-Type: application/json — JSON request body.

Request body

Send a JSON object. The root order ID is required; the other fields are available for updating the order or its trigger/child-order configuration.

Field
Type
Required
Description

order_id

string

Yes

ID of the pending algorithmic order.

price

number

No

Updated order price.

quantity

number

No

Updated order quantity.

trigger_price

number

No

Updated trigger price.

trigger_price_type

string

No

Price source used for the trigger.

child_orders

object[]

No

Child order updates, represented as an array of child-order objects.

A child order can include order_id, trigger_price, price, quantity, is_activated, trigger_price_type, and nested child_orders. The endpoint description limits amendments to the order's price or quantity; trigger and child fields are part of the documented request schema for algorithmic orders.

Example request

Successful response

HTTP 200 returns an EDIT_SENT status when the edit request is sent for processing.

Last updated