HomeGuidesRecipesAPI ReferenceGraphQLChangelogDiscussionsv2023.08
HomeLog In
API Reference
These docs are for v2023.08. Click to read the latest docs for v2023.12.

Replace an Order

Replaces a single order with updated parameters. Each parameter overrides the corresponding attribute of the existing order. The other attributes remain the same as the existing order.

A success return code from a replaced order does NOT guarantee the existing open order has been replaced. If the existing open order is filled before the replacing (new) order reaches the execution venue, the replacing (new) order is rejected, and these events are sent in the trade_updates stream channel found here in the market data api.

While an order is being replaced, the account's buying power is reduced by the larger of the two orders that have been placed (the old order being replaced, and the newly placed order to replace it). If you are replacing a buy entry order with a higher limit price than the original order, the buying power is calculated based on the newly placed order. If you are replacing it with a lower limit price, the buying power is calculated based on the old order.

Path Params
uuid
required

Account identifier.

string
required

Order identifier.

Body Params
string

You can only patch full shares for now

string
enum
Allowed:
string

Required if original order's type field was limit or stop_limit

string

Required if original order's type field was stop or stop_limit

string

The new value of the trail_price or trail_percent

string
Responses

403

Buying power or shares are not sufficient

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

©2023. Prime Industries, Services, and Trinkets LLC. We are not responsible