版本 1.1.0

更改所有 Instrument 为 Security
update README

Author: RationalityFrontline

README.md

@@ -2,15 +2,15 @@
 [![Maven Central](https://img.shields.io/maven-central/v/org.rationalityfrontline.ktrader/ktrader-broker-api.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22org.rationalityfrontline.ktrader%22%20AND%20a:%22ktrader-broker-api%22)
 [![Apache License 2.0](https://img.shields.io/github/license/ktrader-tech/ktrader-broker-api)](https://github.com/ktrader-tech/ktrader-broker-api/blob/master/LICENSE)
 
-[KTrader](https://github.com/ktrader-tech/ktrader) 量化交易平台的 Broker 统一接口。
+[KTrader](https://github.com/ktrader-tech/ktrader) 量化交易系统的 Broker 统一接口。
 > 该项目不依赖于 KTrader 的任何其它项目，可以独立使用。
 
 ## 目标
 以统一的方式调用各种交易 API，屏蔽不同 API 的具体调用细节，减少心智负担，降低开发成本，提高开发效率。
 > 目前主要针对中国国内市场（CTP & XTP）
 
 ## 使用说明
-该接口在设计上支持2种不同的使用方式：类库，插件。作为类库，直接添加依赖并使用即可。作为插件，会生成一个 ZIP 格式的压缩包插件，然后可以在运行时动态加载或卸载该插件，关于插件化技术请参考 [PF4J](https://github.com/pf4j/pf4j) 。
+该接口在设计上支持 2 种不同的使用方式：类库，插件。作为类库，直接添加依赖并使用即可。作为插件，会生成一个 ZIP 格式的压缩包插件，然后可以在运行时动态加载或卸载该插件，关于插件化技术请参考 [PF4J](https://github.com/pf4j/pf4j) 。
 
 要实现该接口，需要继承并实现 [BrokerApi](https://github.com/ktrader-tech/ktrader-broker-api/blob/master/lib/src/main/kotlin/org/rationalityfrontline/ktrader/broker/api/BrokerApi.kt) 抽象类，并通过其成员属性 kEvent
 将各种推送事件（如 Tick，订单回报，成交回报等）发出。如果需要支持插件的使用方式，那么还需要继承并实现 [Broker](https://github.com/ktrader-tech/ktrader-broker-api/blob/master/lib/src/main/kotlin/org/rationalityfrontline/ktrader/broker/api/Broker.kt) 抽象类。
@@ -19,6 +19,30 @@
 ## 已有的接口实现
 * [KTrader-Broker-CTP](https://github.com/ktrader-tech/ktrader-broker-ctp) CTP 实现（中国期货 & 期权）
 
+## Download
+
+**Gradle:**
+
+```kotlin
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation("org.rationalityfrontline.ktrader:ktrader-broker-api:1.1.0")
+}
+```
+
+**Maven:**
+
+```xml
+<dependency>
+    <groupId>org.rationalityfrontline.ktrader</groupId>
+    <artifactId>ktrader-broker-api</artifactId>
+    <version>1.1.0</version>
+</dependency>
+```
+
 ## License
 
 Ktrader-Broker-API is released under the [Apache 2.0 license](https://github.com/ktrader-tech/ktrader-broker-api/blob/master/LICENSE).

lib/build.gradle.kts

@@ -8,7 +8,7 @@ plugins {
 }
 
 group = "org.rationalityfrontline.ktrader"
-version = "1.0.0"
+version = "1.1.0"
 val NAME = "ktrader-broker-api"
 val DESC = "KTrader Broker API"
 val GITHUB_REPO = "ktrader-tech/ktrader-broker-api"

lib/module.md

@@ -1,3 +1,3 @@
 # Module KTrader-Broker-API
 
-[KTrader](https://github.com/ktrader-tech/ktrader) 量化交易平台的 Broker 统一接口
+[KTrader](https://github.com/ktrader-tech/ktrader) 量化交易系统的 Broker 统一接口

lib/src/main/kotlin/org/rationalityfrontline/ktrader/broker/api/BrokerApi.kt

@@ -66,14 +66,14 @@ abstract class BrokerApi(val config: Map<String, Any>, val kEvent: KEvent) {
 
     /**
      * 批量订阅行情
-     * @param codes 要订阅的标的代码集合
+     * @param codes 要订阅的证券代码集合
      * @param extras 额外的参数，默认为 null
      */
     abstract suspend fun subscribeMarketData(codes: Collection<String>, extras: Map<String, Any>? = null)
 
     /**
-     * 订阅单个标的行情
-     * @param code 要订阅的标的代码
+     * 订阅单个证券行情
+     * @param code 要订阅的证券代码
      * @param extras 额外的参数，默认为 null
      */
     open suspend fun subscribeMarketData(code: String, extras: Map<String, Any>? = null) {
@@ -82,22 +82,22 @@ abstract class BrokerApi(val config: Map<String, Any>, val kEvent: KEvent) {
 
     /**
      * 批量取消订阅行情
-     * @param codes 要取消订阅的标的代码集合
+     * @param codes 要取消订阅的证券代码集合
      * @param extras 额外的参数，默认为 null
      */
     abstract suspend fun unsubscribeMarketData(codes: Collection<String>, extras: Map<String, Any>? = null)
 
     /**
-     * 取消订阅单个标的行情
-     * @param code 要取消订阅的标的代码
+     * 取消订阅单个证券行情
+     * @param code 要取消订阅的证券代码
      * @param extras 额外的参数，默认为 null
      */
     open suspend fun unsubscribeMarketData(code: String, extras: Map<String, Any>? = null) {
         unsubscribeMarketData(listOf(code), extras)
     }
 
     /**
-     * 订阅全市场标的行情
+     * 订阅全市场证券行情
      * @param extras 额外的参数，默认为 null
      */
     abstract suspend fun subscribeAllMarketData(extras: Map<String, Any>? = null)
@@ -109,7 +109,7 @@ abstract class BrokerApi(val config: Map<String, Any>, val kEvent: KEvent) {
     abstract suspend fun unsubscribeAllMarketData(extras: Map<String, Any>? = null)
 
     /**
-     * 查询当前已订阅的标的
+     * 查询当前已订阅的证券
      * @param useCache 是否优先查询本地维护的缓存信息，默认为 true
      * @param extras 额外的参数，默认为 null
      */
@@ -124,19 +124,19 @@ abstract class BrokerApi(val config: Map<String, Any>, val kEvent: KEvent) {
     abstract suspend fun queryLastTick(code: String, useCache: Boolean = true, extras: Map<String, Any>? = null): Tick?
 
     /**
-     * 查询 [code] 的相关信息
+     * 查询 [code] 的证券信息
      * @param useCache 是否优先查询本地维护的缓存信息，默认为 true
      * @param extras 额外的参数，默认为 null
-     * @return 查询到的 [Instrument]，如果未查询到，返回 null
+     * @return 查询到的 [Security]，如果未查询到，返回 null
      */
-    abstract suspend fun queryInstrument(code: String, useCache: Boolean = true, extras: Map<String, Any>? = null): Instrument?
+    abstract suspend fun querySecurity(code: String, useCache: Boolean = true, extras: Map<String, Any>? = null): Security?
 
     /**
-     * 查询全市场标的的信息
+     * 查询全市场证券的信息
      * @param useCache 是否优先查询本地维护的缓存信息，默认为 true
      * @param extras 额外的参数，默认为 null
      */
-    abstract suspend fun queryAllInstruments(useCache: Boolean = true, extras: Map<String, Any>? = null): List<Instrument>
+    abstract suspend fun queryAllSecurities(useCache: Boolean = true, extras: Map<String, Any>? = null): List<Security>
 
     /**
      * 查询资金账户的资产
@@ -199,7 +199,7 @@ abstract class BrokerApi(val config: Map<String, Any>, val kEvent: KEvent) {
 
     /**
      * 下单
-     * @param code 标的代码
+     * @param code 证券代码
      * @param price 下单价格
      * @param volume 下单数量
      * @param direction 交易方向（做多/做空）
@@ -231,7 +231,7 @@ abstract class BrokerApi(val config: Map<String, Any>, val kEvent: KEvent) {
 
     /**
      * 准备费用计算（保证金/手续费）
-     * @param codes 要准备的标的
+     * @param codes 要准备计算的证券代码
      * @param extras 额外的参数，默认为 null
      */
     open suspend fun prepareFeeCalculation(codes: Collection<String>? = null, extras: Map<String, Any>? = null) {}

lib/src/main/kotlin/org/rationalityfrontline/ktrader/broker/api/constants.kt

@@ -1,9 +1,9 @@
 package org.rationalityfrontline.ktrader.broker.api
 
 /**
- * 标的类型
+ * 证券类型
  */
-enum class InstrumentType {
+enum class SecurityType {
 
     /**
      * 未知

lib/src/main/kotlin/org/rationalityfrontline/ktrader/broker/api/entities.kt

@@ -5,7 +5,7 @@ import java.time.LocalDateTime
 
 /**
  * Tick
- * @param code 标的代码
+ * @param code 证券代码
  * @param time 产生时间
  * @param lastPrice 最新价
  * @param bidPrice 挂买价（买一，买二，买三 ...）
@@ -16,7 +16,7 @@ import java.time.LocalDateTime
  * @param turnover Tick 内的成交额
  * @param openInterest Tick 内的持仓量变动
  * @param direction Tick 的方向
- * @param status 标的当前的市场状态
+ * @param status 证券当前的市场状态
  * @param preClosePrice 昨日收盘价
  * @param preSettlementPrice 昨日结算价
  * @param preOpenInterest 昨日持仓量
@@ -67,7 +67,7 @@ data class Tick(
  * Order
  * @param accountId 资金账号
  * @param orderId 订单 ID
- * @param code 标的代码
+ * @param code 证券代码
  * @param price 订单价格
  * @param volume 订单数量
  * @param direction 订单交易方向
@@ -110,7 +110,7 @@ data class Order(
  * @param accountId 资金账号
  * @param tradeId 成交记录 ID
  * @param orderId 对应的订单 ID
- * @param code 标的代码
+ * @param code 证券代码
  * @param price 成交价
  * @param volume 成交量
  * @param turnover 成交额（期货/期权是成交价*成交量*合约乘数）
@@ -137,11 +137,11 @@ data class Trade(
 
 /**
  * 期货/期权保证金率
- * @param code 标的代码
- * @param longMarginRatioByMoney 多头保证金率（按金额）。当标的为期权时表示期权固定保证金
- * @param longMarginRatioByVolume 多头保证金（按手数）。当标的为期权时表示期权交易所固定保证金
- * @param shortMarginRatioByMoney 空头保证金率（按金额）。当标的为期权时表示期权最小保证金
- * @param shortMarginRatioByVolume 空头保证金（按手数）。当标的为期权时表示期权交易所最小保证金
+ * @param code 证券代码
+ * @param longMarginRatioByMoney 多头保证金率（按金额）。当证券为期权时表示期权固定保证金
+ * @param longMarginRatioByVolume 多头保证金（按手数）。当证券为期权时表示期权交易所固定保证金
+ * @param shortMarginRatioByMoney 空头保证金率（按金额）。当证券为期权时表示期权最小保证金
+ * @param shortMarginRatioByVolume 空头保证金（按手数）。当证券为期权时表示期权交易所最小保证金
  * @param extras 额外数据
  */
 data class MarginRate(
@@ -155,7 +155,7 @@ data class MarginRate(
 
 /**
  * 手续费率
- * @param code 标的代码
+ * @param code 证券代码
  * @param openRatioByMoney 开仓手续费率（按成交额）
  * @param openRatioByVolume 开仓手续费（按手数）
  * @param closeRatioByMoney 平仓手续费率（按成交额）
@@ -188,11 +188,11 @@ data class CommissionRate(
 )
 
 /**
- * 标的信息
- * @param code 标的代码
- * @param type 标的类型
- * @param productId 标的产品 ID （仅期货/期权）
- * @param name 标的名称
+ * 证券信息
+ * @param code 证券代码
+ * @param type 证券类型
+ * @param productId 证券的产品 ID （仅期货/期权）
+ * @param name 证券名称
  * @param priceTick 最小变动价格
  * @param isTrading 是否处于可交易状态
  * @param openDate 上市日
@@ -203,13 +203,13 @@ data class CommissionRate(
  * @param marginRate 保证金率
  * @param commissionRate 手续费率
  * @param optionsType 期权类型
- * @param optionsUnderlyingCode 期权对应的基础标的代码
+ * @param optionsUnderlyingCode 期权对应的基础证券代码
  * @param optionsStrikePrice 期权行权价格
  * @param extras 额外数据
  */
-data class Instrument(
+data class Security(
     val code: String,
-    val type: InstrumentType,
+    val type: SecurityType,
     val productId: String = "",
     val name: String,
     val priceTick: Double,
@@ -250,7 +250,7 @@ data class Assets(
 /**
  * 持仓信息
  * @param accountId 资金账号
- * @param code 标的代码
+ * @param code 证券代码
  * @param direction 持仓方向
  * @param preVolume 昨日持仓量
  * @param volume 今日持仓量