> For the complete documentation index, see [llms.txt](https://algomaster.gitbook.io/tcore-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://algomaster.gitbook.io/tcore-api/c++-regular-dll/wen-jian-shuo-ming.md).

# 使用说明文件

RTCTradeAPI和RTCQuoteAPI介面是基于C++类实现且仿CTP交易系统，支持下单、撤单、资金查询、持仓查询、委托查询、成交查询...等功能。

## 类库**文件说明**

| **文件名**              | **文件描述**     |
| -------------------- | ------------ |
| RTCTradeAPI.h        | 交易介面         |
| RTCQuoteAPI.h        | 报价介面         |
| RTCUserApiStruct.h   | 定义介面所需要的资料结构 |
| RTCUserApiDataType.h | 定义介面所需要的资料类型 |
| RTCErrorCode.h       | 回传的错误码讯息     |
| RTCQuoteAPI.dll      | 报价的lib       |
| RTCTradeAPI.dll      | 交易的lib       |

支援Microsoft Visual studio 2010开发环境

API包括两部分，[交易API(RTCTradeAPI)](/tcore-api/c++-regular-dll/rtctradeapi-functions.md)和[报价API(RTCQuoteAPI)](/tcore-api/c++-regular-dll/rtcquoteapi-functions.md)，交易API主要用来下单、删单、查询资金、查询持仓...等功能，报价API主要用来获取行情资讯。<br>

## 系统架构

### 系统架构

API介面会把查询、下单资讯送到TCore后会透过adapter送到交易所，后台返回的资料 adapter会送到TCore进行处理过后才会送到API介面

![](https://375314124-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MCuuPSmhXrpn_5hb_K8%2F-MENDDBCvU8UDY1LLNkf%2F-MENLpIRkorT3M0s6Wqc%2Fimage.png?alt=media\&token=10dbe25f-e3dd-4735-8f62-347b6fbd20c6)

### API内部架构

RTCTradeAPI和RTCQuoteAPI内部架构都是一样的，都有个callback执行绪在处理TCore的回 传资料，而客户端在接收每一个callback时建议自行维护一个​队列，以避免影响后续资料。

![](https://375314124-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-MCuuPSmhXrpn_5hb_K8%2F-MENDDBCvU8UDY1LLNkf%2F-MENLrnX1LfJbVlyFw-c%2Fimage.png?alt=media\&token=e5abe447-6d15-4502-8f8d-fb5e34095477)

## API界面开发规则

### 开发流程

![](https://lh4.googleusercontent.com/of9hNZIkrYeEByPV9j5_3LTM46Ts4QqxH4bsQB-bN_4uI0Ohr9m8y51vCEeGBp60OjyTVKLNDT5V_nL6lk7ectPsVP_Par6765KVDoJ8nfahHD3bzok5DQqk62YXxDcOXQSIpE1H)

1.在使用API​​功能前，请务必进行TCore连接RegisterFront()。&#x20;

2.请求和callback是在不同的执行绪，且收到callback时建议自行用到另一个执行绪中处理，以避免后面资料阻塞。&#x20;

3.每一个函数入参所需的结构强烈建议清空，以避免未知的数值出现。&#x20;

4.由于RTCTradeAPI和和RTCQuoteAPI是仿CTP，并不是每一个功能都有实现，而没有实现的功能API一律返回-1000，请依照下文内容中有说明的函数进行调用。&#x20;

5.使用查询类型函数时，参数结构如果带空则全查。&#x20;

6.交易和报价API必须要收到OnFrontConnected() callback才可做后续的功能。&#x20;

7.使用API​​前，务必启动咏春大师2量化版 客户端(TCore)

8.中文编码都采用UTF8

### API Spi介面

RTCTradeAPISpi和RTCQuoteAPISpi介面定义了事件通知，开发人员务必继承此类，编写对 应的事件处理。

### RequestID栏位&#x20;

由于查询资讯都是在不同的执行绪进行处理，介面定义了每次请求与回应资讯的唯一识别ID。

### 连接断开&#x20;

当与TCore连线断开时，OnFrontDisconnected() callback会通知客户端，该API并不会自动重 连。

### IsLast栏位&#x20;

在callback中，当资料有多笔的时候，读取此栏位可以得知是否是最后一笔资料。

### ICERspInfoField异常讯息结构

| ICERspInfoField |                        |
| --------------- | ---------------------- |
| ICEErrorIDType  | 错误码(请参考RTCErrorCode.h) |
| ICEErrorMsgType | 错误的讯息                  |

### API错误码（RTCErrorCode.h）

| 错误码   | 说明        |
| ----- | --------- |
| 0     | 正确        |
| -1000 | 不支援的API   |
| -1001 | 资料元件初始化失败 |
| -1002 | 取资料失败     |
| -1003 | 商品名称错误    |
| -1004 | 查询失败      |
