---
slug: replace
sidebar_position: 2
title: Modify Grid Order
sidebar_label: 'Modify Order'
language_tabs: false
toc_footers: []
includes: []
search: true
highlight_theme: ''
headingLevel: 2
---
Modify an existing grid order's rule. The whole `grid_trading_rule` is replaced with the one you submit, so pass the complete rule — not just the fields you changed.
# Modify a grid order's base/bound prices and quantities
longbridge grid replace 764609681686573056 --base-price 305 --upper-price 360 --lower-price 240 --trigger-type percent --trigger-up 2 --trigger-down 2 --quantity 100 --upper-quantity 200 --lower-quantity 100 --order-type GMO --tif gtc
# Validate the new rule without applying it
longbridge grid replace 764609681686573056 --base-price 305 --upper-price 360 --lower-price 240 --trigger-type percent --trigger-up 2 --trigger-down 2 --quantity 100 --upper-quantity 200 --lower-quantity 100 --order-type GMO --tif gtc --dry-run
## Request
| HTTP Method | POST |
| HTTP URL | /v1/gridtrading/replace |
### Parameters
> Content-Type: application/json; charset=utf-8
| Name | Type | Required | Description |
| ----------------- | ------ | -------- | ------------------------------------------------- |
| order_id | string | YES | Grid order ID, example: `764609681686573056` |
| grid_trading_rule | object | YES | The full grid rule to apply. Fields below. |
#### grid_trading_rule
| Name | Type | Required | Description |
| --------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| submitted_base_price | string | YES | Base price the grid is anchored to |
| upper_limit_price | string | YES | Upper price bound |
| lower_limit_price | string | YES | Lower price bound |
| trigger_price_type | int32 | YES | How trigger thresholds are interpreted
**Enum Value:**
`1` - spread (absolute)
`2` - percent |
| trigger_spread_up | string | NO | Upward trigger spread, required when `trigger_price_type` is `1` |
| trigger_spread_down | string | NO | Downward trigger spread, required when `trigger_price_type` is `1` |
| trigger_percent_up | string | NO | Upward trigger percent, required when `trigger_price_type` is `2` |
| trigger_percent_down | string | NO | Downward trigger percent, required when `trigger_price_type` is `2` |
| trigger_quantity | string | YES | Quantity per trigger |
| upper_limit_quantity | string | YES | Quantity handled when the upper bound is reached |
| lower_limit_quantity | string | YES | Quantity handled when the lower bound is reached |
| time_in_force | int32 | YES | Time in force
**Enum Value:**
`0` - Day
`1` - GTC (Good-Til-Canceled)
`6` - GTD (Good-Til-Date) |
| expire_time | int64 | NO | Expiry time (Unix timestamp, in seconds), required when `time_in_force` is `6` (GTD) |
| upper_limit_event | int32 | NO | Action when the upper bound is reached
**Enum Value:**
`1` - ignore (keep running)
`2` - close position at last price |
| lower_limit_event | int32 | NO | Action when the lower bound is reached
**Enum Value:**
`1` - ignore (keep running)
`2` - close position at last price |
| trigger_sell_depth | int32 | NO | Sell-side order-book depth (-5 ~ 5). `0` = use `grid_order_type_up` instead of a depth level |
| trigger_buy_depth | int32 | NO | Buy-side order-book depth (-5 ~ 5). `0` = use `grid_order_type_down` instead of a depth level |
| grid_order_type_up | string | NO | Sell-side order type when `trigger_sell_depth` is `0`
**Enum Value:**
`GMO` / `GLO` / `GTG` |
| grid_order_type_down | string | NO | Buy-side order type when `trigger_buy_depth` is `0`
**Enum Value:**
`GMO` / `GLO` / `GTG` |
| multiple_trigger | boolean | NO | Whether a single grid level may trigger multiple times |
| support_shortsell | boolean | NO | Whether short selling is allowed |
| rth | int32 | NO | Regular-trading-hours flag (`0` / `1` / `2`) |
### Request Example
```python
from decimal import Decimal
from longbridge.openapi import (
GridContext, Config, OAuthBuilder,
GridTradeRule, TriggerPriceType, GridTimeInForce, GridLimitEvent,
)
oauth = OAuthBuilder("your-client-id").build(lambda url: print("Visit:", url))
config = Config.from_oauth(oauth)
# Grid REST calls go through the standalone GridContext
ctx = GridContext(config)
rule = GridTradeRule(
Decimal(305), Decimal(360), Decimal(240), # base, upper, lower price
TriggerPriceType.Percent, Decimal(2), Decimal(2), # trigger type, up, down
Decimal(100), Decimal(200), Decimal(100), # quantity, upper qty, lower qty
GridTimeInForce.GoodTilCanceled,
upper_limit_event=GridLimitEvent.Ignore,
lower_limit_event=GridLimitEvent.Ignore,
grid_order_type_up="GMO",
grid_order_type_down="GMO",
)
resp = ctx.replace("764609681686573056", rule)
print(resp)
```
```javascript
const { Config, GridContext, OAuth, Decimal, TriggerPriceType, GridTimeInForce, GridLimitEvent } = require('longbridge')
async function main() {
const oauth = await OAuth.build('your-client-id', (_, url) => {
console.log('Open this URL to authorize: ' + url)
})
const config = Config.fromOAuth(oauth)
const ctx = GridContext.new(config)
const resp = await ctx.replace({
orderId: '764609681686573056',
gridTradingRule: {
submittedBasePrice: new Decimal(305),
upperLimitPrice: new Decimal(360),
lowerLimitPrice: new Decimal(240),
triggerPriceType: TriggerPriceType.Percent,
triggerPercentUp: new Decimal(2),
triggerPercentDown: new Decimal(2),
triggerQuantity: new Decimal(100),
upperLimitQuantity: new Decimal(200),
lowerLimitQuantity: new Decimal(100),
timeInForce: GridTimeInForce.GoodTilCanceled,
upperLimitEvent: GridLimitEvent.Ignore,
lowerLimitEvent: GridLimitEvent.Ignore,
gridOrderTypeUp: 'GMO',
gridOrderTypeDown: 'GMO',
},
})
console.log(resp)
}
main().catch(console.error)
```
```java
import com.longbridge.*;
import com.longbridge.grid.*;
import java.math.BigDecimal;
class Main {
public static void main(String[] args) throws Exception {
try (OAuth oauth = new OAuthBuilder("your-client-id").build(url -> System.out.println("Open to authorize: " + url)).get();
Config config = Config.fromOAuth(oauth);
GridContext ctx = GridContext.create(config)) {
GridTradeRule rule = new GridTradeRule(
new BigDecimal("305"), new BigDecimal("360"), new BigDecimal("240"),
GridTrigger.percent(new BigDecimal("2"), new BigDecimal("2")),
new BigDecimal("100"), new BigDecimal("200"), new BigDecimal("100"),
GridTimeInForce.GoodTilCanceled)
.orderTypes("GMO", "GMO")
.limitEvents(GridLimitEvent.Ignore, GridLimitEvent.Ignore);
ctx.replace(new ReplaceGridOrderOptions("764609681686573056", rule)).get();
}
}
}
```
```rust
use std::sync::Arc;
use longbridge::{
Config,
grid::{GridContext, GridTradeRule, ReplaceGridOrderOptions},
oauth::OAuthBuilder,
};
use rust_decimal::Decimal;
#[tokio::main]
async fn main() -> Result<(), Box> {
let oauth = OAuthBuilder::new("your-client-id").build(|url| println!("Open this URL to authorize: {url}")).await?;
let config = Arc::new(Config::from_oauth(oauth));
let ctx = GridContext::new(config);
let rule = GridTradeRule {
submitted_base_price: Some(Decimal::new(305, 0)),
upper_limit_price: Some(Decimal::new(360, 0)),
lower_limit_price: Some(Decimal::new(240, 0)),
trigger_price_type: Some(2.into()), // 1 = spread, 2 = percent
trigger_percent_up: Some(Decimal::new(2, 0)),
trigger_percent_down: Some(Decimal::new(2, 0)),
trigger_quantity: Some(Decimal::new(100, 0)),
upper_limit_quantity: Some(Decimal::new(200, 0)),
lower_limit_quantity: Some(Decimal::new(100, 0)),
time_in_force: Some(1.into()), // GTC
grid_order_type_up: Some("GMO".to_string()),
grid_order_type_down: Some("GMO".to_string()),
upper_limit_event: Some(1.into()),
lower_limit_event: Some(1.into()),
..Default::default()
};
ctx.replace(ReplaceGridOrderOptions::new("764609681686573056", rule)).await?;
Ok(())
}
```
```cpp
#include
#include
using namespace longbridge;
using namespace longbridge::grid;
static void
run(const OAuth& oauth)
{
Config config = Config::from_oauth(oauth);
GridContext ctx = GridContext::create(config);
GridTradeRule rule;
rule.submitted_base_price = Decimal("305");
rule.upper_limit_price = Decimal("360");
rule.lower_limit_price = Decimal("240");
rule.trigger_price_type = TriggerPriceType::Percent;
rule.trigger_percent_up = Decimal("2");
rule.trigger_percent_down = Decimal("2");
rule.trigger_quantity = Decimal("100");
rule.upper_limit_quantity = Decimal("200");
rule.lower_limit_quantity = Decimal("100");
rule.time_in_force = GridTimeInForce::GoodTilCanceled;
rule.grid_order_type_up = "GMO";
rule.grid_order_type_down = "GMO";
ReplaceGridOrderOptions opts{ "764609681686573056", rule };
ctx.replace(opts, [](auto res) {
if (!res) {
std::cout << "failed" << std::endl;
return;
}
std::cout << "replaced" << std::endl;
});
}
int main(int argc, char const* argv[]) {
const std::string client_id = "your-client-id";
OAuthBuilder(client_id).build(
[](const std::string& url) {
std::cout << "Open this URL to authorize: " << url << std::endl;
},
[](auto res) {
if (!res) {
std::cout << "authorization failed" << std::endl;
return;
}
run(*res);
});
std::cin.get();
return 0;
}
```
## Response
### Response Headers
- Content-Type: application/json
### Response Example
```json
{
"code": 0,
"message": "success",
"data": {}
}
```
### Response Status
| Status | Description | Schema |
| ------ | ------------------------------------------------------------ | ------ |
| 200 | The grid order was modified successfully. | None |
| 400 | The modification was rejected with an incorrect request parameter. | None |