Files
LuGHuaaa c18ee0b5b0 Fix typo (#62)
* fix typo

* fix response message

Co-authored-by: guohua.lu <guohua.lu@longbridge.sg>
2022-04-29 16:35:46 +08:00

94 lines
3.3 KiB
YAML

swagger: "2.0"
info:
description: "该接口用于港美股,窝轮,期权的委托下单"
version: "v1"
title: "委托下单"
paths:
/v1/trade/order:
post:
access: "交易权限"
parameters:
- name: "symbol"
type: "string"
description: "股票代码,使用 `ticker.region` 格式,例如:`AAPL.US`"
required: true
- name: "order_type"
type: "string"
description: "[订单类型](../trade-definition#ordertype)"
required: true
- name: "submitted_price"
required: false
description: 下单价格,例如:`388.5`<br/><br/>
`LO` / `ELO` / `ALO` / `ODD` / `LIT` 订单必填
- name: "submitted_quantity"
required: true
description: 下单数量,例如:`100`
- name: trigger_price
required: false
description: 触发价格,例如:`388.5`<br/><br/>
`LIT` / `MIT` 订单必填
- name: limit_offset
required: false
description: 指定价差<br/><br/>
`TSLPAMT` / `TSLPPCT` 订单必填
- name: trailing_amount
required: false
description: 跟踪金额<br/><br/>
`TSLPAMT` / `TSMAMT` 订单必填
- name: trailing_percent
required: false
description: 跟踪涨跌幅<br/><br/>
`TSLPPCT` / `TSMAPCT` 订单必填
- name: expire_date
required: false
description:
长期单过期时间,格式为 `YYYY-MM-DD`, 例如:`2022-12-05`<br/><br/>
time_in_force 为 `GTD` 时必填
- name: side
type: "string"
description: 买卖方向<br/><br/>
**可选值:**<br/>
`Buy` - 买入<br/>
`Sell` - 卖出
required: true
- name: outside_rth
required: false
description: 是否允许盘前盘后,美股必填<br/><br/>
**可选值:**<br/>
`RTH_ONLY` - 不允许盘前盘后<br/>
`ANY_TIME` - 允许盘前盘后
- name: time_in_force
required: true
description: 订单有效期类型<br/><br/>
**可选值:**<br/>
`Day` - 当日有效<br/>
`GTC` - 撤单前有效<br/>
`GTD` - 到期前有效
- name: remark
required: false
description: "备注 (最大 64 字符)"
responses:
"200":
description: "提交成功,订单已委托。"
"400":
description: "下单被拒绝,请求参数错误。"
request_body:
type: "python"
value: |
def example():
from longbridge.http import Auth, Config, HttpClient
auth = Auth("${API_KEY}", "${API_KEY_SECRET}", "${TOKEN}")
config = Config(base_url = "https://openapi.lbkrs.com")
client = HttpClient(auth, config)
result = client.post("/v1/openapi/trade/order", {
"order_type": "LO","side": "Buy","submitted_price": "388",
"submitted_quantity": "100","symbol": "700.HK",
"time_in_force": "Day",
})
response_body:
{
"code": 0,
"message": "success",
"data": { "order_id": 683615454870679552 },
}