金仕达个股期权系统OTP_APIReference: KingstarAPI::CKSOTPTraderApi类参考

OTP_API Reference

KingstarAPI::CKSOTPTraderApi类参考

CKSOTPTraderApi接口是提供给用户使用的功能. 更多...

#include <KSOTPTraderApi.h>

公有成员

virtual void Release ()=0
virtual void Init ()=0
virtual const char * GetTradingDay ()=0
virtual void RegisterFront (char *pszFrontAddress)=0
virtual void RegisterSpi (CKSOTPTraderSpi *pSpi)=0
virtual void SubscribePrivateTopic (KSOTP_TE_RESUME_TYPE nResumeType)=0
virtual void SubscribePublicTopic (KSOTP_TE_RESUME_TYPE nResumeType)=0
virtual int ReqUserLogin (CKSOTPReqUserLoginField *pReqUserLoginField, int nRequestID)=0
virtual int ReqUserLogout (CKSOTPUserLogoutField *pUserLogout, int nRequestID)=0
virtual int ReqUserPasswordUpdate (CKSOTPUserPasswordUpdateField *pUserPasswordUpdate, int nRequestID)=0
virtual int ReqTradingAccountPasswordUpdate (CKSOTPTradingAccountPasswordUpdateField *pTradingAccountPasswordUpdate, int nRequestID)=0
virtual int ReqOrderInsert (CKSOTPInputOrderField *pInputOrder, int nRequestID)=0
virtual int ReqOrderAction (CKSOTPInputOrderActionField *pInputOrderAction, int nRequestID)=0
virtual int ReqQryOrder (CKSOTPQryOrderField *pQryOrder, int nRequestID)=0
virtual int ReqQryTrade (CKSOTPQryTradeField *pQryTrade, int nRequestID)=0
virtual int ReqQryInvestorPosition (CKSOTPQryInvestorPositionField *pQryInvestorPosition, int nRequestID)=0
virtual int ReqQryTradingAccount (CKSOTPQryTradingAccountField *pQryTradingAccount, int nRequestID)=0
virtual int ReqQryInvestor (CKSOTPQryInvestorField *pQryInvestor, int nRequestID)=0
virtual int ReqQryTradingCode (CKSOTPQryTradingCodeField *pQryTradingCode, int nRequestID)=0
virtual int ReqQryExchange (CKSOTPQryExchangeField *pQryExchange, int nRequestID)=0
virtual int ReqQryInstrument (CKSOTPQryInstrumentField *pQryInstrument, int nRequestID)=0
virtual int ReqQryInvestorPositionDetail (CKSOTPQryInvestorPositionDetailField *pQryInvestorPositionDetail, int nRequestID)=0
virtual int ReqQryTradingNotice (CKSOTPQryTradingNoticeField *pQryTradingNotice, int nRequestID)=0
virtual int ReqExecOrderInsert (CKSOTPInputExecOrderField *pInputExecOrder, int nRequestID)=0
virtual int ReqExecOrderAction (CKSOTPInputExecOrderActionField *pInputExecOrderAction, int nRequestID)=0
virtual int ReqLockInsert (CKSOTPInputLockField *pInputLock, int nRequestID)=0
virtual int ReqQryExecOrder (CKSOTPQryExecOrderField *pQryExecOrder, int nRequestID)=0
virtual int ReqQryExecOrderVolume (CKSOTPQryExecOrderVolumeField *pQryExecOrderVolume, int nRequestID)=0
virtual int ReqQryLock (CKSOTPQryLockField *pQryLock, int nRequestID)=0
virtual int ReqQryLockPosition (CKSOTPQryLockPositionField *pQryLockPosition, int nRequestID)=0
virtual int ReqQryUnderlyingStockInfo (CKSOTPQryUnderlyingStockInfoField *pQryOTPOrderParams, int nRequestID)=0
virtual int ReqQryOTPInsCommRate (CKSOTPQryOTPInsCommRateField *pQryOTPInsCommRate, int nRequestID)=0
virtual int ReqQryInstrumentMarginRate (CKSOTPQryInstrumentMarginRateField *pQryInstrumentMarginRate, int nRequestID)=0
virtual int ReqQryOTPAssignment (CKSOTPQryOTPAssignmentField *pQryOTPAssignment, int nRequestID)=0
virtual int ReqQryDepthMarketData (CKSOTPQryDepthMarketDataField *pQryOTPDepthMarketData, int nRequestID)=0
virtual int ReqFromBankToStockByStock (CKSOTPReqTransferField *pReqTransfer, int nRequestID)=0
virtual int ReqFromStockToBankByStock (CKSOTPReqTransferField *pReqTransfer, int nRequestID)=0
virtual int ReqQryContractBank (CKSOTPQryContractBankField *pQryContractBank, int nRequestID)=0
virtual int ReqQueryBankAccountMoneyByStock (CKSOTPReqQueryAccountField *pReqQueryAccount, int nRequestID)=0
virtual int ReqQryTransferSerial (CKSOTPQryTransferSerialField *pQryTransferSerial, int nRequestID)=0
virtual int ReqQrySettlementInfoConfirm (CKSOTPQrySettlementInfoConfirmField *pQrySettlementInfoConfirm, int nRequestID)=0
virtual int ReqSettlementInfoConfirm (CKSOTPSettlementInfoConfirmField *pSettlementInfoConfirm, int nRequestID)=0
virtual int ReqQrySettlementInfo (CKSOTPQrySettlementInfoField *pQrySettlementInfo, int nRequestID)=0
virtual int ReqQryInvestorTradeLevel (CKSOTPQryInvestorTradeLevelField *pQryInvestorTradeLevel, int nRequestID)=0
virtual int ReqQryPurchaseLimitAmt (CKSOTPQryPurchaseLimitAmtField *pQryPurchaseLimitAmt, int nRequestID)=0
virtual int ReqQryPositionLimitVol (CKSOTPQryPositionLimitVolField *pQryPositionLimitVol, int nRequestID)=0
virtual int ReqQryHistoryOrder (CKSOTPQryHistoryOrderField *pQryHistoryOrder, int nRequestID)=0
virtual int ReqQryHistoryTrade (CKSOTPQryHistoryTradeField *pQryHistoryTrade, int nRequestID)=0
virtual int ReqQryHistoryAssignment (CKSOTPQryHistoryAssignmentField *pQryHistoryAssignment, int nRequestID)=0
virtual int ReqQryDelivDetail (CKSOTPQryDelivDetailField *pQryDelivDetail, int nRequestID)=0
virtual int ReqAutoExecOrderAction (CKSOTPAutoExecOrderActionField *pAutoExecOrderAction, int nRequestID)=0

静态公有成员

static CKSOTPTraderApiCreateOTPTraderApi (const char *pszFlowPath="")

保护成员

 ~CKSOTPTraderApi ()

详细描述

CKSOTPTraderApi接口是提供给用户使用的功能.

示例:

testKSOTPTraderApi.cpp.


构造及析构函数文档

KingstarAPI::CKSOTPTraderApi::~CKSOTPTraderApi ( ) [inline, protected]
{};

成员函数文档

static CKSOTPTraderApi* KingstarAPI::CKSOTPTraderApi::CreateOTPTraderApi ( const char *  pszFlowPath = "") [static]

创建TraderApi

返回:
创建出的UserApi
参数:
pszFlowPath存贮信息文件的目录,默认为当前目录.
评论:
客户端应用程序使用此函数来创造一个“CKSOTPTraderApi”实例.注意:创造实例时不要使用“new”.
virtual void KingstarAPI::CKSOTPTraderApi::Release ( ) [pure virtual]

删除接口对象本身

评论:
不再使用本接口对象时,调用该函数删除接口对象,不能使用 delete 方法.
示例:
testKSOTPTraderApi.cpp.
virtual void KingstarAPI::CKSOTPTraderApi::Init ( ) [pure virtual]

初始化

评论:
初始化运行环境,只有调用后,接口才开始工作.
示例:
testKSOTPTraderApi.cpp.
virtual const char* KingstarAPI::CKSOTPTraderApi::GetTradingDay ( ) [pure virtual]

获取当前交易日

返回:
获取到的交易日
评论:
只有登录成功后,才能得到正确的交易日.
virtual void KingstarAPI::CKSOTPTraderApi::RegisterFront ( char *  pszFrontAddress) [pure virtual]

注册前置机网络地址

参数:
pszFrontAddress:前置机网络地址.
评论:
网络地址的格式为:“protocol://ipaddress:port”,如:”tcp://127.0.0.1:17001”.
“tcp”代表传输协议,“127.0.0.1”代表服务器地址.”17001”代表服务器端口号.
同时API也提供了对代理服务器的支持,包括 socks4、socks5及 http,客户端开发时只需通过传递给API不同的连接字符串就可实现,例如 "socks5://127.0.0.1:17993 /user:[email protected]:18993".
设置交易托管系统的网络通讯地址,Kingstar服务器拥有多个通信地址,但用户只需要选择一个通信地址.客户端RegisterFront多次时,使用第一个有效的通信地址.
示例:
testKSOTPTraderApi.cpp.
virtual void KingstarAPI::CKSOTPTraderApi::RegisterSpi ( CKSOTPTraderSpi pSpi) [pure virtual]

注册回调接口

参数:
pSpi派生自回调接口类的实例.
示例:
testKSOTPTraderApi.cpp.
virtual void KingstarAPI::CKSOTPTraderApi::SubscribePrivateTopic ( KSOTP_TE_RESUME_TYPE  nResumeType) [pure virtual]

订阅私有流.

参数:
nResumeType私有流重传方式: THOST_TERT_RESTART:从本交易日开始重传; THOST_TERT_RESUME:从上次收到的续传; THOST_TERT_QUICK:只传送登录后私有流的内容.
评论:
该方法要在Init方法前调用.若不调用则不会收到私有流的数据.
示例:
testKSOTPTraderApi.cpp.
virtual void KingstarAPI::CKSOTPTraderApi::SubscribePublicTopic ( KSOTP_TE_RESUME_TYPE  nResumeType) [pure virtual]

订阅公共流.

参数:
nResumeType公共流重传方式: THOST_TERT_RESTART:从本交易日开始重传; THOST_TERT_RESUME:从上次收到的续传; THOST_TERT_QUICK:只传送登录后公共流的内容.
评论:
该方法要在Init方法前调用.若不调用则不会收到公共流的数据.
示例:
testKSOTPTraderApi.cpp.
virtual int KingstarAPI::CKSOTPTraderApi::ReqUserLogin ( CKSOTPReqUserLoginField pReqUserLoginField,
int  nRequestID 
) [pure virtual]

用户登录请求

参数:
pReqUserLoginField指向用户登录请求结构的地址.
nRequestID用户登录请求的 ID,该 ID 由用户指定、管理.
返回:
返回值: 0 代表成功; -1 表示网络连接失败; -2 表示未处理请求超过许可数; -3 表示每秒发送请求数超过许可数.
virtual int KingstarAPI::CKSOTPTraderApi::ReqUserLogout ( CKSOTPUserLogoutField pUserLogout,
int  nRequestID 
) [pure virtual]

登出请求

参数:
pReqUserLogout指向用户登出请求结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqUserPasswordUpdate ( CKSOTPUserPasswordUpdateField pUserPasswordUpdate,
int  nRequestID 
) [pure virtual]

用户口令更新请求

参数:
pUserPasswordUpdate指向用户口令修改结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqTradingAccountPasswordUpdate ( CKSOTPTradingAccountPasswordUpdateField pTradingAccountPasswordUpdate,
int  nRequestID 
) [pure virtual]

资金账户口令更新请求

参数:
pTradingAccountPasswordUpdate指向资金账户口令修改结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqOrderInsert ( CKSOTPInputOrderField pInputOrder,
int  nRequestID 
) [pure virtual]

报单录入请求

参数:
pInputOrder指向录入报单结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqOrderAction ( CKSOTPInputOrderActionField pInputOrderAction,
int  nRequestID 
) [pure virtual]

报单操作请求

参数:
pInputOrderAction指向报单操作结构的地址.
评论:
客户端发出报单撤销请求.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryOrder ( CKSOTPQryOrderField pQryOrder,
int  nRequestID 
) [pure virtual]

请求查询报单

参数:
pQryOrder指向报单查询结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryTrade ( CKSOTPQryTradeField pQryTrade,
int  nRequestID 
) [pure virtual]

请求查询成交

参数:
pQryTrade指向成交查询结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryInvestorPosition ( CKSOTPQryInvestorPositionField pQryInvestorPosition,
int  nRequestID 
) [pure virtual]

请求查询投资者持仓

参数:
pQryInvestorPosition指向会员持仓查询结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryTradingAccount ( CKSOTPQryTradingAccountField pQryTradingAccount,
int  nRequestID 
) [pure virtual]

请求查询资金账户

参数:
pQryTradingAccount指向查询资金账户结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryInvestor ( CKSOTPQryInvestorField pQryInvestor,
int  nRequestID 
) [pure virtual]

请求查询投资者

参数:
pQryInvestor指向查询投资者结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryTradingCode ( CKSOTPQryTradingCodeField pQryTradingCode,
int  nRequestID 
) [pure virtual]

请求查询合约账号

参数:
pQryTradingCode指向查询合约账号结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryExchange ( CKSOTPQryExchangeField pQryExchange,
int  nRequestID 
) [pure virtual]

请求查询交易所

参数:
pQryExchange指向查询交易所结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryInstrument ( CKSOTPQryInstrumentField pQryInstrument,
int  nRequestID 
) [pure virtual]

请求查询合约

参数:
pQryInstrument指向查询查询合约结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryInvestorPositionDetail ( CKSOTPQryInvestorPositionDetailField pQryInvestorPositionDetail,
int  nRequestID 
) [pure virtual]

请求查询投资者持仓明细

参数:
pQryInvestorPositionDetail指向查询投资者持仓明细结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryTradingNotice ( CKSOTPQryTradingNoticeField pQryTradingNotice,
int  nRequestID 
) [pure virtual]

请求查询交易通知

参数:
pQryTradingNotice指向查询客户通知结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqExecOrderInsert ( CKSOTPInputExecOrderField pInputExecOrder,
int  nRequestID 
) [pure virtual]

执行宣告录入请求

参数:
pInputExecOrder指向非交易报单执行及放弃结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqExecOrderAction ( CKSOTPInputExecOrderActionField pInputExecOrderAction,
int  nRequestID 
) [pure virtual]

执行宣告操作请求

参数:
pInputExecOrderAction指向行权单撤销结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqLockInsert ( CKSOTPInputLockField pInputLock,
int  nRequestID 
) [pure virtual]

锁定请求

参数:
pInputLock指向非交易报单锁定及解锁结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryExecOrder ( CKSOTPQryExecOrderField pQryExecOrder,
int  nRequestID 
) [pure virtual]

请求查询执行宣告

参数:
pQryExecOrder指向执行宣告查询结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryExecOrderVolume ( CKSOTPQryExecOrderVolumeField pQryExecOrderVolume,
int  nRequestID 
) [pure virtual]

查询宣告数量请求

参数:
pQryExecOrderVolume指向宣告数量查询结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryLock ( CKSOTPQryLockField pQryLock,
int  nRequestID 
) [pure virtual]

请求查询锁定

参数:
pQryLock指向锁定查询结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryLockPosition ( CKSOTPQryLockPositionField pQryLockPosition,
int  nRequestID 
) [pure virtual]

请求查询锁定证券仓位

参数:
pQryLockPosition指向锁定证券仓位查询结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryUnderlyingStockInfo ( CKSOTPQryUnderlyingStockInfoField pQryOTPOrderParams,
int  nRequestID 
) [pure virtual]

查询标的券信息请求

参数:
pQryOTPOrderParams指向标的券信息查询结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryOTPInsCommRate ( CKSOTPQryOTPInsCommRateField pQryOTPInsCommRate,
int  nRequestID 
) [pure virtual]

查询个股期权手续费率请求

参数:
pQryOTPInsCommRate指向个股期权手续费查询结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryInstrumentMarginRate ( CKSOTPQryInstrumentMarginRateField pQryInstrumentMarginRate,
int  nRequestID 
) [pure virtual]

查询个股期权保证金率请求

参数:
pQryInstrumentMarginRate指向个股期权保证金率查询结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryOTPAssignment ( CKSOTPQryOTPAssignmentField pQryOTPAssignment,
int  nRequestID 
) [pure virtual]

查询个股行权指派信息

参数:
pQryOTPAssignment指向个股行权指派结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryDepthMarketData ( CKSOTPQryDepthMarketDataField pQryOTPDepthMarketData,
int  nRequestID 
) [pure virtual]

请求查询行情

参数:
pQryDepthMarketData指向行情查询结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqFromBankToStockByStock ( CKSOTPReqTransferField pReqTransfer,
int  nRequestID 
) [pure virtual]

银行资金转个股请求

参数:
pReqTransfer指向转账查询请求结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqFromStockToBankByStock ( CKSOTPReqTransferField pReqTransfer,
int  nRequestID 
) [pure virtual]

证券资金转银行请求

参数:
pReqTransfer指向转账查询请求结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryContractBank ( CKSOTPQryContractBankField pQryContractBank,
int  nRequestID 
) [pure virtual]

请求查询签约银行

参数:
pQryContractBank指向签约银行查询请求结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQueryBankAccountMoneyByStock ( CKSOTPReqQueryAccountField pReqQueryAccount,
int  nRequestID 
) [pure virtual]

查询银行余额请求

参数:
pReqQueryAccount指向账户信息查询请求结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryTransferSerial ( CKSOTPQryTransferSerialField pQryTransferSerial,
int  nRequestID 
) [pure virtual]

请求查询转帐流水

参数:
pQryTransferSerial指向转帐流水查询请求结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQrySettlementInfoConfirm ( CKSOTPQrySettlementInfoConfirmField pQrySettlementInfoConfirm,
int  nRequestID 
) [pure virtual]

请求查询结算信息确认

参数:
pQrySettlementInfoConfirm指向结算信息确认查询请求结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqSettlementInfoConfirm ( CKSOTPSettlementInfoConfirmField pSettlementInfoConfirm,
int  nRequestID 
) [pure virtual]

投资者结算结果确认

参数:
pSettlementInfoConfirm指向投资者结算结果确认查询请求结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQrySettlementInfo ( CKSOTPQrySettlementInfoField pQrySettlementInfo,
int  nRequestID 
) [pure virtual]

请求查询投资者结算结果

参数:
pSettlementInfo指向投资者结算结果查询请求结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryInvestorTradeLevel ( CKSOTPQryInvestorTradeLevelField pQryInvestorTradeLevel,
int  nRequestID 
) [pure virtual]

查询客户交易级别

参数:
pQryInvestorTradeLevel指向客户交易级别查询请求结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryPurchaseLimitAmt ( CKSOTPQryPurchaseLimitAmtField pQryPurchaseLimitAmt,
int  nRequestID 
) [pure virtual]

查询个股限购额度

参数:
pQryPurchaseLimitAmt指向个股限购额度查询请求结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryPositionLimitVol ( CKSOTPQryPositionLimitVolField pQryPositionLimitVol,
int  nRequestID 
) [pure virtual]

查询个股限仓额度

参数:
pQryPositionLimitVol指向个股限仓额度查询请求结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryHistoryOrder ( CKSOTPQryHistoryOrderField pQryHistoryOrder,
int  nRequestID 
) [pure virtual]

请求查询历史报单

参数:
pQryHistoryOrder指向历史报单查询请求结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryHistoryTrade ( CKSOTPQryHistoryTradeField pQryHistoryTrade,
int  nRequestID 
) [pure virtual]

请求查询历史成交

参数:
pQryHistoryTrade指向历史成交查询请求结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryHistoryAssignment ( CKSOTPQryHistoryAssignmentField pQryHistoryAssignment,
int  nRequestID 
) [pure virtual]

请求查询历史行权指派明细

参数:
pQryHistoryAssignment指向查询行权指派明细请求结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqQryDelivDetail ( CKSOTPQryDelivDetailField pQryDelivDetail,
int  nRequestID 
) [pure virtual]

请求查询行权交割明细

参数:
pQryDelivDetail指向查询行权交割明细请求结构的地址.
virtual int KingstarAPI::CKSOTPTraderApi::ReqAutoExecOrderAction ( CKSOTPAutoExecOrderActionField pAutoExecOrderAction,
int  nRequestID 
) [pure virtual]

自动行权执行操作

参数:
pAutoExecOrderAction指向自动行权执行操作请求结构的地址.

该类的文档由以下文件生成:
  • KSOTPTraderApi.h