The ChangeSingleOrderRequest object is used as an input in ChangeSingleOrder API. This API can be used to modify the parameters (volume, price type, expiration type etc.) of a single order using its order ID.
ChangeSingleOrderRequest
| Field Name | Required? | Data Type | Accepted Values/Examples |
|---|---|---|---|
| ExpirationDate | No | google.protobuf.Timestamp | Date at which order is no longer valid |
| GoodFrom | No | google.protobuf.Timestamp | Time at which order is first valid for execution |
| OrderId | Yes | string | A unique id associated to every order. This is the identifier to lookup the specific order to modify |
| OrderTag | No | string | Order tag |
| Price | No | google.protobuf.DoubleValue | Limit price submitted in order |
| PriceType | No | PriceTypeEnum | By default the price type is set to Market, in case no value is provided. Refer to the section PriceTypeEnum |
| Quantity | No | int32 | Value > 0 |
| StopPrice | No | google.protobuf.DoubleValue | Stop price |
| TimeInForce | No | ExpirationType | Time or date at which order is no longer valid. In case no value is provided, DAY expiration type is set by default. Refer to the section ExpirationType |
| UserMessage | No | string |
User message/notes |
| UserToken | Yes | string | A server generated GUID that is given as response to the client during the first login |