Skip to content

Commit

Permalink
Merge pull request #249 from QFCG/main
Browse files Browse the repository at this point in the history 
 Supplement documentation based on interface fields
  • Loading branch information
@sunli829
sunli829 authored Apr 10, 2024
2 parents f00595d + ba6127e commit 62c3fb7
Show file tree
Hide file tree
Showing 6 changed files with 134 additions and 116 deletions.
70 changes: 35 additions & 35 deletions docs/quote/pull/warrant-filter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ sidebar_position: 14

### Parameters

| Name | Type | Required | Description |
|---------------|---------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------|
| Name | Type | Required | Description |
| ------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| symbol | string | 是 | 标的代码，使用 `ticker.region` 格式，例如：`700.HK` |
| filter_config | object | 是 | 筛选条件 |
| ∟ sort_by | int32 | 是 | 根据哪一项数据进行排序，例如：`0`，序号见响应数据 `OrderSequence` 字段。 |
| filter_config | object | 是 | 筛选条件 |
| ∟ sort_by | int32 | 是 | 根据哪一项数据进行排序，例如：`0`，序号见响应数据 `OrderSequence` 字段。 |
| ∟ sort_order | int32 | 是 | 升降顺序，例如：`1` <br /><br />**可选值：**<br />`0` - 升序<br />`1` - 降序 |
| ∟ sort_offset | int32 | 是 | 分页的第一条数据偏移量，例如 `0` |
| ∟ sort_count | int32 | 是 | 分页的每一页数量，例如 `20` <br /><br />**校验规则：**<br /> 每页数量最大为 `500` |
| ∟ type | int32[] | 否 | 筛选轮证类型 例如：`[0,1]` <br /><br />**可选值：**<br />`0` - 认购<br />`1` - 认沽<br />`2` - 牛证<br />`3` - 熊证<br />`4` - 界内证 |
| ∟ sort_offset | int32 | 是 | 分页的第一条数据偏移量，例如 `0` |
| ∟ sort_count | int32 | 是 | 分页的每一页数量，例如 `20`, 填 `0` 时不分页 |
| ∟ type | int32[] | 否 | 筛选轮证类型 例如：`[0,1]` <br /><br />**可选值：**<br />`0` - 认购<br />`1` - 认沽<br />`2` - 牛证<br />`3` - 熊证<br />`4` - 界内证 |
| ∟ issuer | int32[] | 否 | 筛选发行商，例如：`[12,14]`，[发行商 ID](./issuer) 通过接口获取 |
| ∟ expiry_date | int32[] | 否 | 筛选轮证过期时间，例如：`[1]` <br /><br />**可选值：**<br />`1` - 低于 3 个月<br />`2` - 3 - 6 个月<br />`3` - 6 - 12 个月<br />`4` - 大于 12 个月 |
| ∟ price_type | int32[] | 否 | 筛选价内价外，例如：`[2]` <br /><br />**可选值：**<br />`1` - 价内<br />`2` - 价外 |
Expand Down Expand Up @@ -70,34 +70,34 @@ print(resp)

### Response Properties

| Name | Type | Description | OrderSequence | Support_Call/Put | Support_Bull/Bear | Support_Inline |
|----------------------|----------|-----------------------------------------------------------------------------------------|---------------|------------------|-------------------|----------------|
| warrant_list | object[] | 涡轮筛选数据列表 | | | | |
| ∟ symbol | string | 标的代码 | | true | true | true |
| ∟ name | string | 标的名称 | | true | true | true |
| ∟ last_done | string | 最新价 | 0 | true | true | true |
| ∟ change_rate | string | 涨跌幅 | 1 | true | true | true |
| ∟ change_val | string | 涨跌额 | 2 | true | true | true |
| ∟ volume | int64 | 成交量 | 3 | true | true | true |
| ∟ turnover | string | 成交额 | 4 | true | true | true |
| ∟ expiry_date | string | 到期日，使用 `YYMMDD` 格式 | 5 | true | true | true |
| ∟ strike_price | string | 行权价 | 6 | true | true | false |
| ∟ upper_strike_price | string | 上限价 | 7 | false | false | true |
| ∟ lower_strike_price | string | 下限价 | 8 | false | false | true |
| ∟ outstanding_qty | string | 街货量 | 9 | true | true | true |
| ∟ outstanding_ratio | string | 街货比 | 10 | true | true | true |
| ∟ premium | string | 溢价率 | 11 | true | true | true |
| ∟ itm_otm | string | 价内/价外 | 12 | true | true | false |
| ∟ implied_volatility | string | 引伸波幅 | 13 | true | false | false |
| ∟ delta | string | 对冲值 | 14 | true | false | false |
| ∟ call_price | string | 收回价 | 15 | false | true | false |
| ∟ to_call_price | string | 距收回价 | 16 | false | true | false |
| ∟ effective_leverage | string | 有效杠杆 | 17 | true | false | false |
| ∟ leverage_ratio | string | 杠杆比率 | 18 | true | true | true |
| ∟ conversion_ratio | string | 换股比率 | 19 | true | true | false |
| ∟ balance_point | string | 打和点 | 20 | true | true | false |
| Name | Type | Description | OrderSequence | Support_Call/Put | Support_Bull/Bear | Support_Inline |
| -------------------- | -------- | ----------------------------------------------------------------------------------------- | ------------- | ---------------- | ----------------- | -------------- |
| warrant_list | object[] | 涡轮筛选数据列表 | | | | |
| ∟ symbol | string | 标的代码 | | true | true | true |
| ∟ name | string | 标的名称 | | true | true | true |
| ∟ last_done | string | 最新价 | 0 | true | true | true |
| ∟ change_rate | string | 涨跌幅 | 1 | true | true | true |
| ∟ change_val | string | 涨跌额 | 2 | true | true | true |
| ∟ volume | int64 | 成交量 | 3 | true | true | true |
| ∟ turnover | string | 成交额 | 4 | true | true | true |
| ∟ expiry_date | string | 到期日，使用 `YYMMDD` 格式 | 5 | true | true | true |
| ∟ strike_price | string | 行权价 | 6 | true | true | false |
| ∟ upper_strike_price | string | 上限价 | 7 | false | false | true |
| ∟ lower_strike_price | string | 下限价 | 8 | false | false | true |
| ∟ outstanding_qty | string | 街货量 | 9 | true | true | true |
| ∟ outstanding_ratio | string | 街货比 | 10 | true | true | true |
| ∟ premium | string | 溢价率 | 11 | true | true | true |
| ∟ itm_otm | string | 价内/价外 | 12 | true | true | false |
| ∟ implied_volatility | string | 引伸波幅 | 13 | true | false | false |
| ∟ delta | string | 对冲值 | 14 | true | false | false |
| ∟ call_price | string | 收回价 | 15 | false | true | false |
| ∟ to_call_price | string | 距收回价 | 16 | false | true | false |
| ∟ effective_leverage | string | 有效杠杆 | 17 | true | false | false |
| ∟ leverage_ratio | string | 杠杆比率 | 18 | true | true | true |
| ∟ conversion_ratio | string | 换股比率 | 19 | true | true | false |
| ∟ balance_point | string | 打和点 | 20 | true | true | false |
| ∟ status | int32 | 状态，<br /><br />**可选值：**<br />`2`- 终止交易<br />`3` - 等待上市<br />`4` - 正常交易 | 21 | true | true | true |
| total_count | int32 | 符合条件的轮证总数量 | | | | |
| total_count | int32 | 符合条件的轮证总数量 | | | | |

### Protobuf

Expand Down Expand Up @@ -196,7 +196,7 @@ message FilterWarrant {
## 错误码

| 协议错误码 | 业务错误码 | 描述 | 排查建议 |
|------------|------------|--------------|--------------------------|
| ---------- | ---------- | -------------- | ---------------------------- |
| 3 | 301600 | 无效的请求 | 请求参数有误或解包失败 |
| 3 | 301606 | 限流 | 降低请求频次 |
| 7 | 301602 | 服务端内部错误 | 请重试或联系技术人员处理 |
Expand Down
34 changes: 20 additions & 14 deletions docs/quote/push/quote.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,22 @@ sidebar_position: 1

### Properties

| Name | Type | Description |
|---------------|--------|------------------------------------------------------------------|
| symbol | string | 标的代码，例如：`AAPL.US` |
| sequence | int64 | 序列号 |
| last_done | string | 最新价 |
| open | string | 开盘价 |
| high | string | 最高价 |
| low | string | 最低价 |
| timestamp | int64 | 最新成交的时间戳 |
| volume | int64 | 成交量 |
| turnover | string | 成交额 |
| trade_status | int32 | 交易状态，详见 [TradeStatus](../objects#tradestatus---交易状态) |
| trade_session | int32 | 交易时段，详见 [TradeSession](../objects#tradesession---交易时段) |
| Name | Type | Description |
| ---------------- | ------ | ------------------------------------------------------------------------------------- |
| symbol | string | 标的代码，例如：`AAPL.US` |
| sequence | int64 | 序列号 |
| last_done | string | 最新价 |
| open | string | 开盘价 |
| high | string | 最高价 |
| low | string | 最低价 |
| timestamp | int64 | 最新成交的时间戳 |
| volume | int64 | 成交量 |
| turnover | string | 成交额 |
| trade_status | int32 | 交易状态，详见 [TradeStatus](../objects#tradestatus---交易状态) |
| trade_session | int32 | 交易时段，详见 [TradeSession](../objects#tradesession---交易时段) |
| current_volume | int32 | 两次推送之间增加的成交量 |
| current_turnover | string | 两次推送之间增加的成交额 |
| tag | int32 | 价格数据标签 <br /><br />**可选值：**<br />`0` - 实时行情<br />`1` - 收盘后的修正数据 |

### Protobuf

Expand Down Expand Up @@ -90,6 +93,9 @@ sleep(30)
"volume": 88063191,
"turnover": "13865092584.000",
"trade_status": 0,
"trade_session": 0
"trade_session": 0,
"current_volume": 111234,
"current_turnover": "23234343454.000",
"tag": 0
}
```
Loading

0 comments on commit 62c3fb7

Please sign in to comment.