|
2 | 2 | [](https://search.maven.org/search?q=g:%22org.rationalityfrontline.ktrader%22%20AND%20a:%22ktrader-broker-api%22) |
3 | 3 | [](https://github.com/ktrader-tech/ktrader-broker-api/blob/master/LICENSE) |
4 | 4 |
|
5 | | -[KTrader](https://github.com/ktrader-tech/ktrader) 量化交易系统的 Broker 统一接口。 |
6 | | -> 该项目不依赖于 KTrader 的任何其它项目,可以独立使用。 |
| 5 | +[KTrader 量化交易系统的](https://github.com/ktrader-tech/ktrader) Broker 统一接口。 |
| 6 | +> 虽然该项目是为 KTrader 量化交易系统而开发的,但也可以脱离 KTrader 独立使用 |
7 | 7 |
|
8 | 8 | ## 目标 |
9 | | -以统一的方式调用各种交易 API,屏蔽不同 API 的具体调用细节,减少心智负担,降低开发成本,提高开发效率。 |
| 9 | +以统一的方式调用各种交易 API,屏蔽不同 API 的具体调用细节,减少心智负担,提高开发效率。 |
10 | 10 | > 目前主要针对中国国内市场(CTP & XTP) |
11 | 11 |
|
12 | | -## 使用说明 |
13 | | -该接口在设计上支持 2 种不同的使用方式:类库,插件。作为类库,直接添加依赖并使用即可。作为插件,会生成一个 ZIP 格式的压缩包插件,然后可以在运行时动态加载或卸载该插件,关于插件化技术请参考 [PF4J](https://github.com/pf4j/pf4j) 。 |
14 | | - |
15 | | -要实现该接口,需要继承并实现 [BrokerApi](https://github.com/ktrader-tech/ktrader-broker-api/blob/master/lib/src/main/kotlin/org/rationalityfrontline/ktrader/broker/api/BrokerApi.kt) 抽象类,并通过其成员属性 kEvent |
16 | | -将各种推送事件(如 Tick,订单回报,成交回报等)发出。如果需要支持插件的使用方式,那么还需要继承并实现 [Broker](https://github.com/ktrader-tech/ktrader-broker-api/blob/master/lib/src/main/kotlin/org/rationalityfrontline/ktrader/broker/api/Broker.kt) 抽象类。 |
17 | | -> [KEvent](https://github.com/RationalityFrontline/kevent) 是一个基于 [Kotlin 协程](https://github.com/Kotlin/kotlinx.coroutines) 实现的强大的事件订阅发布类库。关于可推送的事件类型及事件数据,参见 [BrokerEvent.kt](https://github.com/ktrader-tech/ktrader-broker-api/blob/master/lib/src/main/kotlin/org/rationalityfrontline/ktrader/broker/api/BrokerEvent.kt) 。 |
18 | | -
|
19 | | -## 已有的接口实现 |
20 | | -* [KTrader-Broker-CTP](https://github.com/ktrader-tech/ktrader-broker-ctp) CTP 实现(中国期货 & 期权) |
21 | | - |
22 | 12 | ## 接口速览 |
23 | 13 | 带有文档注释的全内容版本参见 [BrokerApi.kt](https://github.com/ktrader-tech/ktrader-broker-api/blob/master/lib/src/main/kotlin/org/rationalityfrontline/ktrader/broker/api/BrokerApi.kt) 。 |
24 | 14 | ```kotlin |
@@ -63,6 +53,16 @@ abstract class BrokerApi(val config: Map<String, Any>, val kEvent: KEvent) { |
63 | 53 | } |
64 | 54 | ``` |
65 | 55 |
|
| 56 | +## 使用说明 |
| 57 | +该接口在设计上支持 2 种不同的使用方式:类库,插件。作为类库,直接添加依赖并使用即可。作为插件,会生成一个 ZIP 格式的压缩包插件,然后可以在运行时动态加载或卸载该插件,关于插件化技术请参考 [PF4J](https://github.com/pf4j/pf4j) 。 |
| 58 | + |
| 59 | +要实现该接口,需要继承并实现 [BrokerApi](https://github.com/ktrader-tech/ktrader-broker-api/blob/master/lib/src/main/kotlin/org/rationalityfrontline/ktrader/broker/api/BrokerApi.kt) 抽象类,并通过其成员属性 kEvent |
| 60 | +将各种推送事件(如 Tick,订单回报,成交回报等)发出。如果需要支持插件的使用方式,那么还需要继承并实现 [Broker](https://github.com/ktrader-tech/ktrader-broker-api/blob/master/lib/src/main/kotlin/org/rationalityfrontline/ktrader/broker/api/Broker.kt) 抽象类。 |
| 61 | +> [KEvent](https://github.com/RationalityFrontline/kevent) 是一个基于 [Kotlin 协程](https://github.com/Kotlin/kotlinx.coroutines) 实现的强大的事件订阅发布类库。关于可推送的事件类型及事件数据,参见 [BrokerEvent.kt](https://github.com/ktrader-tech/ktrader-broker-api/blob/master/lib/src/main/kotlin/org/rationalityfrontline/ktrader/broker/api/BrokerEvent.kt) 。 |
| 62 | +
|
| 63 | +## 已有的接口实现 |
| 64 | +* [KTrader-Broker-CTP](https://github.com/ktrader-tech/ktrader-broker-ctp) CTP 实现(中国期货 & 期权) |
| 65 | + |
66 | 66 | ## Download |
67 | 67 |
|
68 | 68 | **Gradle:** |
|
0 commit comments