重构 API 文档结构，给每个文件增加 SDK 的文件链接。

longportapp · May 20, 2024 · 97d4c0e · 97d4c0e
1 parent fb2cfd7
commit 97d4c0e
Show file tree

Hide file tree

Showing 161 changed files with 4,134 additions and 3,705 deletions.
diff --git a/docs/quote/level.md b/docs/quote/level.md
@@ -39,7 +39,7 @@ slug: level
     </tr>
 </table>
 
-#### 频次限制
+## 频次限制
 
 :::caution
 

diff --git a/docs/quote/objects.md b/docs/quote/objects.md
@@ -7,7 +7,7 @@ slug: objects
 
 # 行情命名词典
 
-### TradeStatus - 交易状态
+## TradeStatus - 交易状态
 
 交易状态
 
@@ -25,7 +25,7 @@ slug: objects
 | 9   | 轮证待上市      |
 | 10  | 终止交易        |
 
-#### Protobuf
+### Protobuf
 
 ```protobuf
 enum TradeStatus {
@@ -43,7 +43,7 @@ enum TradeStatus {
 }
 ```
 
-### TradeSession - 交易时段
+## TradeSession - 交易时段
 
 交易时段
 
@@ -54,7 +54,7 @@ enum TradeStatus {
 | 2   | 盘后交易 |
 | 3   | 夜盘交易 |
 
-#### Protobuf
+### Protobuf
 
 ```protobuf
 enum TradeSession {
@@ -64,7 +64,7 @@ enum TradeSession {
 }
 ```
 
-### Period - K 线周期
+## Period - K 线周期
 
 | ID   | 描述          |
 | ---- | ------------- |
@@ -78,7 +78,7 @@ enum TradeSession {
 | 3000 | 月 k 线       |
 | 4000 | 年 k 线       |
 
-#### Protobuf
+### Protobuf
 
 ```protobuf
 enum Period {
@@ -95,14 +95,14 @@ enum Period {
 }
 ```
 
-### AdjustType - K 线复权类型
+## AdjustType - K 线复权类型
 
 | ID  | 描述   |
 | --- | ------ |
 | 0   | 除权   |
 | 1   | 前复权 |
 
-#### Protobuf
+### Protobuf
 
 ```protobuf
 enum AdjustType {
@@ -111,7 +111,7 @@ enum AdjustType {
 }
 ```
 
-### SubType - 订阅数据的类型
+## SubType - 订阅数据的类型
 
 | ID  | 描述     |
 | --- | -------- |
@@ -120,7 +120,7 @@ enum AdjustType {
 | 3   | 经纪队列 |
 | 4   | 逐笔明细 |
 
-#### Protobuf
+### Protobuf
 
 ```protobuf
 enum SubType {
@@ -132,7 +132,7 @@ enum SubType {
 }
 ```
 
-### CalcIndex - 计算指标
+## CalcIndex - 计算指标
 
 | ID  | 描述         | 支持的标的类型   |
 | --- | ------------ | ---------------- |
@@ -177,7 +177,7 @@ enum SubType {
 | 39  | Vega         | 仅期权适用       |
 | 40  | Rho          | 仅期权适用       |
 
-#### Protobuf
+### Protobuf
 
 ```protobuf
 enum CalcIndex {
@@ -225,7 +225,7 @@ enum CalcIndex {
 }
 ```
 
-### Board - 标的板块
+## Board - 标的板块
 
 | 板块             | 描述                             |
 | ---------------- | -------------------------------- |

diff --git a/docs/quote/overview.md b/docs/quote/overview.md
@@ -5,7 +5,7 @@ title: Overview
 slug: overview
 ---
 
-### 行情接口概览
+# 行情接口概览
 
 <table>
     <tr>
@@ -115,7 +115,7 @@ slug: overview
     </tr>
 </table>
 
-### 标的代码说明
+## 标的代码说明
 
 标的代码使用 `ticker.region` 格式，`ticker` 表示标的代码，各个市场的标的代码示例：
 
@@ -124,12 +124,12 @@ slug: overview
 - A 股市场：`region` 上交所为 `SH`，深交所为 `SZ`，例如：`399001.SZ`，`600519.SH`
 - 新加坡市场：`region` 为 `SG`，例如：`D05.SG`
 
-### 接入方式
+## 接入方式
 
 1. 使用私有协议，长连接方式进行接入，接入方法请参考 <a href="../socket/protocol/overview" target="_blank">二进制通信协议</a>。
 2. 使用 SDK 进行接入，[SDK 介绍及下载地址](https://open.longportapp.com/sdk)。
 
-### 业务数据序列化方式
+## 业务数据序列化方式
 
 行情的请求、响应、推送数据作为业务数据，存放在私有协议的数据包 body 部分。
 我们使用 [Protobuf](https://developers.google.cn/protocol-buffers) 协议对业务数据进行序列化，相较于常见的文本协议（如 JSON, XML 等），Protobuf 协议具有如下优点：

diff --git a/docs/quote/pull/broker-ids.md b/docs/quote/pull/broker-ids.md
@@ -7,6 +7,8 @@ sidebar_position: 7
 
 该接口用于获取券商席位 ID 数据 (可每天同步一次)。
 
+<SDKLinks module="quote" klass="QuoteContext" method="participants" />
+
 :::info
 [业务指令](../../socket/biz-command)：`16`
 :::
@@ -34,7 +36,7 @@ print(resp)
 ### Response Properties
 
 | Name                       | Type     | Description           |
-|----------------------------|----------|-----------------------|
+| -------------------------- | -------- | --------------------- |
 | participant_broker_numbers | object[] | 券商席位              |
 | ∟ broker_ids               | int32[]  | 券商对应的多个席位 ID |
 | ∟ participant_name_cn      | string   | 券商名称 (简)         |
@@ -86,7 +88,7 @@ message ParticipantInfo {
 ## 错误码
 
 | 协议错误码 | 业务错误码 | 描述           | 排查建议                 |
-|------------|------------|--------------|----------------------|
+| ---------- | ---------- | -------------- | ------------------------ |
 | 3          | 301600     | 无效的请求     | 请求参数有误或解包失败   |
 | 3          | 301606     | 限流           | 降低请求频次             |
 | 7          | 301602     | 服务端内部错误 | 请重试或联系技术人员处理 |
diff --git a/docs/quote/pull/brokers.md b/docs/quote/pull/brokers.md
@@ -7,6 +7,8 @@ sidebar_position: 6
 
 该接口用于获取标的的实时经纪队列数据。
 
+<SDKLinks module="quote" klass="QuoteContext" method="brokers" />
+
 :::info
 [业务指令](../../socket/biz-command)：`15`
 :::
@@ -15,8 +17,8 @@ sidebar_position: 6
 
 ### Parameters
 
-| Name   | Type   | Required | Description                                       |
-|--------|--------|----------|---------------------------------------------------|
+| Name   | Type   | Required | Description                                          |
+| ------ | ------ | -------- | ---------------------------------------------------- |
 | symbol | string | 是       | 标的代码，使用 `ticker.region` 格式，例如： `700.HK` |
 
 ### Protobuf
@@ -47,14 +49,14 @@ print(resp)
 
 ### Response Properties
 
-| Name         | Type     | Description                                               |
-|--------------|----------|-----------------------------------------------------------|
-| symbol       | string   | 标的代码                                                  |
-| ask_brokers  | object[] | 卖盘经纪队列                                              |
-| ∟ position   | int32    | 档位                                                      |
+| Name         | Type     | Description                                                |
+| ------------ | -------- | ---------------------------------------------------------- |
+| symbol       | string   | 标的代码                                                   |
+| ask_brokers  | object[] | 卖盘经纪队列                                               |
+| ∟ position   | int32    | 档位                                                       |
 | ∟ broker_ids | int32[]  | 券商席位 ID，通过[获取券商席位 ID ](./broker-ids) 接口获取 |
-| bid_brokers  | object[] | 买盘经纪队列                                              |
-| ∟ position   | int32    | 档位                                                      |
+| bid_brokers  | object[] | 买盘经纪队列                                               |
+| ∟ position   | int32    | 档位                                                       |
 | ∟ broker_ids | int32[]  | 券商席位 ID，通过[获取券商席位 ID ](./broker-ids) 接口获取 |
 
 ### Protobuf
@@ -102,7 +104,7 @@ message Brokers {
 ## 错误码
 
 | 协议错误码 | 业务错误码 | 描述           | 排查建议                     |
-|------------|------------|--------------|--------------------------|
+| ---------- | ---------- | -------------- | ---------------------------- |
 | 3          | 301600     | 无效的请求     | 请求参数有误或解包失败       |
 | 3          | 301606     | 限流           | 降低请求频次                 |
 | 7          | 301602     | 服务端内部错误 | 请重试或联系技术人员处理     |

diff --git a/docs/quote/pull/calc-index.md b/docs/quote/pull/calc-index.md
@@ -7,6 +7,8 @@ sidebar_position: 19
 
 该接口用于获取标的计算指标数据，根据请求指定的计算指标返回数据。
 
+<SDKLinks module="quote" klass="QuoteContext" method="calc_indexes" go="CalcIndex" />
+
 :::info
 [业务指令](../../socket/biz-command)：`26`
 :::
@@ -57,7 +59,7 @@ message SecurityCalcQuoteRequest {
 | ∟ capital_flow             | string   | 流入资金                                     |
 | ∟ amplitude                | string   | 振幅 (返回百分比数据，不包含`%`符号)         |
 | ∟ volume_ratio             | string   | 量比                                         |
-| ∟ pe_ttm_ratio             | string   | 市盈率 (TTM）                               |
+| ∟ pe_ttm_ratio             | string   | 市盈率 (TTM）                                |
 | ∟ pb_ratio                 | string   | 市净率                                       |
 | ∟ dividend_ratio_ttm       | string   | 股息率 (TTM)                                 |
 | ∟ five_day_change_rate     | string   | 五日涨幅 (返回百分比数据，不包含`%`符号)     |

diff --git a/docs/quote/pull/candlestick.md b/docs/quote/pull/candlestick.md
@@ -7,6 +7,8 @@ sidebar_position: 10
 
 该接口用于获取标的的 K 线数据。
 
+<SDKLinks module="quote" klass="QuoteContext" method="candlesticks" />
+
 :::info
 
 [业务指令](../../socket/biz-command)：`19`
@@ -17,8 +19,8 @@ sidebar_position: 10
 
 ### Parameters
 
-| Name        | Type   | Required | Description                                                               |
-|-------------|--------|----------|---------------------------------------------------------------------------|
+| Name        | Type   | Required | Description                                                                  |
+| ----------- | ------ | -------- | ---------------------------------------------------------------------------- |
 | symbol      | string | 是       | 标的代码，使用 `ticker.region` 格式，例如：`700.HK`                          |
 | period      | int32  | 是       | k 线周期，例如：`1000`，详见 [Period](../objects#period---k-线周期)          |
 | count       | int32  | 是       | 数据数量，例如：`100`<br /><br />**校验规则：** <br />请求数量最大为 `1000`  |
@@ -55,17 +57,17 @@ print(resp)
 
 ### Response Properties
 
-| Name         | Type     | Description             |
-|--------------|----------|-------------------------|
+| Name         | Type     | Description               |
+| ------------ | -------- | ------------------------- |
 | symbol       | string   | 标的代码，例如：`AAPL.US` |
-| candlesticks | object[] | K 线数据                |
-| ∟ close      | string   | 当前周期收盘价          |
-| ∟ open       | string   | 当前周期开盘价          |
-| ∟ low        | string   | 当前周期最低价          |
-| ∟ high       | string   | 当前周期最高价          |
-| ∟ volume     | int64    | 当前周期成交量          |
-| ∟ turnover   | string   | 当前周期成交额          |
-| ∟ timestamp  | int64    | 当前周期的时间戳        |
+| candlesticks | object[] | K 线数据                  |
+| ∟ close      | string   | 当前周期收盘价            |
+| ∟ open       | string   | 当前周期开盘价            |
+| ∟ low        | string   | 当前周期最低价            |
+| ∟ high       | string   | 当前周期最高价            |
+| ∟ volume     | int64    | 当前周期成交量            |
+| ∟ turnover   | string   | 当前周期成交额            |
+| ∟ timestamp  | int64    | 当前周期的时间戳          |
 
 ### Protobuf
 
@@ -143,12 +145,12 @@ message Candlestick {
 
 ## 错误码
 
-| 协议错误码 | 业务错误码 | 描述           | 排查建议                                                               |
-|------------|------------|--------------|--------------------------------------------------------------------|
-| 3          | 301600     | 无效的请求     | 请求参数有误或解包失败                                                 |
-| 3          | 301606     | 限流           | 降低请求频次                                                           |
-| 7          | 301602     | 服务端内部错误 | 请重试或联系技术人员处理                                               |
+| 协议错误码 | 业务错误码 | 描述           | 排查建议                                                                 |
+| ---------- | ---------- | -------------- | ------------------------------------------------------------------------ |
+| 3          | 301600     | 无效的请求     | 请求参数有误或解包失败                                                   |
+| 3          | 301606     | 限流           | 降低请求频次                                                             |
+| 7          | 301602     | 服务端内部错误 | 请重试或联系技术人员处理                                                 |
 | 7          | 301600     | 请求数据非法   | 检查请求的 `symbol`，`count`，`adjust_type`, `period` 数据是否在正确范围 |
-| 7          | 301603     | 标的无行情     | 标的没有请求的行情数据                                                 |
-| 7          | 301604     | 无权限         | 没有获取标的行情的权限                                                 |
-| 7          | 301607     | 接口限制       | 请求的数据数量超限，减少数据数量                                        |
+| 7          | 301603     | 标的无行情     | 标的没有请求的行情数据                                                   |
+| 7          | 301604     | 无权限         | 没有获取标的行情的权限                                                   |
+| 7          | 301607     | 接口限制       | 请求的数据数量超限，减少数据数量                                         |
diff --git a/docs/quote/pull/capital-distribution.md b/docs/quote/pull/capital-distribution.md
@@ -7,6 +7,8 @@ sidebar_position: 18
 
 该接口用于获取标的当日的资金分布。
 
+<SDKLinks module="quote" klass="QuoteContext" method="capital_distribution" />
+
 :::info
 [业务指令](../../socket/biz-command)：`25`
 :::

diff --git a/docs/quote/pull/capital-flow-intraday.md b/docs/quote/pull/capital-flow-intraday.md
@@ -7,6 +7,8 @@ sidebar_position: 17
 
 该接口用于获取标的当日的资金流向。
 
+<SDKLinks module="quote" klass="QuoteContext" method="capital_flow" />
+
 :::info
 [业务指令](../../socket/biz-command)：`24`
 :::
@@ -30,10 +32,13 @@ message CapitalFlowIntradayRequest {
 ### Request Example
 
 ```python
-# Get Security Capital Flow Intraday
-# https://open.longportapp.com/docs/quote/pull/capital-flow-intraday
-# 运行前请访问“开发者中心”确保账户有正确的行情权限。
-# 如没有开通行情权限，可以通过“LongPort”手机客户端，并进入“我的 - 我的行情 - 行情商城”购买开通行情权限。
+from longport.openapi import QuoteContext, Config
+
+config = Config.from_env()
+ctx = QuoteContext(config)
+
+resp = ctx.capital_flow("700.HK")
+print(resp)
 ```
 
 ## Response