Replace Order

v1.orders.replace_order(, ) -> OrderReplaceOrderResponse

PATCH/v1/accounts/{account_id}/orders/{order_id}

Replace an order with new parameters

ParametersExpand Collapse

account_id: int

order_id: str

limit_price: Optional[str]

New limit price for the order

quantity: Optional[str]

New quantity for the order

stop_price: Optional[str]

New stop price for the order

time_in_force: Optional[RequestTimeInForce]

New time in force for the order

One of the following:

"DAY"

"GOOD_TILL_CANCEL"

"IMMEDIATE_OR_CANCEL"

"FILL_OR_KILL"

"GOOD_TILL_DATE"

"AT_THE_OPENING"

"AT_THE_CLOSE"

"GOOD_TILL_CROSSING"

"GOOD_THROUGH_CROSSING"

"AT_CROSSING"

ReturnsExpand Collapse

class OrderReplaceOrderResponse: …

data: Order

A trading order with its current state and execution details.

This is the unified API representation of an order across its lifecycle, combining data from execution reports, order status queries, and parent/child tracking.

id: str

Engine-assigned unique identifier for this order (UUID).

account_id: int

Account placing the order

formatint64

client_order_id: str

Client-provided identifier echoed back.

created_at: datetime

Timestamp when order was created (UTC)

formatdate-time

filled_quantity: str

Cumulative filled quantity

instrument_id: str

Instrument identifier for the traded instrument.

formatuuid

instrument_type: SecurityType

Type of security

One of the following:

"COMMON_STOCK"

"OPTION"

"CASH"

leaves_quantity: str

Remaining unfilled quantity

order_type: OrderType

Type of order (MARKET, LIMIT, etc.)

One of the following:

"MARKET"

"LIMIT"

"STOP"

"STOP_LIMIT"

"TRAILING_STOP"

"TRAILING_STOP_LIMIT"

"OTHER"

quantity: str

Total order quantity

side: Side

Side of the order (BUY, SELL, SELL_SHORT)

One of the following:

"BUY"

"SELL"

"SELL_SHORT"

"OTHER"

status: OrderStatus

Current status of the order

One of the following:

"PENDING_NEW"

"NEW"

"PARTIALLY_FILLED"

"FILLED"

"CANCELED"

"REJECTED"

"EXPIRED"

"PENDING_CANCEL"

"PENDING_REPLACE"

"REPLACED"

"DONE_FOR_DAY"

"STOPPED"

"SUSPENDED"

"CALCULATED"

"OTHER"

symbol: str

Trading symbol

time_in_force: TimeInForce

Time in force instruction

One of the following:

"DAY"

"GOOD_TILL_CANCEL"

"IMMEDIATE_OR_CANCEL"

"FILL_OR_KILL"

"GOOD_TILL_DATE"

"AT_THE_OPENING"

"AT_THE_CLOSE"

"GOOD_TILL_CROSSING"

"GOOD_THROUGH_CROSSING"

"AT_CROSSING"

"OTHER"

updated_at: datetime

Timestamp of the most recent update (UTC)

formatdate-time

venue: str

MIC code of the venue where the order is routed

average_fill_price: Optional[str]

Average fill price across all executions When a null/undefined value is observed, it indicates that there is no available data.

details: Optional[List[str]]

Contains execution, rejection or cancellation details, if any

expires_at: Optional[datetime]

Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE. When a null/undefined value is observed, it indicates it does not apply.

formatdate-time

extended_hours: Optional[bool]

Whether the order is eligible for extended-hours trading.

limit_offset: Optional[str]

Limit offset for trailing stop-limit orders (signed) When a null/undefined value is observed, it indicates it does not apply.

limit_price: Optional[str]

Limit price (for LIMIT and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.

queue_state: Optional[QueueState]

Parent order queue state, present when the order is awaiting release or released. When a null/undefined value is observed, it indicates it does not apply.

One of the following:

"AWAITING_RELEASE"

"RELEASED"

releases_at: Optional[datetime]

Scheduled release time for orders awaiting release. When a null/undefined value is observed, it indicates it does not apply.

formatdate-time

stop_price: Optional[str]

Stop price (for STOP and STOP_LIMIT orders) When a null/undefined value is observed, it indicates it does not apply.

trailing_limit_px: Optional[str]

Current trailing limit price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.

trailing_offset: Optional[str]

Trailing offset amount for trailing orders When a null/undefined value is observed, it indicates it does not apply.

trailing_offset_type: Optional[TrailingOffsetType]

Trailing offset type for trailing orders When a null/undefined value is observed, it indicates it does not apply.

One of the following:

"PRICE"

"BPS"

trailing_stop_px: Optional[str]

Current trailing stop price computed by the trailing strategy When a null/undefined value is observed, it indicates it does not apply.

trailing_watermark_px: Optional[str]

Trailing watermark price for trailing orders When a null/undefined value is observed, it indicates it does not apply.

trailing_watermark_ts: Optional[datetime]

Trailing watermark timestamp for trailing orders When a null/undefined value is observed, it indicates it does not apply.

formatdate-time

underlying_instrument_id: Optional[str]

Instrument ID of the option’s underlying instrument. Populated only for options orders. A null means one of two things: the order is not an option, so the field does not apply; or the order is an option whose underlier has not yet been resolved. When a null/undefined value is observed, it indicates it does not apply.

formatuuid

Replace Order

from clearstreet import ClearStreet

client = ClearStreet(
    api_key="My API Key",
)
response = client.v1.orders.replace_order(
    order_id="order_id",
    account_id=0,
)
print(response)

{
  "data": {
    "account_id": 19816,
    "client_order_id": "my-ref-id-20251001-001",
    "created_at": "2025-10-31T13:30:00.000000000Z",
    "filled_quantity": "0",
    "id": "0195f6c7-4f64-7e3c-8b0a-1d8e4f5e6a7b",
    "instrument_id": "d4d5d6d7-e4e5-f4f5-a4a5-a6a7a8a9aaab",
    "instrument_type": "COMMON_STOCK",
    "leaves_quantity": "10",
    "limit_price": "49.00",
    "order_type": "LIMIT",
    "quantity": "10",
    "side": "BUY",
    "status": "PENDING_REPLACE",
    "stop_price": null,
    "symbol": "TSLA",
    "time_in_force": "DAY",
    "updated_at": "2025-10-31T14:10:00.000000000Z",
    "venue": "XNAS"
  },
  "error": null,
  "metadata": {
    "request_id": "1d2e3f4a-5b6c-7d8e-9f0a-1b2c3d4e5f6a"
  }
}

{
  "error": {
    "code": 400,
    "message": "Failed to parse the request body as JSON: expected `:` at line 2 column 14"
  },
  "metadata": {
    "request_id": "633c15ef-d2e7-4f27-b905-2819455248bb"
  }
}

{
  "error": {
    "code": 403,
    "message": "The caller does not have permission to execute the specified operation"
  },
  "metadata": {
    "request_id": "5518f0c6-58ff-4b4a-81a5-701556d41206"
  }
}

{
  "error": {
    "code": 404,
    "message": "Order 019c7b89-feea-7600-9e56-f15ef0557835 not found for account 100001"
  },
  "metadata": {
    "request_id": "9e290ec2-378f-4d08-a729-0a9ab155acbf"
  }
}

Returns Examples

{
  "data": {
    "account_id": 19816,
    "client_order_id": "my-ref-id-20251001-001",
    "created_at": "2025-10-31T13:30:00.000000000Z",
    "filled_quantity": "0",
    "id": "0195f6c7-4f64-7e3c-8b0a-1d8e4f5e6a7b",
    "instrument_id": "d4d5d6d7-e4e5-f4f5-a4a5-a6a7a8a9aaab",
    "instrument_type": "COMMON_STOCK",
    "leaves_quantity": "10",
    "limit_price": "49.00",
    "order_type": "LIMIT",
    "quantity": "10",
    "side": "BUY",
    "status": "PENDING_REPLACE",
    "stop_price": null,
    "symbol": "TSLA",
    "time_in_force": "DAY",
    "updated_at": "2025-10-31T14:10:00.000000000Z",
    "venue": "XNAS"
  },
  "error": null,
  "metadata": {
    "request_id": "1d2e3f4a-5b6c-7d8e-9f0a-1b2c3d4e5f6a"
  }
}

{
  "error": {
    "code": 400,
    "message": "Failed to parse the request body as JSON: expected `:` at line 2 column 14"
  },
  "metadata": {
    "request_id": "633c15ef-d2e7-4f27-b905-2819455248bb"
  }
}

{
  "error": {
    "code": 403,
    "message": "The caller does not have permission to execute the specified operation"
  },
  "metadata": {
    "request_id": "5518f0c6-58ff-4b4a-81a5-701556d41206"
  }
}

{
  "error": {
    "code": 404,
    "message": "Order 019c7b89-feea-7600-9e56-f15ef0557835 not found for account 100001"
  },
  "metadata": {
    "request_id": "9e290ec2-378f-4d08-a729-0a9ab155acbf"
  }
}