Trade

Grid Orders

GEThttps://openapi.longbridge.com/v1/gridtrading/list

Authorization

Signed mode: every request is signed with your App Key/Secret. Header set:

NameTypeRequiredDescription
Authorizationstring · headerRequiredThe account Access Token from the OpenAPI dashboard — passed as the raw token (no Bearer prefix) and included in the signature calculation.
X-Api-Keystring · headerRequiredYour App Key.
X-Timestampstring · headerRequiredRequest timestamp in seconds (Unix epoch).
X-Api-Signaturestring · headerRequiredHMAC-SHA256 signature. Format: HMAC-SHA256 SignedHeaders=authorization;x-api-key;x-timestamp, Signature=.

Get a paged list of your grid orders, optionally filtered by market, symbol, or status.

>_ CLI
# List all grid orders (default)
longbridge grid
# Filter by symbol and status
longbridge grid --symbol 700.HK --status Performing

Request

Query parameters

NameTypeRequiredDescription
pageintegerOptionalPage number, starts at `1`
limitintegerOptionalPage size
marketstringOptionalMarket filter **Enum Value:** `US` / `HK` / `CN` / `SG`
symbolstringOptionalSecurity symbol, `ticker.region` format, example: `700.HK`
statusstringOptionalGrid order status filter, comma-joined, example: `Performing,Suspended`
sort_bystringOptionalField to sort by
sort_orderstringOptionalSort direction

Response

Response properties

NameTypeRequiredDescription
grid_orderobject[]OptionalGrid orders
└ order_idstringRequiredGrid order ID
└ symbolstringRequiredStock symbol, use `ticker.region` format, example: `AAPL.US`
└ stock_namestringRequiredStock name
└ marketstringRequiredMarket
└ statusstringRequiredGrid order status
└ grid_statusstringRequiredGrid running status
└ submitted_base_pricestringRequiredSubmitted base price the grid is anchored to
└ current_base_pricestringRequiredCurrent base price
└ pre_trigger_base_pricestringRequiredBase price before the last trigger
└ post_trigger_base_pricestringRequiredBase price after the last trigger
└ upper_limit_pricestringRequiredUpper price bound
└ lower_limit_pricestringRequiredLower price bound
└ trigger_price_typeint32RequiredTrigger price type. **Enum Value:**, `1` - Spread, `2` - Percent
└ trigger_spread_upstringRequiredUpward trigger spread, used when `trigger_price_type` is `1`
└ trigger_spread_downstringRequiredDownward trigger spread, used when `trigger_price_type` is `1`
└ trigger_percent_upstringRequiredUpward trigger percent, used when `trigger_price_type` is `2`
└ trigger_percent_downstringRequiredDownward trigger percent, used when `trigger_price_type` is `2`
└ pullback_percentstringRequiredPullback percent
└ pullback_spreadstringRequiredPullback spread
└ rebound_percentstringRequiredRebound percent
└ rebound_spreadstringRequiredRebound spread
└ trigger_sell_order_typestringRequiredSell-side grid order type. **Enum Value:**, `GMO` - Grid market order, `GLO` - Grid limit order, `GTG` - Grid touch-to-go
└ trigger_buy_order_typestringRequiredBuy-side grid order type. **Enum Value:**, `GMO` - Grid market order, `GLO` - Grid limit order, `GTG` - Grid touch-to-go
└ trigger_sell_depthint32RequiredSell-side order-book depth, range `-5..5`; `0` means use `trigger_sell_order_type`
└ trigger_buy_depthint32RequiredBuy-side order-book depth, range `-5..5`; `0` means use `trigger_buy_order_type`
└ trigger_quantitystringRequiredQuantity per trigger
└ trigger_sell_quantitystringRequiredSell-side trigger quantity
└ trigger_buy_quantitystringRequiredBuy-side trigger quantity
└ upper_limit_quantitystringRequiredQuantity handled at the upper bound
└ lower_limit_quantitystringRequiredQuantity handled at the lower bound
└ upper_limit_eventint32RequiredEvent when the upper bound is reached. **Enum Value:**, `1` - Ignore (keep grid running), `2` - Close position at last price
└ lower_limit_eventint32RequiredEvent when the lower bound is reached. **Enum Value:**, `1` - Ignore (keep grid running), `2` - Close position at last price
└ multiple_triggerbooleanRequiredWhether a single grid level can trigger multiple times
└ trigger_timesint32RequiredNumber of times the grid has triggered
└ total_buy_quantitystringRequiredTotal bought quantity
└ total_sell_quantitystringRequiredTotal sold quantity
└ total_profit_balancestringRequiredTotal profit balance
└ settlement_currencystringRequiredSettlement currency
└ time_in_forceint32RequiredTime in force type. **Enum Value:**, `0` - Day, `1` - Good-Til-Canceled, `6` - Good-Til-Date
└ gtdstringRequiredGood-Til-Date expiry date, format: `YYYY-MM-DD`
└ created_atstringRequiredCreation time, formatted as RFC3339
└ rthint32RequiredRegular trading hours flag. **Enum Value:**, `0`, `1`, `2`
└ support_shortsellbooleanRequiredWhether short selling is allowed
└ grid_order_type_upstringRequiredSell-side order type when depth is `0`. **Enum Value:**, `GMO` - Grid market order, `GLO` - Grid limit order, `GTG` - Grid touch-to-go
└ grid_order_type_downstringRequiredBuy-side order type when depth is `0`. **Enum Value:**, `GMO` - Grid market order, `GLO` - Grid limit order, `GTG` - Grid touch-to-go
has_morebooleanRequiredWhether there are more pages

Response JSON example

{
  "code": 0,
  "message": "success",
  "data": {
    "grid_order": [
      {
        "order_id": "764609681686573056",
        "symbol": "700.HK",
        "stock_name": "TENCENT",
        "market": "HK",
        "status": "Performing",
        "grid_status": "Performing",
        "submitted_base_price": "300.000",
        "current_base_price": "300.000",
        "pre_trigger_base_price": "300.000",
        "post_trigger_base_price": "306.000",
        "upper_limit_price": "360.000",
        "lower_limit_price": "240.000",
        "trigger_price_type": 2,
        "trigger_spread_up": "",
        "trigger_spread_down": "",
        "trigger_percent_up": "2",
        "trigger_percent_down": "2",
        "pullback_percent": "",
        "pullback_spread": "",
        "rebound_percent": "",
        "rebound_spread": "",
        "trigger_sell_order_type": "GMO",
        "trigger_buy_order_type": "GMO",
        "trigger_sell_depth": 0,
        "trigger_buy_depth": 0,
        "trigger_quantity": "100",
        "trigger_sell_quantity": "100",
        "trigger_buy_quantity": "100",
        "upper_limit_quantity": "200",
        "lower_limit_quantity": "100",
        "upper_limit_event": 1,
        "lower_limit_event": 1,
        "multiple_trigger": false,
        "trigger_times": 3,
        "total_buy_quantity": "300",
        "total_sell_quantity": "200",
        "total_profit_balance": "1250.00",
        "settlement_currency": "HKD",
        "time_in_force": 1,
        "gtd": "",
        "created_at": "2025-01-15T09:30:00+08:00",
        "rth": 0,
        "support_shortsell": false,
        "grid_order_type_up": "GMO",
        "grid_order_type_down": "GMO"
      }
    ],
    "has_more": false
  }
}

Error code

See the Error Codes page for the full list of error codes.