Modify Options

Interface description

• Function description: Modify options orders. This function supports modifying quantity, price. It is recommended to use the v2 order query interface for option order inquiries: Order Detail V2

• Request URL: /openapi/account/orders/option/replace?account_id={account_id}

• Request method: POST

• Frequency limit: The calling frequency of each AppId is limited to 1 time per second.

Parameters

Parameter	Type	Required	Description	Example value
account_id	String	Required	Account ID	2847483
modify_orders	[]order_item	Required	Order Details

order_item:

Parameter	Type	Required	Description	Example value
client_order_id	String	Required	Order ID	0KGOHL4PR2SLC0DKIND4TI0002
stop_price	String	Optional	Stop Price	11.00
limit_price	String	Optional	Limit Price	11.00
quantity	String	Optional	Quantity	1
orders	[]order	Required	Leg detail

order

Parameter	Type	Required	Description	Example value
client_order_id	String	Required	single leg: client_order_id	G2JAJPOR4KUA0F5I9LONH8J83A
quantity	String	Required	Quantity	1

Response

Parameter	Type	Required	Description	Example value
client_order_id	String	Optional	Client Order ID Simple order return	0KGOHL4PR2SLC0DKIND4TI0002
order_id	String	Optional	Order ID Simple order return	80HG7CPSFDPCAL3TP66LKBAS69

Request Example

Single-leg Options

Python

from webullsdktrade.api import API
from webullsdkcore.client import ApiClient
from webullsdkcore.common.region import Region

client_order_id = uuid.uuid4().hex
option_modify_orders = [
    {
        "client_order_id": client_order_id,
        "quantity": "2",
        "limit_price": "11.3",
        "orders": [
            {
                "client_order_id": client_order_id,
                "quantity": "2"
            }
        ]
    }
]

api_client = ApiClient(your_app_key, your_app_secret, Region.HK.value)
api = API(api_client)
response = api.order.replace_option(account_id, option_modify_orders)
if response.status_code == 200:
    order_res = response.json()

Java

HttpApiConfig apiConfig = HttpApiConfig.builder()
        .appKey(Env.APP_KEY)
        .appSecret(Env.APP_SECRET)
        .regionId(Region.hk.name())
        .build();
TradeApiService apiService = new TradeHttpApiService(apiConfig);

OptionOrderItemLeg optionReplaceItemLeg = new OptionOrderItemLeg();
optionReplaceItemLeg.setQuantity("2");
optionReplaceItemLeg.setClientOrderId(clientOrderId);
List<OptionOrderItemLeg> optionReplaceItemLegList = new ArrayList<>();
optionReplaceItemLegList.add(optionReplaceItemLeg);

OptionOrderItem optionReplaceItem = new OptionOrderItem();
optionReplaceItem.setClientOrderId(clientOrderId();
optionReplaceItem.setLimitPrice("3");
optionReplaceItem.setQuantity("2");
optionReplaceItem.setOrders(optionReplaceItemLegList);
List<OptionOrderItem> optionReplaceItemList = new ArrayList<>();
optionReplaceItemList.add(optionReplaceItem);

OptionOrder optionReplace = new OptionOrder();
optionReplace.setModifyOrders(optionReplaceItemList);

TradeOrderResponse tradeReplaceOptionResponse = apiService.replaceOption(accountId, optionReplace);

Response Example

Single-leg Options

Exception Example