# Grid Order Detail

`GET` `/v1/gridtrading/detail`

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`).

## Parameters

### Query Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `order_id` | string | Yes | Grid order ID, example: `764609681686573056` |
| `history_id` | string | No | Cursor for paging the lifecycle history. Pass the last `history_id` of a page to fetch older entries. |
| `limit` | integer | No | Page size for `grid_sub_orders` and `grid_order_history` |

## Request Example

```bash
curl --request GET \
  --url 'https://openapi.longbridge.com/v1/gridtrading/detail?order_id=<order_id>' \
  --header 'Authorization: Bearer <access_token>'
```

## Response

### Response Properties

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `order_id` | string | Yes | Grid order ID |
| `symbol` | string | Yes | Security symbol, `ticker.region` format |
| `stock_name` | string | Yes | Security name |
| `status` | string | Yes | Grid order status, example: `Performing` / `Suspended` |
| `grid_status` | string | Yes | Detailed grid running status |
| `suspend_reason` | string | Yes | Reason the grid is suspended, empty when running |
| `sleeping_reason` | string | Yes | Reason the grid is dormant, empty when active |
| `submitted_base_price` | string | Yes | Base price the grid was anchored to at submission |
| `current_base_price` | string | Yes | Current base price after triggers |
| `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 | Yes | Upward trigger spread (when `trigger_price_type` is `1`) |
| `trigger_spread_down` | string | Yes | Downward trigger spread (when `trigger_price_type` is `1`) |
| `trigger_percent_up` | string | Yes | Upward trigger percent (when `trigger_price_type` is `2`) |
| `trigger_percent_down` | string | Yes | Downward trigger percent (when `trigger_price_type` is `2`) |
| `pullback_percent` | string | Yes | Pullback percent |
| `pullback_spread` | string | Yes | Pullback spread |
| `rebound_percent` | string | Yes | Rebound percent |
| `rebound_spread` | string | Yes | Rebound spread |
| `multiple_trigger` | boolean | Yes | Whether a single grid level may trigger multiple times |
| `time_in_force` | int32 | Yes | Time in force. **Enum Value:**, `0` - Day, `1` - GTC, `6` - GTD |
| `trigger_quantity` | string | Yes | Quantity per trigger |
| `trigger_sell_quantity` | string | Yes | Cumulative quantity triggered on the sell side |
| `trigger_buy_quantity` | string | Yes | Cumulative quantity triggered on the buy side |
| `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 |
| `upper_limit_event` | int32 | Yes | Action at the upper bound. **Enum Value:**, `1` - ignore, `2` - close position at last price |
| `lower_limit_event` | int32 | Yes | Action at the lower bound. **Enum Value:**, `1` - ignore, `2` - close position at last price |
| `trigger_sell_depth` | int32 | Yes | Sell-side order-book depth (-5 ~ 5). `0` = use `grid_order_type_up` |
| `trigger_buy_depth` | int32 | Yes | Buy-side order-book depth (-5 ~ 5). `0` = use `grid_order_type_down` |
| `created_at` | string | Yes | Creation time, RFC3339 format |
| `updated_at` | string | Yes | Last update time, RFC3339 format |
| `settlement_currency` | string | Yes | Settlement currency, example: `HKD` |
| `expire_time` | string | Yes | Expiry time, RFC3339 format (when `time_in_force` is GTD) |
| `gtd` | string | Yes | Good-Til-Date, `YYYY-MM-DD` format |
| `grid_sub_orders` | object[] | No | Executed sub-orders for this grid |
| `└ id` | string | Yes | Sub-order ID |
| `└ price` | string | Yes | Order price |
| `└ order_type` | string | Yes | Order type |
| `└ quantity` | string | Yes | Order quantity |
| `└ executed_qty` | string | Yes | Executed quantity |
| `└ action` | int32 | Yes | Buy/sell direction |
| `└ status` | string | Yes | Sub-order status |
| `└ submitted_at` | string | Yes | Submission time, RFC3339 format |
| `└ rth` | int32 | Yes | Regular-trading-hours flag (`0` / `1` / `2`) |
| `sub_has_more` | boolean | Yes | Whether more sub-orders can be paged |
| `grid_order_history` | object[] | No | Lifecycle history entries |
| `└ history_id` | string | Yes | History entry ID, also used as the paging cursor |
| `└ created_at` | string | Yes | Event time, RFC3339 format |
| `└ suspend_reason` | string | Yes | Suspend reason, when applicable |
| `└ reason` | string | Yes | Human-readable description of the event |
| `history_has_more` | boolean | Yes | Whether more history entries can be paged via `history_id` |
| `support_shortsell` | boolean | Yes | Whether short selling is allowed |
| `rth` | int32 | Yes | Regular-trading-hours flag (`0` / `1` / `2`) |
| `grid_order_type_up` | string | Yes | Sell-side order type when `trigger_sell_depth` is `0`. **Enum Value:**, `GMO` / `GLO` / `GTG` |
| `grid_order_type_down` | string | Yes | Buy-side order type when `trigger_buy_depth` is `0`. **Enum Value:**, `GMO` / `GLO` / `GTG` |

### Response JSON Example

```json
{
  "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"
  }
}
```
