Replace Order

OrderReplaceOrderResponse v1().orders().replaceOrder(, )

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

Replace an order with new parameters

ParametersExpand Collapse

OrderReplaceOrderParams params

long accountId

Optional<String> orderId

Optional<String> limitPrice

New limit price for the order

Optional<String> quantity

New quantity for the order

Optional<String> stopPrice

New stop price for the order

Optional<RequestTimeInForce> timeInForce

New time in force for the order

ReturnsExpand Collapse

class OrderReplaceOrderResponse:

Order data

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.

String id

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

long accountId

Account placing the order

formatint64

String clientOrderId

Client-provided identifier echoed back (FIX tag 11).

LocalDateTime createdAt

Timestamp when order was created (UTC)

formatdate-time

String filledQuantity

Cumulative filled quantity

String instrumentId

OEMS instrument UUID for the traded instrument.

formatuuid

SecurityType instrumentType

Type of security

One of the following:

COMMON_STOCK("COMMON_STOCK")

PREFERRED_STOCK("PREFERRED_STOCK")

OPTION("OPTION")

CASH("CASH")

OTHER("OTHER")

String leavesQuantity

Remaining unfilled quantity

OrderType orderType

Type of order (MARKET, LIMIT, etc.)

One of the following:

MARKET("MARKET")

LIMIT("LIMIT")

STOP("STOP")

STOP_LIMIT("STOP_LIMIT")

TRAILING_STOP("TRAILING_STOP")

TRAILING_STOP_LIMIT("TRAILING_STOP_LIMIT")

OTHER("OTHER")

String quantity

Total order quantity

Side side

Side of the order (BUY, SELL, SELL_SHORT)

One of the following:

BUY("BUY")

SELL("SELL")

SELL_SHORT("SELL_SHORT")

OTHER("OTHER")

OrderStatus status

Current status of the order

One of the following:

PENDING_NEW("PENDING_NEW")

NEW("NEW")

PARTIALLY_FILLED("PARTIALLY_FILLED")

FILLED("FILLED")

CANCELED("CANCELED")

REJECTED("REJECTED")

EXPIRED("EXPIRED")

PENDING_CANCEL("PENDING_CANCEL")

PENDING_REPLACE("PENDING_REPLACE")

REPLACED("REPLACED")

DONE_FOR_DAY("DONE_FOR_DAY")

STOPPED("STOPPED")

SUSPENDED("SUSPENDED")

CALCULATED("CALCULATED")

OTHER("OTHER")

String symbol

Trading symbol

TimeInForce timeInForce

Time in force instruction

One of the following:

DAY("DAY")

GOOD_TILL_CANCEL("GOOD_TILL_CANCEL")

IMMEDIATE_OR_CANCEL("IMMEDIATE_OR_CANCEL")

FILL_OR_KILL("FILL_OR_KILL")

GOOD_TILL_DATE("GOOD_TILL_DATE")

AT_THE_OPENING("AT_THE_OPENING")

AT_THE_CLOSE("AT_THE_CLOSE")

GOOD_TILL_CROSSING("GOOD_TILL_CROSSING")

GOOD_THROUGH_CROSSING("GOOD_THROUGH_CROSSING")

AT_CROSSING("AT_CROSSING")

OTHER("OTHER")

LocalDateTime updatedAt

Timestamp of the most recent update (UTC)

formatdate-time

String venue

MIC code of the venue where the order is routed

Optional<String> averageFillPrice

Average fill price across all executions

Optional<List<String>> details

Contains execution, rejection or cancellation details, if any

Optional<LocalDateTime> expiresAt

Timestamp when the order will expire (UTC). Present when time_in_force is GOOD_TILL_DATE.

formatdate-time

Optional<Boolean> extendedHours

Whether the order is eligible for extended-hours trading.

Optional<String> limitOffset

Limit offset for trailing stop-limit orders (signed)

Optional<String> limitPrice

Limit price (for LIMIT and STOP_LIMIT orders)

Optional<QueueState> queueState

Parent order queue state, present when the order is awaiting release or released.

One of the following:

AWAITING_RELEASE("AWAITING_RELEASE")

RELEASED("RELEASED")

Optional<LocalDateTime> releasesAt

Scheduled release time for orders awaiting release.

formatdate-time

Optional<String> stopPrice

Stop price (for STOP and STOP_LIMIT orders)

Optional<String> trailingLimitPx

Current trailing limit price computed by the trailing strategy

Optional<String> trailingOffset

Trailing offset amount for trailing orders

Optional<TrailingOffsetType> trailingOffsetType

Trailing offset type for trailing orders

One of the following:

PRICE("PRICE")

BPS("BPS")

Optional<String> trailingStopPx

Current trailing stop price computed by the trailing strategy

Optional<String> trailingWatermarkPx

Trailing watermark price for trailing orders

Optional<LocalDateTime> trailingWatermarkTs

Trailing watermark timestamp for trailing orders

formatdate-time

Optional<String> underlyingInstrumentId

OEMS instrument ID of the option’s underlying instrument. Populated only for OPTIONS orders; null for non-options and for options whose underlier cannot be resolved from the instrument cache.

formatuuid

Replace Order

package com.clear_street.api.example;

import com.clear_street.api.client.ClearStreetClient;
import com.clear_street.api.client.okhttp.ClearStreetOkHttpClient;
import com.clear_street.api.models.v1.orders.OrderReplaceOrderParams;
import com.clear_street.api.models.v1.orders.OrderReplaceOrderResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        ClearStreetClient client = ClearStreetOkHttpClient.builder()
            .fromEnv()
            .apiKey("My API Key")
            .build();

        OrderReplaceOrderParams params = OrderReplaceOrderParams.builder()
            .accountId(0L)
            .orderId("order_id")
            .build();
        OrderReplaceOrderResponse response = client.v1().orders().replaceOrder(params);
    }
}

{
  "data": {
    "account_id": 19816,
    "average_fill_price": "149.95",
    "created_at": "2025-10-31T13:30:00.000000000Z",
    "filled_quantity": "50",
    "id": "my-ref-id-20251001-001",
    "instrument_id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8",
    "instrument_type": "COMMON_STOCK",
    "leaves_quantity": "50",
    "limit_price": "150.50",
    "order_type": "LIMIT",
    "quantity": "125",
    "side": "BUY",
    "status": "PENDING_REPLACE",
    "stop_price": null,
    "symbol": "AAPL",
    "time_in_force": "DAY",
    "updated_at": "2025-10-31T14:10:00.000000000Z"
  },
  "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,
    "average_fill_price": "149.95",
    "created_at": "2025-10-31T13:30:00.000000000Z",
    "filled_quantity": "50",
    "id": "my-ref-id-20251001-001",
    "instrument_id": "a1a2a3a4-b1b2-c1c2-d1d2-d3d4d5d6d7d8",
    "instrument_type": "COMMON_STOCK",
    "leaves_quantity": "50",
    "limit_price": "150.50",
    "order_type": "LIMIT",
    "quantity": "125",
    "side": "BUY",
    "status": "PENDING_REPLACE",
    "stop_price": null,
    "symbol": "AAPL",
    "time_in_force": "DAY",
    "updated_at": "2025-10-31T14:10:00.000000000Z"
  },
  "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"
  }
}