Trade

Grid Order Detail

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

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=.

Query the full detail of a single grid order, including its rule, paged executed sub-orders (grid_sub_orders), and paged lifecycle history (grid_order_history).

>_ CLI
# Rule, sub-orders and history of a grid order
longbridge grid detail 764609681686573056

Request

Query parameters

NameTypeRequiredDescription
order_idstringRequiredGrid order ID, example: `764609681686573056`
history_idstringOptionalCursor for paging the lifecycle history. Pass the last `history_id` of a page to fetch older entries.
limitintegerOptionalPage size for `grid_sub_orders` and `grid_order_history`

Response

Response properties

NameTypeRequiredDescription
order_idstringRequiredGrid order ID
symbolstringRequiredSecurity symbol, `ticker.region` format
stock_namestringRequiredSecurity name
statusstringRequiredGrid order status, example: `Performing` / `Suspended`
grid_statusstringRequiredDetailed grid running status
suspend_reasonstringRequiredReason the grid is suspended, empty when running
sleeping_reasonstringRequiredReason the grid is dormant, empty when active
submitted_base_pricestringRequiredBase price the grid was anchored to at submission
current_base_pricestringRequiredCurrent base price after triggers
upper_limit_pricestringRequiredUpper price bound
lower_limit_pricestringRequiredLower price bound
trigger_price_typeint32RequiredHow trigger thresholds are interpreted. **Enum Value:**, `1` - spread (absolute), `2` - percent
trigger_spread_upstringRequiredUpward trigger spread (when `trigger_price_type` is `1`)
trigger_spread_downstringRequiredDownward trigger spread (when `trigger_price_type` is `1`)
trigger_percent_upstringRequiredUpward trigger percent (when `trigger_price_type` is `2`)
trigger_percent_downstringRequiredDownward trigger percent (when `trigger_price_type` is `2`)
pullback_percentstringRequiredPullback percent
pullback_spreadstringRequiredPullback spread
rebound_percentstringRequiredRebound percent
rebound_spreadstringRequiredRebound spread
multiple_triggerbooleanRequiredWhether a single grid level may trigger multiple times
time_in_forceint32RequiredTime in force. **Enum Value:**, `0` - Day, `1` - GTC, `6` - GTD
trigger_quantitystringRequiredQuantity per trigger
trigger_sell_quantitystringRequiredCumulative quantity triggered on the sell side
trigger_buy_quantitystringRequiredCumulative quantity triggered on the buy side
upper_limit_quantitystringRequiredQuantity handled when the upper bound is reached
lower_limit_quantitystringRequiredQuantity handled when the lower bound is reached
upper_limit_eventint32RequiredAction at the upper bound. **Enum Value:**, `1` - ignore, `2` - close position at last price
lower_limit_eventint32RequiredAction at the lower bound. **Enum Value:**, `1` - ignore, `2` - close position at last price
trigger_sell_depthint32RequiredSell-side order-book depth (-5 ~ 5). `0` = use `grid_order_type_up`
trigger_buy_depthint32RequiredBuy-side order-book depth (-5 ~ 5). `0` = use `grid_order_type_down`
created_atstringRequiredCreation time, RFC3339 format
updated_atstringRequiredLast update time, RFC3339 format
settlement_currencystringRequiredSettlement currency, example: `HKD`
expire_timestringRequiredExpiry time, RFC3339 format (when `time_in_force` is GTD)
gtdstringRequiredGood-Til-Date, `YYYY-MM-DD` format
grid_sub_ordersobject[]OptionalExecuted sub-orders for this grid
└ idstringRequiredSub-order ID
└ pricestringRequiredOrder price
└ order_typestringRequiredOrder type
└ quantitystringRequiredOrder quantity
└ executed_qtystringRequiredExecuted quantity
└ actionint32RequiredBuy/sell direction
└ statusstringRequiredSub-order status
└ submitted_atstringRequiredSubmission time, RFC3339 format
└ rthint32RequiredRegular-trading-hours flag (`0` / `1` / `2`)
sub_has_morebooleanRequiredWhether more sub-orders can be paged
grid_order_historyobject[]OptionalLifecycle history entries
└ history_idstringRequiredHistory entry ID, also used as the paging cursor
└ created_atstringRequiredEvent time, RFC3339 format
└ suspend_reasonstringRequiredSuspend reason, when applicable
└ reasonstringRequiredHuman-readable description of the event
history_has_morebooleanRequiredWhether more history entries can be paged via `history_id`
support_shortsellbooleanRequiredWhether short selling is allowed
rthint32RequiredRegular-trading-hours flag (`0` / `1` / `2`)
grid_order_type_upstringRequiredSell-side order type when `trigger_sell_depth` is `0`. **Enum Value:**, `GMO` / `GLO` / `GTG`
grid_order_type_downstringRequiredBuy-side order type when `trigger_buy_depth` is `0`. **Enum Value:**, `GMO` / `GLO` / `GTG`

Response JSON example

{
  "code": 0,
  "message": "success",
  "data": {
    "order_id": "764609681686573056",
    "symbol": "700.HK",
    "stock_name": "TENCENT",
    "status": "Performing",
    "grid_status": "Performing",
    "suspend_reason": "",
    "sleeping_reason": "",
    "submitted_base_price": "300",
    "current_base_price": "300",
    "upper_limit_price": "360",
    "lower_limit_price": "240",
    "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": "",
    "multiple_trigger": false,
    "time_in_force": 1,
    "trigger_quantity": "100",
    "trigger_sell_quantity": "0",
    "trigger_buy_quantity": "0",
    "upper_limit_quantity": "200",
    "lower_limit_quantity": "100",
    "upper_limit_event": 1,
    "lower_limit_event": 1,
    "trigger_sell_depth": 0,
    "trigger_buy_depth": 0,
    "created_at": "2024-08-12T10:30:00+08:00",
    "updated_at": "2024-08-12T10:30:00+08:00",
    "settlement_currency": "HKD",
    "expire_time": "",
    "gtd": "",
    "grid_sub_orders": [],
    "sub_has_more": false,
    "grid_order_history": [
      {
        "history_id": "764609681686573100",
        "created_at": "2024-08-12T10:30:00+08:00",
        "status": "Performing",
        "suspend_reason": "",
        "reason": "Grid order started"
      }
    ],
    "history_has_more": false,
    "support_shortsell": false,
    "rth": 0,
    "grid_order_type_up": "GMO",
    "grid_order_type_down": "GMO"
  }
}

Error code

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