diff --git a/docs/trade/definition.md b/docs/trade/definition.md index fcb46821..65eb4808 100644 --- a/docs/trade/definition.md +++ b/docs/trade/definition.md @@ -58,3 +58,59 @@ slug: trade-definition | HK | 港股 | | US | 美股 | +## WebSocket 推送通知 + +* WebSocket 推送通知字段说明 + +| 字段名 | 类型 | 注释 | +| ----------------- | ------ | ------------------------------------------------------------ | +| side | string | 买卖方向
Buy: 买入
Sell: 卖出 | +| stock_name | string | 公司名称 | +| quantity | string | 委托数量 | +| symbol | string | 订单标的 | +| order_type | string | 订单类型 | +| price | string | 委托价格 | +| executed_quantity | string | 成交数量 | +| executed_price | string | 成交价格 | +| order_id | string | 订单 id | +| currency | string | 结算货币 | +| status | string | 订单状态 | +| submitted_at | string | 下单时间，格式为时间戳 (秒) | +| updated_at | string | 最近更新时间 | +| trigger_price | string | 触发价格 | +| msg | string | 拒绝理由，备注信息 | +| tag | string | 订单标记
Normal 普通订单
GTC 长期单
Grey 暗盘单 | +| trigger_status | string | 条件单触发状态
NOT_ACTIVE 未激活
DEACTIVE 已失效
ACTIVE 已激活
RELEASED 已触发 | +| trigger_at | string | 触发时间 | +| tailing_amount | string | 条件单跟踪金额 | +| tailing_percent | string | 条件单跟踪涨跌幅 | +| limit_offset | string | 指定价差 | +| account_no | string | 用户端账号 | + +### 示例 + +```JSON +{ + "side": "Buy", + "stock_name": "腾讯控股", + "quantity": "1000", + "symbol": "700.HK", + "order_type": "LO", + "price": "213.2", + "executed_quantity": "1000", + "executed_price": "213.2", + "order_id": "27", + "currency": "HKD", + "status": "NewStatus", + "submitted_at": "1562761893", + "updated_at": "1562761893", + "trigger_price": "213.0", + "msg": "Insufficient Qty - 1000", + "tag": "Normal", + "trigger_status": "NOT_ACTIVE", + "trigger_at": "1562761893", + "tailing_amount": "5", + "tailing_percent": "0.01", + "limit_offset": "0.01" +} +``` diff --git a/docs/trade/orders/history-orders.md b/docs/trade/orders/history-orders.md index c45f1fa1..51efbfec 100644 --- a/docs/trade/orders/history-orders.md +++ b/docs/trade/orders/history-orders.md @@ -27,60 +27,60 @@ title: 历史订单 ### 请求参数 -| 名称 | 类型 | 必须 | 描述 | 默认值 | 示例 | -|----------|----------|-----|-----------------------------------------|-----|-----------------------------------------| -| symbol | string | | 股票代码，使用 ticker.region 格式 | | 700.HK | -| status | []string | | [订单状态](../trade-definition#orderstatus) | | ["FilledStatus", "PartialFilledStatus"] | -| side | string | | 买卖方向
Buy: 买入
Sell: 卖出 | | Buy | -| market | string | | [市场](../trade-definition#market) | | US | -| start_at | int64 | | 开始时间，格式为时间戳 (秒) | | 1650410999 | -| end_at | int64 | | 结束时间，格式为时间戳 (秒) | | 1650510999 | +| 名称 | 类型 | 必须 | 描述 | 默认值 | 示例 | +| -------- | -------- | ---- | ------------------------------------------- | ------ | --------------------------------------- | +| symbol | string | | 股票代码，使用 ticker.region 格式 | | 700.HK | +| status | []string | | [订单状态](../trade-definition#orderstatus) | | ["FilledStatus", "PartialFilledStatus"] | +| side | string | | 买卖方向
Buy: 买入
Sell: 卖出 | | Buy | +| market | string | | [市场](../trade-definition#market) | | US | +| start_at | string | | 开始时间，格式为时间戳 (秒) | | 1650410999 | +| end_at | string | | 结束时间，格式为时间戳 (秒) | | 1650510999 | start_at 和 end_at 的组合如下 -| Start 类型 | End 类型 | 说明 | -|:---------|:-------|:------------------------| -| int64 | int64 | start 和 end 分别为指定的时间 | -| None | int64 | start 为 end 往前 90 天 | -| int64 | None | end 为 start 往后 90 天 | -| None | None | start 为往前 90 天，end 当前日期 | +| Start 类型 | End 类型 | 说明 | +| :--------- | :------- | :------------------------------- | +| string | string | start 和 end 分别为指定的时间 | +| None | string | start 为 end 往前 90 天 | +| string | None | end 为 start 往后 90 天 | +| None | None | start 为往前 90 天，end 当前日期 | ## 响应 ### 响应体 -| 名称 | 类型 | 描述 | -|------------------------------------------------------------------------|----------|-----------------------------------------------------------------------------------| -| code | int | 错误码，非 0 表示失败 | -| msg | string | 错误描述 | -| data | object | | -| ∟has_more | bool | 是否还有数据，如果为 true，则需要通过最后的时间再次请求。 | -| ∟orders | []object | 订单详情列表 | -| ∟∟order_id | int64 | 订单 id | -| ∟∟status | string | 订单状态 | -| ∟∟stock_name | string | 股票名称 | -| ∟∟quantity | string | 下单数量 | -| ∟∟executed_qty | string | 成交数量 | -| ∟∟price | string | 下单价格 | -| ∟∟executed_price | string | 成交价格 | -| ∟∟submitted_at | int64 | 下单时间 | -| ∟∟action | string | 买卖方向
Buy: 买入
Sell: 卖出 | -| ∟∟symbol | string | 股票代码，使用 ticker.region 格式 | -| ∟∟order_type | string | 订单类型 | -| ∟∟last_done | string | 最近成交价格 | -| ∟∟trigger_price | string | LIT / MIT 订单触发价格 | -| ∟∟msg | string | 拒绝信息或备注 | -| ∟∟tag | string | 订单标记
Normal 普通订单
GTC 长期单
Grey 暗盘单 | -| ∟∟time_in_force | string | 订单有效期类型
Day 当日有效
GTC 撤单前有效
GTD 到期前有效 | -| ∟∟gtd | string | 长期单的有效时间 格式: 2020-01-01 | -| ∟∟updated_at | int64 | 最近更新时间 | -| ∟∟trigger_at | int64 | 条件单触发时间 | -| ∟∟trailing_amount | string | 条件单跟踪金额 | -| ∟∟trailing_percent | string | 条件单跟踪涨跌幅 | -| ∟∟limit_offset | string | 指定价差 | -| ∟∟trigger_status | number | 条件单触发状态
NOT_ACTIVE 未激活
DEACTIVE 已失效
ACTIVE 已激活
RELEASED 已触发 | -| ∟∟currency | string | 结算货币 | -| ∟∟outside_rth | string | 美股是否允许盘前盘后
RTH_ONLY 不允许盘前盘后
ANY_TIME 允许盘前盘后 | +| 名称 | 类型 | 描述 | +| ------------------------------------------------------------ | -------- | ------------------------------------------------------------ | +| code | int | 错误码，非 0 表示失败 | +| msg | string | 错误描述 | +| data | object | | +| ∟has_more | bool | 是否还有数据，如果为 true，则需要通过最后的时间再次请求。 | +| ∟orders | []object | 订单详情列表 | +| ∟∟order_id | string | 订单 id | +| ∟∟status | string | 订单状态 | +| ∟∟stock_name | string | 股票名称 | +| ∟∟quantity | string | 下单数量 | +| ∟∟executed_qty | string | 成交数量 | +| ∟∟price | string | 下单价格 | +| ∟∟executed_price | string | 成交价格 | +| ∟∟submitted_at | string | 下单时间 | +| ∟∟side | string | 买卖方向
Buy: 买入
Sell: 卖出 | +| ∟∟symbol | string | 股票代码，使用 ticker.region 格式 | +| ∟∟order_type | string | 订单类型 | +| ∟∟last_done | string | 最近成交价格 | +| ∟∟trigger_price | string | LIT / MIT 订单触发价格 | +| ∟∟msg | string | 拒绝信息或备注 | +| ∟∟tag | string | 订单标记
Normal 普通订单
GTC 长期单
Grey 暗盘单 | +| ∟∟time_in_force | string | 订单有效期类型
Day 当日有效
GTC 撤单前有效
GTD 到期前有效 | +| ∟∟expire_date | string | 长期单的有效时间 格式: 2020-01-01 | +| ∟∟updated_at | string | 最近更新时间 | +| ∟∟trigger_at | string | 条件单触发时间 | +| ∟∟trailing_amount | string | 条件单跟踪金额 | +| ∟∟trailing_percent | string | 条件单跟踪涨跌幅 | +| ∟∟limit_offset | string | 指定价差 | +| ∟∟trigger_status | string | 条件单触发状态
NOT_ACTIVE 未激活
DEACTIVE 已失效
ACTIVE 已激活
RELEASED 已触发 | +| ∟∟currency | string | 结算货币 | +| ∟∟outside_rth | string | 美股是否允许盘前盘后
RTH_ONLY 不允许盘前盘后
ANY_TIME 允许盘前盘后 | diff --git a/docs/trade/orders/history-trades.md b/docs/trade/orders/history-trades.md index df2183f6..527db5fc 100644 --- a/docs/trade/orders/history-trades.md +++ b/docs/trade/orders/history-trades.md @@ -27,39 +27,39 @@ title: 历史成交 ### 请求参数 -| 名称 | 类型 | 必须 | 描述 | 默认值 | 示例 | -|----------|--------|-----|--------------------------|-----|--------------------| -| symbol | string | | 股票代码，使用 ticker.region 格式 | | 700.HK | -| start_at | int64 | | 开始时间，格式为时间戳 (秒) | | 1650410999 | -| end_at | int64 | | 结束时间，格式为时间戳 (秒) | | 1650510999 | -| order_id | int64 | | 订单 ID，用于指定订单 ID 查询 | | 701276261045858304 | +| 名称 | 类型 | 必须 | 描述 | 默认值 | 示例 | +| -------- | ------ | ---- | --------------------------------- | ------ | ------------------ | +| symbol | string | | 股票代码，使用 ticker.region 格式 | | 700.HK | +| start_at | string | | 开始时间，格式为时间戳 (秒) | | 1650410999 | +| end_at | string | | 结束时间，格式为时间戳 (秒) | | 1650510999 | +| order_id | string | | 订单 ID，用于指定订单 ID 查询 | | 701276261045858304 | start_at 和 end_at 的组合如下 -| Start 类型 | End 类型 | 说明 | -|:---------|:-------|:------------------------| -| int64 | int64 | start 和 end 分别为指定的时间 | -| None | int64 | start 为 end 往前 90 天 | -| int64 | None | end 为 start 往后 90 天 | -| None | None | start 为往前 90 天，end 当前日期 | +| Start 类型 | End 类型 | 说明 | +| :--------- | :------- | :------------------------------- | +| string | string | start 和 end 分别为指定的时间 | +| None | string | start 为 end 往前 90 天 | +| string | None | end 为 start 往后 90 天 | +| None | None | start 为往前 90 天，end 当前日期 | ## 响应 ### 响应体 -| 名称 | 类型 | 描述 | -|---------------------------------------------------------------------|----------|---------------------------------| -| code | int | 错误码，非 0 表示失败 | -| msg | string | 错误描述 | -| data | object | | -| ∟has_more | bool | 是否还有数据，如果为 true，则需要通过最后的时间再次请求。 | -| ∟trades | []object | | -| ∟∟trade_id | string | 成交 ID | -| ∟∟order_id | int64 | 订单 ID | -| ∟∟symbol | string | 股票代码，使用 ticker.region 格式 | -| ∟∟trade_done_at | int64 | 成交时间 | -| ∟∟price | string | 成交价格 | -| ∟∟quantity | string | 成交数量 | +| 名称 | 类型 | 描述 | +| ------------------------------------------------------------ | -------- | --------------------------------------------------------- | +| code | int | 错误码，非 0 表示失败 | +| msg | string | 错误描述 | +| data | object | | +| ∟has_more | bool | 是否还有数据，如果为 true，则需要通过最后的时间再次请求。 | +| ∟trades | []object | | +| ∟∟trade_id | string | 成交 ID | +| ∟∟order_id | string | 订单 ID | +| ∟∟symbol | string | 股票代码，使用 ticker.region 格式 | +| ∟∟trade_done_at | string | 成交时间 | +| ∟∟price | string | 成交价格 | +| ∟∟quantity | string | 成交数量 | diff --git a/docs/trade/orders/replace.md b/docs/trade/orders/replace.md index 7a6d666b..f2838312 100644 --- a/docs/trade/orders/replace.md +++ b/docs/trade/orders/replace.md @@ -29,7 +29,7 @@ title: 改单 | 名称 | 类型 | 必须 | 描述 | 默认值 | 示例 | | ---------------- | ------ | -------------------------------------- | ----------------------------------------------------- | ------ | ------------------ | -| order_id | int64 | 是 | 订单 id | | 683615454870679552 | +| order_id | string | 是 | 订单 id | | 683615454870679552 | | quantity | string | 是 | 改单数量 | | 100 | | price | string | LO / ELO / ALO / ODD / LIT 订单必填 | 改单价格 | | 30.5 | | trigger_price | string | LIT / MIT 订单必填 | 触发价格 | | 30.3 | diff --git a/docs/trade/orders/submit.md b/docs/trade/orders/submit.md index 228e6c2d..2249cba2 100644 --- a/docs/trade/orders/submit.md +++ b/docs/trade/orders/submit.md @@ -27,21 +27,21 @@ title: 下单 ### 请求体 -| 名称 | 类型 | 必须 | 描述 | 默认值 | 示例 | -| ------------------ | ------ | ---------------------------------------- | ------------------------------------------------------------ | ------ | ---------- | -| symbol | string | 是 | 股票代码，使用 ticker.region 格式 | | AAPL.US | -| order_type | string | 是 | [订单类型](../trade-definition#ordertype) | | LO | -| submitted_price | string | LO / ELO / ALO / / ODD / LIT 订单必填 | 下单价格 | | 388.5 | -| submitted_quantity | string | 是 | 下单数量 | | 100 | -| trigger_price | string | LIT / MIT 订单必填 | 触发价格 | | 345.2 | -| limit_offset | string | TSLPAMT / TSLPPCT 订单必填 | 指定价差 | | 10.1 | -| trailing_amount | string | TSLPAMT / TSMAMT 订单必填 | 跟踪金额 | | 5.9 | -| trailing_percent | string | TSMPCT / TSLPPCT 订单必填 | 跟踪涨跌幅，如跟踪涨跌 10% 时，trailing_percent 为 10 | | 10.3 | -| expire_date | string | time_in_force 为 GTD 时必填 | 长期单过期时间，格式为 YYYY-MM-DD | | 2022-12-05 | -| side | string | 是 | 买卖方向
Buy: 买入
Sell: 卖出 | | Buy | -| outside_rth | string | 美股订单必填 | 美股是否允许盘前盘后
RTH_ONLY: 不允许盘前盘后
ANY_TIME:允许盘前盘后 | | RTH_ONLY | -| time_in_force | string | 是 | 订单有效期类型
Day:当日有效
GTC: 撤单前有效
GTD: 到期前有效 | | GTD | -| remark | string | | 备注，不超过 64 字符 | | | +| 名称 | 类型 | 必须 | 描述 | 默认值 | 示例 | +| ------------------ | ------ | ------------------------------------- | ------------------------------------------------------------ | ------ | ---------- | +| symbol | string | 是 | 股票代码，使用 ticker.region 格式 | | AAPL.US | +| order_type | string | 是 | [订单类型](../trade-definition#ordertype) | | LO | +| submitted_price | string | LO / ELO / ALO / ODD / LIT 订单必填 | 下单价格 | | 388.5 | +| submitted_quantity | string | 是 | 下单数量 | | 100 | +| trigger_price | string | LIT / MIT 订单必填 | 触发价格 | | 345.2 | +| limit_offset | string | TSLPAMT / TSLPPCT 订单必填 | 指定价差 | | 10.1 | +| trailing_amount | string | TSLPAMT / TSMAMT 订单必填 | 跟踪金额 | | 5.9 | +| trailing_percent | string | TSMPCT / TSLPPCT 订单必填 | 跟踪涨跌幅，如跟踪涨跌 10% 时，trailing_percent 为 10 | | 10.3 | +| expire_date | string | time_in_force 为 GTD 时必填 | 长期单过期时间，格式为 YYYY-MM-DD | | 2022-12-05 | +| side | string | 是 | 买卖方向
Buy: 买入
Sell: 卖出 | | Buy | +| outside_rth | string | 美股订单必填 | 美股是否允许盘前盘后
RTH_ONLY: 不允许盘前盘后
ANY_TIME:允许盘前盘后 | | RTH_ONLY | +| time_in_force | string | 是 | 订单有效期类型
Day:当日有效
GTC: 撤单前有效
GTD: 到期前有效 | | GTD | +| remark | string | | 备注，不超过 64 字符 | | | ## 响应 @@ -53,7 +53,7 @@ title: 下单 | code | int | 错误码，非 0 表示失败 | | msg | string | 错误描述 | | data | object | | -| ∟order_id | int64 | 订单 id | +| ∟order_id | string | 订单 id | diff --git a/docs/trade/orders/today-orders.md b/docs/trade/orders/today-orders.md index f3c9dfcd..603200a2 100644 --- a/docs/trade/orders/today-orders.md +++ b/docs/trade/orders/today-orders.md @@ -33,7 +33,7 @@ title: 当日订单 | status | []string | | [订单状态](../trade-definition#orderstatus) | | ["FilledStatus", "PartialFilledStatus"] | | side | string | | 买卖方向
Buy: 买入
Sell: 卖出 | | Buy | | market | string | | [市场](../trade-definition#market) | | US | -| order_id | int64 | | 订单 ID，用于指定订单 ID 查询 | | 701276261045858304 | +| order_id | string | | 订单 ID，用于指定订单 ID 查询 | | 701276261045858304 | @@ -47,15 +47,15 @@ title: 当日订单 | msg | string | 错误描述 | | data | object | | | ∟orders | []object | 订单详情列表 | -| ∟∟order_id | int64 | 订单 id | +| ∟∟order_id | string | 订单 id | | ∟∟status | string | 订单状态 | | ∟∟stock_name | string | 股票名称 | | ∟∟quantity | string | 下单数量 | | ∟∟executed_qty | string | 成交数量 | | ∟∟price | string | 下单价格 | | ∟∟executed_price | string | 成交价格 | -| ∟∟submitted_at | int64 | 下单时间 | -| ∟∟action | string | 买卖方向
Buy: 买入
Sell: 卖出 | +| ∟∟submitted_at | string | 下单时间 | +| ∟∟side | string | 买卖方向
Buy: 买入
Sell: 卖出 | | ∟∟symbol | string | 股票代码，使用 ticker.region 格式 | | ∟∟order_type | string | 订单类型 | | ∟∟last_done | string | 最近成交价格 | @@ -63,13 +63,13 @@ title: 当日订单 | ∟∟msg | string | 拒绝信息或备注 | | ∟∟tag | string | 订单标记
Normal 普通订单
GTC 长期单
Grey 暗盘单 | | ∟∟time_in_force | string | 订单有效期类型
Day 当日有效
GTC 撤单前有效
GTD 到期前有效 | -| ∟∟gtd | string | 长期单的有效时间 格式: 2020-01-01 | -| ∟∟updated_at | int64 | 最近更新时间 | -| ∟∟trigger_at | int64 | 条件单触发时间 | +| ∟∟expire_date | string | 长期单的有效时间 格式: 2020-01-01 | +| ∟∟updated_at | string | 最近更新时间 | +| ∟∟trigger_at | string | 条件单触发时间 | | ∟∟trailing_amount | string | 条件单跟踪金额 | | ∟∟trailing_percent | string | 条件单跟踪涨跌幅 | | ∟∟limit_offset | string | 指定价差 | -| ∟∟trigger_status | number | 条件单触发状态
NOT_ACTIVE 未激活
DEACTIVE 已失效
ACTIVE 已激活
RELEASED 已触发 | +| ∟∟trigger_status | string | 条件单触发状态
NOT_ACTIVE 未激活
DEACTIVE 已失效
ACTIVE 已激活
RELEASED 已触发 | | ∟∟currency | string | 结算货币 | | ∟∟outside_rth | string | 美股是否允许盘前盘后
RTH_ONLY 不允许盘前盘后
ANY_TIME 允许盘前盘后 | diff --git a/docs/trade/orders/today-trades.md b/docs/trade/orders/today-trades.md index c06bfb64..2ddbd8f0 100644 --- a/docs/trade/orders/today-trades.md +++ b/docs/trade/orders/today-trades.md @@ -30,7 +30,7 @@ title: 当日成交 | 名称 | 类型 | 必须 | 描述 | 默认值 | 示例 | | -------- | ------ | ---- | --------------------------------- | ------ | ------------------ | | symbol | string | | 股票代码，使用 ticker.region 格式 | | 700.HK | -| order_id | int64 | | 订单 ID，用于指定订单 ID 查询 | | 701276261045858304 | +| order_id | string | | 订单 ID，用于指定订单 ID 查询 | | 701276261045858304 | @@ -45,9 +45,9 @@ title: 当日成交 | data | object | | | ∟trades | []object | | | ∟∟trade_id | string | 成交 ID | -| ∟∟order_id | int64 | 订单 ID | +| ∟∟order_id | string | 订单 ID | | ∟∟symbol | string | 股票代码，使用 ticker.region 格式 | -| ∟∟trade_done_at | int64 | 成交时间 | +| ∟∟trade_done_at | string | 成交时间 | | ∟∟price | string | 成交价格 | | ∟∟quantity | string | 成交数量 | @@ -65,7 +65,7 @@ title: 当日成交 "quantity": "100", "symbol": "700.HK", "trade_done_at": "1648611351", - "trade_id": "693664675163312128-1648611351433741210" + "string": "693664675163312128-1648611351433741210" } ] } diff --git a/docs/trade/orders/withdraw.md b/docs/trade/orders/withdraw.md index 0bd6e59b..aa90e2a4 100644 --- a/docs/trade/orders/withdraw.md +++ b/docs/trade/orders/withdraw.md @@ -27,9 +27,9 @@ title: 撤单 ### 请求体 -| 名称 | 类型 | 必须 | 描述 | 默认值 | 示例 | -| -------- | ----- | ---- | ------- | ------ | ------------------ | -| order_id | int64 | 是 | 订单 id | | 683615454870679552 | +| 名称 | 类型 | 必须 | 描述 | 默认值 | 示例 | +| -------- | ------ | ---- | ------- | ------ | ------------------ | +| order_id | string | 是 | 订单 id | | 683615454870679552 | ## 响应