# Replace Order
Modifies equity and options orders.
# OpenAPI definition
```json
{
"info": {
"title": "Webull OpenAPI Documentation",
"description": "The Webull OpenAPI enables integration of trading APIs, market data for building trading applications and brokerage solutions. It supports HTTP-based historical and real-time market data and MQTT streaming via WebSocket/TCP, along with SDKs, secure authentication, and APIs for orders, accounts, and event contract trading.",
"contact": {
"name": "Webull Developer Support",
"url": "https://www.webull.hk/en/help",
"email": "webull-api-support@webull.com"
},
"version": "2.0",
"x-logo": {
"url": "static/png/logo.png"
}
},
"servers": [
{
"url": "https://api.sandbox.webull.hk"
}
],
"path": "/trading/orders/replace",
"method": "post",
"tags": [
"Trading"
],
"description": "Modifies equity and options orders.",
"operationId": "Common Order Replace",
"parameters": [
{
"name": "x-app-key",
"in": "header",
"description": "A unique identifier issued to a developer for accessing an application's API.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-app-secret",
"in": "header",
"description": "A unique key issued to developers to access the application's API.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-timestamp",
"in": "header",
"description": "Timestamp of the request, follows ISO8601 format: YYYY-MM-DDThh:mm:ssZ, e.g. 2023-07-16T19:23:51Z, only supports UTC time zone.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-signature-version",
"in": "header",
"description": "Signature algorithm version, default is 1.0.",
"required": true,
"schema": {
"type": "string",
"default": "1.0"
},
"examples": {
"1.0": {
"value": "1.0"
}
}
},
{
"name": "x-signature-algorithm",
"in": "header",
"description": "Signature algorithm, default is HMAC-SHA1.",
"required": true,
"schema": {
"type": "string",
"default": "HMAC-SHA1"
},
"examples": {
"HMAC-SHA1": {
"value": "HMAC-SHA1"
}
}
},
{
"name": "x-signature-nonce",
"in": "header",
"description": "Signature unique random number.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-access-token",
"in": "header",
"description": "An access token is a credential that represents the authorization granted to a client (e.g., a user or an application) to access specific protected resources on behalf of a user, without needing to share their password.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "x-version",
"in": "header",
"description": "API interface version. Supported values: `v2`, `v3`.",
"required": true,
"schema": {
"type": "string",
"default": "v3"
},
"examples": {
"v3": {
"value": "v3"
}
}
},
{
"name": "x-signature",
"in": "header",
"description": "A signature is a unique digital fingerprint, typically encrypted, that verifies the authenticity and integrity of a message or transaction, ensuring it has not been tampered with during transmission.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"account_id",
"modify_orders"
],
"type": "object",
"properties": {
"account_id": {
"type": "string",
"description": "Account identifier",
"example": "93IUJ28O9VO2KBGHDHR4H9"
},
"modify_orders": {
"type": "array",
"description": "Order Details",
"items": {
"required": [
"client_order_id"
],
"type": "object",
"properties": {
"client_order_id": {
"type": "string",
"description": "Unique client-defined identifier for the order.
Maximum length is 32 characters and must be unique per account.
Allowed characters: letters (A–Z, a–z), digits (0–9), hyphen (-), underscore (_).
Used to track or reference the order when interacting with the system.",
"example": "0KGOHL4PR2SLC0DKIND4TI0002"
},
"time_in_force": {
"type": "string",
"description": "Specifies the duration for which the order remains active in the market (Time-In-Force).
• DAY: The order is valid only for the current trading day and expires at the end of the day.
• GTD: order that will automatically expire and be cancelled at a specific future date and time,Currently only supports the US market.
• GTC: Good-Till-Canceled, the order remains active until it is executed, explicitly canceled, or reaches the maximum allowed duration (typically 90 days).",
"example": "DAY",
"enum": [
"DAY",
"GTD",
"GTC"
]
},
"quantity": {
"type": "string",
"description": "Transaction quantity. You can specify decimals when placing fractional lot orders for US stocks.",
"example": "1"
},
"expire_date": {
"type": "string",
"description": "GTD order expire date. format (UTC). The value must be in yyyy-MM-dd format",
"example": "2026-01-01"
},
"limit_price": {
"type": "string",
"description": "Limit price of the order. Required when order_type is LIMIT, STOP_LOSS_LIMIT or TOUCH_LMT.
Specifies the maximum (for buy) or minimum (for sell) price at which the order can be executed.",
"example": "11.0"
},
"stop_price": {
"type": "string",
"description": "Stop price of the order. Required when order_type is STOP_LOSS, STOP_LOSS_LIMIT, TOUCH_MKT or TOUCH_LMT.
Specifies the trigger price at which the stop order becomes active.",
"example": "11.0"
},
"trailing_type": {
"type": "string",
"description": "When market continues to fall, the stop price to buy follows, or trails, the lowest price of a stock by a trail that you set. Required when order_type is TRAILING_STOP_LOSS or TRAILING_STOP_LOSS_LIMIT.
• AMOUNT: By amount.
• PERCENTAGE: By percentage.",
"example": "AMOUNT",
"enum": [
"AMOUNT",
"PERCENTAGE"
]
},
"trailing_stop_step": {
"type": "string",
"description": "Trailing Stop Spread. If the tracking type is percentage, the tracking spread can not exceed 1,0.01 means 1%. Required when order_type is TRAILING_STOP_LOSS or TRAILING_STOP_LOSS_LIMIT.",
"example": "1"
},
"trailing_limit_price_offset": {
"type": "string",
"description": "The offset amount between the triggered stop price and the submitted limit price for a trailing stop-limit order. Required when order_type is TRAILING_STOP_LOSS_LIMIT.
When triggered, the limit order price is calculated as:
• Buy: limit price = stop price + trailing_limit_price_offset
• Sell: limit price = stop price − trailing_limit_price_offset
If the calculated limit price does not align with the instrument's tick size, it will be rounded to the nearest valid tick: rounded up for buy orders, rounded down for sell orders.",
"example": "11.0"
},
"trigger_price_type": {
"type": "string",
"description": "Trigger price type of the order
• PRICE: Latest transaction price.
• PRICE_BID: Buy at one price.
• PRICE_ASK: Sell at one price. ",
"example": "PRICE",
"enum": [
"PRICE",
"PRICE_BID",
"PRICE_ASK"
]
}
},
"description": "Order Details",
"title": "OrderCommonReplaceItemParam"
}
}
},
"title": "OrderCommonReplaceParam"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"client_order_id": {
"type": "string",
"description": "Client-defined order identifier. Returned in the response for simple orders.
Represents the unique order ID assigned by the user when placing the order for NORMAL order.",
"example": "0KGOHL4PR2SLC0DKIND4TI0002"
},
"order_id": {
"type": "string",
"description": "System-generated order identifier. Returned in the response for simple orders.
Represents the unique Webull order ID assigned by the system when placing the order for NORMAL order.",
"example": "80HG7CPSFDPCAL3TP66LKBAS69"
}
},
"title": "OrderCommonWriteResult"
}
}
}
},
"401": {
"description": "Unauthorized: Authentication required",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Internal logic error code",
"example": "UNAUTHORIZED"
},
"message": {
"type": "string",
"description": "Error message",
"example": "Insufficient permission"
}
}
}
}
}
},
"417": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "error code",
"example": "OPENAPI_NO_NIGHT_TRADING_TIME"
},
"message": {
"type": "string",
"description": "error message",
"example": "The current period does not support placing night orders"
}
},
"description": "Business Response",
"title": "BizResponse"
}
}
}
},
"500": {
"description": "Internal Server Error.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error_code": {
"type": "string",
"description": "Internal logic error code",
"example": "SYSTEM_ERROR"
},
"message": {
"type": "string",
"description": "Error message",
"example": "Internal Server Error"
}
}
}
}
}
}
},
"jsonRequestBodyExample": {
"account_id": "93IUJ28O9VO2KBGHDHR4H9",
"modify_orders": [
{
"client_order_id": "0KGOHL4PR2SLC0DKIND4TI0002",
"time_in_force": "DAY",
"quantity": "1",
"expire_date": "2026-01-01",
"limit_price": "11.0",
"stop_price": "11.0",
"trailing_type": "AMOUNT",
"trailing_stop_step": "1",
"trailing_limit_price_offset": "11.0",
"trigger_price_type": "PRICE"
}
]
},
"postman": {
"name": "Replace Order",
"description": {
"content": "Modifies equity and options orders.",
"type": "text/plain"
},
"url": {
"path": [
"trading",
"orders",
"replace"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"disabled": false,
"description": {
"content": "(Required) A unique identifier issued to a developer for accessing an application's API.",
"type": "text/plain"
},
"key": "x-app-key",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) A unique key issued to developers to access the application's API.",
"type": "text/plain"
},
"key": "x-app-secret",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) Timestamp of the request, follows ISO8601 format: YYYY-MM-DDThh:mm:ssZ, e.g. 2023-07-16T19:23:51Z, only supports UTC time zone.",
"type": "text/plain"
},
"key": "x-timestamp",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) Signature algorithm version, default is 1.0.",
"type": "text/plain"
},
"key": "x-signature-version",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) Signature algorithm, default is HMAC-SHA1.",
"type": "text/plain"
},
"key": "x-signature-algorithm",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) Signature unique random number.",
"type": "text/plain"
},
"key": "x-signature-nonce",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) An access token is a credential that represents the authorization granted to a client (e.g., a user or an application) to access specific protected resources on behalf of a user, without needing to share their password.",
"type": "text/plain"
},
"key": "x-access-token",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) API interface version. Supported values: `v2`, `v3`.",
"type": "text/plain"
},
"key": "x-version",
"value": ""
},
{
"disabled": false,
"description": {
"content": "(Required) A signature is a unique digital fingerprint, typically encrypted, that verifies the authenticity and integrity of a message or transaction, ensuring it has not been tampered with during transmission.",
"type": "text/plain"
},
"key": "x-signature",
"value": ""
},
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
}
}
}
```