Skip to content

Commit 4082575

Browse files
authored
Update api.md
1 parent 8f1d055 commit 4082575

File tree

1 file changed

+80
-1
lines changed

1 file changed

+80
-1
lines changed

api.md

Lines changed: 80 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
1.4.6、[获取交易品种的K线](#46获取交易品种的K线)</br>
3535
1.4.7、[获取交易品种的K线-历史](#47获取交易品种的K线历史)</br>
3636
1.4.8、[获取市场交易日历](#48获取市场交易日历)</br>
37+
1.4.9、[获取产品列表](#49获取产品列表)</br>
3738
### 1.5、通过[Webscoket订阅或者请求实时数据接口](#5websocket协议接口定义)
3839
把key加入到**URL参数中**或者**请求头中**使用key字段填充,然后建立websocket连接,发送相应的订阅命令,并保持心跳就可以得到实时报价了</br>
3940
1.5.0、[websocket协议接入说明](#50websocket协议接入说明)</br>
@@ -1681,7 +1682,7 @@
16811682
#### 4.8.1、请求参数(Body)
16821683
| 参数名 | 类型 | 必填 | 描述 |
16831684
|------------|--------|------|-----------------------------|
1684-
| `market` | array ||市场字符串数组 "US":美股 "HK":港股 "SH":A股沪市 "SZ":A股深市 |
1685+
| `market` | array ||市场字符串数组</br>"US": 美股</br>"HK": 港股</br>"SH": A股沪市</br>"SZ": A股深市 |
16851686
> [返回目录](#目录)
16861687
#### 4.8.2、请求示例(Body)
16871688
```json
@@ -1731,6 +1732,84 @@
17311732
```
17321733
> [返回目录](#目录)
17331734
---
1735+
### 4.9、获取产品列表
1736+
- **接口地址**`/product-list`
1737+
- **请求方式**`POST`
1738+
- **接口描述**:获取指定一个或者多个市场的产品列表。支持全美股票,全港股票,全A(沪深)股票,外汇,贵金属,黄金,白银,指数,能源等产品。通过接口获取到的产品列表是挑选的较为热门的或者常用的,如果您需要其它的或者更多,请点击右下角,联系客服。
1739+
> [返回目录](#目录)
1740+
1741+
#### 4.9.1、请求参数(Body)
1742+
| 参数名 | 类型 | 必填 | 描述 |
1743+
|------------|--------|------|-----------------------------|
1744+
| `market` | array ||市场字符串数组</br>"US": 美股</br>"HK": 港股</br>"SH": A股沪市</br>"SZ": A股深市</br>"SI": 股票指数</br>"FX": 外汇</br>"IX": 指数</br>"CM": 大宗商品(黄金,白银,能源)</br>"CF": 加密货币永续合约|
1745+
> [返回目录](#目录)
1746+
#### 4.9.2、请求示例(Body)
1747+
```json
1748+
{
1749+
"market":["HK","US","CM"]
1750+
}
1751+
```
1752+
> [返回目录](#目录)
1753+
#### 4.9.3、响应结果
1754+
| 字段名称 | 类型 | 描述 |
1755+
|----------|--------|--------------------------------------------|
1756+
| `市场编码` | array | 市场对应的产品列表 |
1757+
| > `code` | string | 产品编码|
1758+
| > `name` | string | 产品名称|
1759+
1760+
> [返回目录](#目录)
1761+
#### 4.9.4、响应示例
1762+
```json
1763+
{
1764+
"msg": "OK",
1765+
"data": {
1766+
"CM": [
1767+
{
1768+
"code": "CM:XAUUSD",
1769+
"name": "黄金"
1770+
},
1771+
{
1772+
"code": "CM:XBRUSD",
1773+
"name": "布伦特原油"
1774+
},
1775+
{
1776+
"code": "CM:XTIUSD",
1777+
"name": "美国原油"
1778+
},
1779+
{
1780+
"code": "CM:XNGUSD",
1781+
"name": "天然气"
1782+
}
1783+
],
1784+
"HK": [
1785+
{
1786+
"code": "HK:01810",
1787+
"name": "小米集团-W"
1788+
},
1789+
{
1790+
"code": "HK:00700",
1791+
"name": "腾讯控股"
1792+
}
1793+
],
1794+
"US": [
1795+
{
1796+
"code": "US:NVDA",
1797+
"name": "英伟达"
1798+
},
1799+
{
1800+
"code": "US:TSLA",
1801+
"name": "特斯拉"
1802+
},
1803+
{
1804+
"code": "US:AAPL",
1805+
"name": "苹果"
1806+
}
1807+
]
1808+
}
1809+
}
1810+
```
1811+
> [返回目录](#目录)
1812+
---
17341813
## 5、websocket协议接口定义
17351814
### 5.0、websocket协议接入说明
17361815
- **websocket地址:** `wss://api.qos.hk/ws`

0 commit comments

Comments
 (0)