Browse Source

更新一些文档。

skyffire 1 year ago
parent
commit
2fdb266deb
1 changed files with 135 additions and 5 deletions
  1. 135 5
      README.MD

+ 135 - 5
README.MD

@@ -1,9 +1,8 @@
-## 本地运行此程序,需要在环境变量里设置代理,变量名为proxy_address
+# 本地运行此程序,需要在环境变量里设置代理,变量名为proxy_address
 
-## 127.0.0.1:8888/order_book 获取订单簿信息
-### GET请求
+### `GET` 127.0.0.1:8888/order_book `获取订单簿信息`
 
-##### request
+> request
 ``` json
 {
     "exchange": "binance_usdt_swap",        // 交易所,当前支持[binance_usdt_swap]
@@ -13,7 +12,7 @@
 }
 ```
 
-##### response
+> response
 ``` json
 {
     "msg": "查询成功",                      // 后台提醒
@@ -41,3 +40,134 @@
     ]
 }
 ```
+
+------
+
+# 下面的都是公司数据中心的接口
+
+### 1. `GET` 183.249.84.29:8888/exchanges `获取支持的交易所`
+> response
+``` json
+{
+    "msg": "查询成功",                       // 后台提醒
+    "query": null,                          // 后台收到的查询参数,可用于debug
+    "data": [                               // 返回值
+        "gate_usdt_swap",
+        "bitget_usdt_swap",
+        "binance_usdt_swap",
+        "coinex_usdt_swap"
+    ],
+    "code": 200
+}
+```
+
+### 2. `GET` 183.249.84.29:8888/symbols `获取支持的交易对`
+> request
+``` json
+{
+    "exchange": "binance_usdt_swap",        // 交易所,可以通过/exchanges查询当前支持的交易所
+}
+```
+
+> response
+``` json
+{
+    "msg": "查询成功",                       // 后台提醒
+    "query": {                              // 后台收到的查询参数,可用于debug
+        "exchange": "gate_usdt_swap"
+    },
+    "data": [                               // 该交易所存在数据的所有交易对
+        "DUSK_USDT",
+        "FIO_USDT",
+        "ACS_USDT",
+        "ZRX_USDT",
+        ...
+    ]
+}
+```
+
+### 3. `GET` 183.249.84.29:8888/trades `获取成交记录`
+
+> request
+``` json
+{
+    "exchange": "binance_usdt_swap",        // 交易所,可以通过/exchanges查询当前支持的交易所
+    "symbol": "BTC_USDT",                   // 符号,可以通过/symbols查询支持的交易对
+    "start_time": "1715071080000",          // 查询开始时间戳
+    "end_time": "1715071081000"             // 查询结束时间戳
+}
+```
+
+> response
+``` json
+{
+    "msg": "查询成功",                       // 后台提醒
+    "query": {                              // 后台收到的查询参数,可用于debug
+        "end_time": 1715071081000,
+        "exchange": "binance_usdt_swap",
+        "start_time": 1715071080000,
+        "symbol": "BTC_USDT"
+    },
+    "data": [                               // 成交记录集合,时间越近的越靠前,按时间倒序排列
+        [
+            "1166925335888113665",          // id
+            "1713942601177",                // 数据生成时间戳
+            "5.839",                        // 交易数量,正数是买入
+            "66758.0"                       // 交易价格
+        ],
+        [
+            "1166925338362753129",          // id
+            "1713942601767",                // 数据生成时间戳
+            "-0.035",                       // 交易数量,负数是卖出
+            "66758.1"                       // 交易价格
+        ],
+        ...
+    ]
+}
+```
+
+### 4. `GET` 183.249.84.29:8888/records `获取k线记录`
+
+> request
+``` json
+{
+    "exchange": "binance_usdt_swap",        // 交易所,可以通过/exchanges查询当前支持的交易所
+    "symbol": "BTC_USDT",                   // 符号,可以通过/symbols查询支持的交易对
+    "start_time": "1715071080000",          // 查询开始时间戳
+    "end_time": "1715071081000"             // 查询结束时间戳
+}
+```
+
+> response
+``` json
+{
+    "msg": "查询成功",                       // 后台提醒
+    "query": {                              // 后台收到的查询参数,可用于debug
+        "end_time": 1715071081000,
+        "exchange": "binance_usdt_swap",
+        "start_time": 1715071080000,
+        "symbol": "BTC_USDT"
+    },
+    "data": [                               // K线记录集合,时间越近的越靠前,按时间倒序排列
+        {
+            "close": "66996.9",             // 收盘价
+            "high": "67000",                // 最高价
+            "low": "66957.1",               // 最低价
+            "open": "66964.7",              // 开盘价
+            "symbol": "BTC_USDT",           // 交易对
+            "time": "1713934800000",        // K线生成时间
+            "volume": "9212132.9615"        // 成交量,这个成交量是交易所原本成交量。有的交易所是本位币(交易对右值)的量,有的交易所是交易币(交易对左值)的量
+        },
+        {
+            "close": "66964.7",
+            "high": "67006.6",
+            "low": "66964.6",
+            "open": "66988.7",
+            "symbol": "BTC_USDT",
+            "time": "1713934740000",
+            "volume": "14842381.3785"
+        },
+        ...
+    ]
+}
+```