Suspend Grid Order

Suspend a running grid order. The grid stops triggering new orders but is kept intact, so it can be resumed later with Restart Grid Order. Use suspend when you want to pause the strategy without losing its configuration.

CLI

# Suspend a running grid order by ID
longbridge grid suspend 764609681686573056

SDK Links

Python	longbridge.openapi.GridContext.suspend
Rust	longbridge::grid::GridContext#suspend
Node.js	GridContext#suspend
Java	GridContext.getSuspend
C++	longbridge::grid::GridContext::suspend

Request

HTTP Method	POST
HTTP URL	/v1/gridtrading/suspend

Parameters

Content-Type: application/json; charset=utf-8

Name	Type	Required	Description
order_id	string	YES	Grid order ID, example: 764609681686573056

Request Example

from longbridge.openapi import GridContext, Config, OAuthBuilder

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)

resp = ctx.suspend("764609681686573056")
print(resp)

const { Config, GridContext, OAuth } = 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.suspend('764609681686573056')
  console.log(resp)
}
main().catch(console.error)

import com.longbridge.*;
import com.longbridge.grid.*;

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)) {
            ctx.suspend("764609681686573056").get();
        }
    }
}

use std::sync::Arc;
use longbridge::{Config, grid::GridContext, oauth::OAuthBuilder};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    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);

    ctx.suspend("764609681686573056").await?;
    Ok(())
}

#include <iostream>
#include <longbridge.hpp>

using namespace longbridge;
using namespace longbridge::grid;

static void
run(const OAuth& oauth)
{
    Config config = Config::from_oauth(oauth);
    GridContext ctx = GridContext::create(config);

    ctx.suspend("764609681686573056", [](auto res) {
        if (!res) {
            std::cout << "failed" << std::endl;
            return;
        }
        std::cout << "suspended" << 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

{
  "code": 0,
  "message": "success",
  "data": {}
}

Response Status

Status	Description	Schema
200	The grid order was suspended successfully.	None
400	The request was rejected with an incorrect request parameter.	None