![\"kuaiqi](\"./img/logo.png\"){kind=logo}
\n \n\n \n \n \n
\n \n ![\"js-standard-style\"](\"https://img.shields.io/badge/code%20style-standard-brightgreen.svg\"){kind=icon}
\n \n \n ![\"Downloads\"](\"https://img.shields.io/npm/dw/tqsdk.svg\")
\n \n \n ![\"Version\"](\"https://img.shields.io/npm/v/tqsdk.svg\")
\n \n \n ![\"License\"](\"https://img.shields.io/npm/l/tqsdk.svg\")
\n \n
EventEmitter ⏏\n**Kind**: Exported class \n**Extends**: EventEmitter \n**Emits**: [ready](#TQSDK+event_ready), [rtn\\_data](#TQSDK+event_rtn_data), [rtn\\_brokers](#TQSDK+event_rtn_brokers), [notify](#TQSDK+event_notify), [error](#TQSDK+event_error) \n\n* * *\n\n\n\n##### new Tqsdk([opts], [wsOption])\n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| [opts] | object | {} | 描述 TQSDK 构造参数 |\n| [opts.symbolsServerUrl] | string | "https://openmd.shinnytech.com/t/md/symbols/latest_slim.json" | 合约服务地址 |\n| [opts.wsQuoteUrl] | string | "wss://openmd.shinnytech.com/t/md/front/mobile" | 行情连接地址 |\n| [opts.autoInit] | boolean | true | TQSDK 初始化后立即开始行情连接 |\n| [opts.clientSystemInfo=] | string | | 客户端信息 |\n| [opts.clientAppId=] | string | | 客户端信息 |\n| [opts.data] | object | {} | 存储数据对象 |\n| [wsOption] | object | {} | 描述 TQSDK 构造参数 |\n| [wsOption.reconnectInterval] | number | 3000 | websocket 自动重连时间间隔 |\n| [wsOption.reconnectMaxTimes] | number | 2 | websocket 自动重连最大次数 |\n| [wsOption.WebSocket] | object | WebSocket | 浏览器 WebSocket 对象，在 nodejs 运行时，需要传入 WebSocket |\n\n**Example** \n```js\n// 浏览器\nconst tqsdk = new TQSDK()\ntqsdk.on('ready', function () {\n console.log(tqsdk.getQuote('SHFE.au2006'))\n})\ntqsdk.on('rtn_brokers', function (brokers) {\n console.log(brokers)\n})\n```\n**Example** \n```js\n// nodejs\nconst TQSDK = require('./dist/umd/tqsdk-nocache')\nconst WebSocket = require('ws')\nconst tqsdk = new TQSDK({}, {WebSocket})\ntqsdk.on('ready', function () {\n console.log(tqsdk.getQuote('SHFE.au2006'))\n})\ntqsdk.on('rtn_brokers', function (brokers) {\n console.log(brokers)\n})\n```\n**Example** \n```js\n// 1 autoInit 为 true，构造函数会执行 tqsdk.initMdWebsocket(), tqsdk.initTdWebsocket(), 代码中不需要再运行\n// 推荐使用这种初始化方式\nconst tqsdk = new TQSDK({autoInit: true}) // 等价于 const tqsdk = new TQSDK()\ntqsdk.on('ready', function(){\n console.log(tqsdk.getQuote('DCE.m2009'))\n})\n\n// 2 autoInit 为 false，构造函数不会去执行 tqsdk.initMdWebsocket(), tqsdk.initTdWebsocket()\n// 在代码中需要的地方再执行\nconst tqsdk = new TQSDK({autoInit: false})\ntqsdk.initMdWebsocket()\n// 如果不运行 tqsdk.initMdWebsocket()， 则不会有 ready 事件发生\ntqsdk.on('ready', function(){\n console.log(tqsdk.getQuote('DCE.m2009'))\n})\n```\n\n* * *\n\n\n\n##### tqsdk.initMdWebsocket()\n初始化行情链接\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n**Emits**: [ready](#TQSDK+event_ready) \n**Example** \n```js\nconst tqsdk = new TQSDK({autoInit: false})\ntqsdk.initMdWebsocket()\ntqsdk.on('ready', function(){\n console.log(tqsdk.getQuote('DCE.m2009'))\n})\n```\n\n* * *\n\n\n\n##### tqsdk.initTdWebsocket()\n初始化交易链接\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n**Emits**: [rtn\\_brokers](#TQSDK+event_rtn_brokers) \n**Example** \n```js\nconst tqsdk = new TQSDK({autoInit: false})\ntqsdk.initMdWebsocket()\ntqsdk.initTdWebsocket()\ntqsdk.on('rtn_brokers', function(brokers){\n console.log(brokers)\n})\n```\n\n* * *\n\n\n\n##### tqsdk.get(payload) ⇒ object \\| null\n获取数据\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| payload | object | | |\n| [payload.name] | string | "users" | |\n| [payload.bid] | string | | 当 name in ['user', 'session', 'accounts', 'account', 'positions', 'position', 'orders', 'order', 'trades', 'trade'] |\n| [payload.user_id] | string | | 当 name in ['user', 'session', 'accounts', 'account', 'positions', 'position', 'orders', 'order', 'trades', 'trade'] |\n| [payload.currency] | string | | 当 name='account' |\n| [payload.symbol] | string | | 当 name in ['position', 'quote', 'ticks', 'klines'] |\n| [payload.order_id] | string | | 当 name='order' |\n| [payload.trade_id] | string | | 当 name='trade' |\n| [payload.trading_day] | string | | 当 name='his_settlement' |\n| [payload.chart_id] | string | | 当 name='chart' |\n| [payload.input] | string | | 当 name='quotes' |\n| [payload.duration] | string | | 当 name='klines' |\n\n\n* * *\n\n\n\n##### tqsdk.getByPath(pathArray, dm) ⇒ object \\| null\n获取数据对象\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| pathArray | list | |\n| dm | object | 获取对象数据源，默认为当前实例的 datamanager |\n\n**Example** \n```js\n// 获取某个合约下市时间\n// 推荐使用这种方式，先获取 quote 对象的引用\nlet quote = tqdsk.getQuote('SHFE.au2006')\nlet dt = quote.expire_datetime\n\n// 以上代码等价于\nlet dt = tqsdk.getByPath(['quotes', 'SHFE.au2006', 'expire_datetime'])\n```\n\n* * *\n\n\n\n##### tqsdk.getQuotesByInput(input, filterOption) ⇒ list\n根据输入字符串查询合约列表\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n**Returns**: list - [symbol, ...] \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| input | string | | |\n| filterOption | object | | 查询合约列表条件限制 |\n| [filterOption.symbol] | boolean | true | 是否根据合约ID匹配 |\n| [filterOption.pinyin] | boolean | true | 是否根据拼音匹配 |\n| [filterOption.include_expired] | boolean | false | 匹配结果是否包含已下市合约 |\n| [filterOption.future] | boolean | true | 匹配结果是否包含期货合约 |\n| [filterOption.future_index] | boolean | false | 匹配结果是否包含期货指数 |\n| [filterOption.future_cont] | boolean | false | 匹配结果是否包含期货主连 |\n| [filterOption.option] | boolean | false | 匹配结果是否包含期权 |\n| [filterOption.combine] | boolean | false | 匹配结果是否包含组合 |\n\n**Example** \n```js\nconst tqsdk = new TQSDK()\nconst quote = tqsdk.getQuote('SHFE.au2006')\ntqsdk.on('ready', function () {\n console.log(tqsdk.getQuotesByInput('huangjin'))\n console.log(tqsdk.getQuotesByInput('doupo', { future_index: true, future_cont: true }))\n})\n```\n\n* * *\n\n\n\n##### tqsdk.getQuote(symbol) ⇒ Quote\n根据合约代码获取合约对象\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| symbol | string | 合约代码 |\n\n**Example** \n```js\nconst tqsdk = new TQSDK()\nconst quote = tqsdk.getQuote('SHFE.au2006')\ntqsdk.on('rtn_data', function () {\n console.log(quote.last_price, quote.pre_settlement)\n})\n```\n\n* * *\n\n\n\n##### tqsdk.setChart(payload) ⇒ object\n请求 K 线图表\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n**Returns**: object - chart \n\n| Param | Type | Description |\n| --- | --- | --- |\n| payload | object | |\n| payload.chart_id | string | 图表 id |\n| payload.symbol | string | 合约代码 |\n| payload.duration | number | 图表周期，0 表示 tick, 1e9 表示 1s, UnixNano 时间 |\n| [payload.view_width] | number | 图表柱子宽度 |\n| [payload.left_kline_id] | number | 指定一个K线id，向右请求view_width个数据 |\n| [payload.trading_day_start] | number | 指定交易日，返回对应的数据 |\n| [payload.trading_day_count] | number | 请求交易日天数 |\n| [payload.focus_datetime] | number | 使得指定日期的K线位于屏幕第M个柱子的位置 |\n| [payload.focus_position] | number | 使得指定日期的K线位于屏幕第M个柱子的位置 |\n\n**Example** \n```js\nlet tqsdk = new TQSDK()\nlet chart = tqsdk.setChart({symbol: 'SHFE.au2006', duration: 60 * 1e9, view_width: 100})\ntqsdk.on('rtn_data', function(){\n console.log('chart.right_id', chart && chart.right_id)\n})\n```\n\n* * *\n\n\n\n##### tqsdk.getChart(chart_id) ⇒ object\n获取 chart 对象\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n**Returns**: object - {} \n\n| Param | Type |\n| --- | --- |\n| chart_id | string | \n\n\n* * *\n\n\n\n##### tqsdk.getKlines(symbol, dur) ⇒ object\n获取 K 线序列\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n**Returns**: object - {data, last_id} \n\n| Param | Type |\n| --- | --- |\n| symbol | string | \n| dur | number | \n\n\n* * *\n\n\n\n##### tqsdk.getTicks(symbol) ⇒ object\n获取 Ticks 序列\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n**Returns**: object - {data, last_id} \n\n| Param | Type |\n| --- | --- |\n| symbol | string | \n\n\n* * *\n\n\n\n##### tqsdk.isChanging(target|pathArray) ⇒ boolean\n判断某个对象是否最近一次有变动\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| target|pathArray | object \\| list | 检查变动的对象或者路径数组 |\n\n**Example** \n```js\nlet tqsdk = new TQSDK()\nlet quote = tqsdk.getQuote('DCE.m2006')\nlet quote1 = tqsdk.getQuote('DCE.cs2006')\ntqsdk.on('rtn_data', function(){\n if (tqsdk.isChanging(quote)) {\n console.log('DCE.m2006 updated', quote.datetime, quote.last_price, quote.volume)\n }\n if (tqsdk.isChanging(['quotes', 'DCE.cs2006'])) {\n console.log('DCE.cs2006 updated', quote1.datetime, quote1.last_price, quote1.volume)\n }\n})\n```\n\n* * *\n\n\n\n##### tqsdk.subscribeQuote(quotes)\n订阅合约, 手动订阅合约\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Default |\n| --- | --- | --- |\n| quotes | list \\| string | [ | \n\n**Example** \n```js\nlet tqsdk = new TQSDK()\ntqsdk.subscribeQuote('SHFE.au2006')\ntqsdk.subscribeQuote(['SHFE.au2006', 'DCE.m2008'])\n```\n\n* * *\n\n\n\n##### tqsdk.addAccount(payload) ⇒ object\n添加期货账户\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n**Returns**: object - account {bid, user_id, password, ws, dm} \n\n| Param | Type | Description |\n| --- | --- | --- |\n| payload | object | |\n| payload.bid | string | 期货公司 |\n| payload.user_id | string | 账户名 |\n| payload.password | string | 密码 |\n\n**Example** \n```js\nconst tqsdk = new TQSDK()\nconst account = { bid: '快期模拟', user_id: 'test123', password: '123456' }\ntqsdk.on('rtn_brokers', function(brokers){\n tqsdk.addAccount(account) // 仅添加期货账户信息并建立链接，不会登录账户\n tqsdk.login(account) // 发送登录期货账户的请求\n})\ntqsdk.on('rtn_data', function(){\n console.log(tqsdk.isLogined(account))\n})\n```\n\n* * *\n\n\n\n##### tqsdk.removeAccount(payload)\n删除期货账户\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| payload | object | |\n| [payload.bid] | string | 期货公司 |\n| payload.user_id | string | 账户名 |\n\n\n* * *\n\n\n\n##### tqsdk.login(payload)\n登录期货账户\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| payload | object | |\n| payload.bid | string | 期货公司 |\n| payload.user_id | string | 账户名 |\n| payload.password | string | 密码 |\n\n**Example** \n```js\nconst tqsdk = new TQSDK()\nconst account = { bid: '快期模拟', user_id: 'test123', password: '123456' }\ntqsdk.on('rtn_brokers', function(brokers){\n tqsdk.login(account) // 发送登录期货账户的请求\n})\ntqsdk.on('rtn_data', function(){\n console.log(tqsdk.isLogined(account))\n})\n```\n\n* * *\n\n\n\n##### tqsdk.isLogined(payload) ⇒ boolean\n判断账户是否登录 [x]\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type |\n| --- | --- |\n| payload | object | \n| [payload.bid] | string | \n| payload.user_id | string | \n\n\n* * *\n\n\n\n##### tqsdk.refreshAccount(payload)\n刷新账户信息，用于账户资金没有同步正确\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| payload | object | |\n| [payload.bid] | string | 期货公司 |\n| payload.user_id | string | 账户名 |\n\n\n* * *\n\n\n\n##### tqsdk.refreshAccounts()\n刷新全部账户信息，用于账户资金没有同步正确\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n* * *\n\n\n\n##### tqsdk.getAllAccounts() ⇒ list\n获取全部账户信息\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n**Example** \n```js\nconst tqsdk = new TQSDK()\nconst account = { bid: '快期模拟', user_id: 'test123', password: '123456' }\nconst account1 = { bid: '快期模拟', user_id: 'test1234', password: '123456' }\ntqsdk.on('rtn_brokers', function(brokers){\n tqsdk.login(account) // 发送登录期货账户的请求\n tqsdk.login(account1) // 发送登录期货账户的请求\n // ........\n const accounts = tqsdk.getAllAccounts()\n console.log(accounts)\n})\n```\n\n* * *\n\n\n\n##### tqsdk.getAccount(payload) ⇒ object \\| null\n获取账户资金信息\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type |\n| --- | --- |\n| payload | object | \n| [payload.bid] | string | \n| payload.user_id | string | \n\n**Example** \n```js\nconst tqsdk = new TQSDK()\nconst account = { bid: '快期模拟', user_id: 'test123', password: '123456' }\ntqsdk.on('rtn_brokers', function(brokers){\n tqsdk.addAccount(account) // 仅添加期货账户信息并建立链接，不会登录账户\n tqsdk.login(account) // 发送登录期货账户的请求\n})\ntqsdk.on('rtn_data', function(){\n if (tqsdk.isLogined(account)) {\n let account = tqsdk.getAccount(account)\n console.log(account.balance, account.risk_ratio)\n }\n})\n```\n\n* * *\n\n\n\n##### tqsdk.insertOrder(payload) ⇒ object\n下单\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n**Returns**: object - order={order_id, status, ...} \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| payload | object | | |\n| [payload.bid] | string | | 期货公司 |\n| payload.user_id | string | | 账户名 |\n| payload.exchange_id | string | | 交易所 |\n| payload.instrument_id | string | | 合约名称 |\n| payload.direction | string | | 方向 [`BUY` | `SELL`] |\n| payload.offset | string | | 开平 [`OPEN` | `CLOSE` | `CLOSETODAY`] |\n| payload.price_type | string | "LIMIT" | 限价 [`LIMIT` | `ANY`] |\n| payload.limit_price | number | | 价格 |\n| payload.volume | number | | 手数 |\n\n**Example** \n```js\nlet tqsdk = new TQSDK()\nconst account = { bid: '快期模拟', user_id: 'test123', password: '123456' }\ntqsdk.on('rtn_brokers', function(brokers){\n tqsdk.addAccount(account) // 仅添加期货账户信息并建立链接，不会登录账户\n tqsdk.login(account) // 发送登录期货账户的请求\n})\ntqsdk.on('rtn_data', function(){\n if (!tqsdk.isLogined(account)) return\n let order = tqsdk.insertOrder(Object.assign({\n exchange_id: 'SHFE',\n instrument_id: 'au2006',\n direction: 'BUY',\n offset: 'OPEN',\n price_type: 'LIMIT',\n limit_price: 359.62,\n volume: 2\n }, account))\n console.log(order.orderId, order.status, order.volume_left)\n})\n```\n\n* * *\n\n\n\n##### tqsdk.autoInsertOrder(payload) ⇒ list\n下单，但是平仓单会自动先平今再平昨，不需要用户区分 CLOSE | CLOSETODAY\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n**Returns**: list - list=[{order_id, status, ...}, ...] 返回委托单数组，可能拆分为多个单 \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| payload | object | | |\n| [payload.bid] | string | | 期货公司 |\n| payload.user_id | string | | 账户名 |\n| payload.exchange_id | string | | 交易所 |\n| payload.instrument_id | string | | 合约名称 |\n| payload.direction | string | | 方向 [`BUY` | `SELL`] |\n| payload.offset | string | | 开平 [`OPEN` | `CLOSE`] |\n| payload.price_type | string | "LIMIT" | 限价 [`LIMIT` | `ANY`] |\n| payload.limit_price | number | | 价格 |\n| payload.volume | number | | 手数 |\n\n\n* * *\n\n\n\n##### tqsdk.cancelOrder(payload)\n撤销委托单\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| payload | object | |\n| [payload.bid] | string | 期货公司 |\n| payload.user_id | string | 账户名 |\n| payload.order_id | string | 委托单 id |\n\n\n* * *\n\n\n\n##### tqsdk.getPosition(payload) ⇒ object \\| null\n获取账户某个合约的持仓信息\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| payload | object | |\n| [payload.bid] | string | |\n| payload.user_id | string | |\n| payload.symbol | string | 合约名称 |\n\n**Example** \n```js\nconst tqsdk = new TQSDK()\nconst account = { bid: '快期模拟', user_id: 'test123', password: '123456' }\ntqsdk.on('rtn_brokers', function(brokers){\n tqsdk.addAccount(account) // 仅添加期货账户信息并建立链接，不会登录账户\n tqsdk.login(account) // 发送登录期货账户的请求\n})\ntqsdk.on('rtn_data', function(){\n if (tqsdk.isLogined(account)) {\n let pos = tqsdk.getPosition(Object.assign({ symbol: 'SHFE.au2006' }, account))\n console.log(pos)\n }\n})\n```\n\n* * *\n\n\n\n##### tqsdk.getPositions(payload) ⇒ object \\| null\n获取账户全部持仓信息\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| payload | object | |\n| [payload.bid] | string | 期货公司 |\n| payload.user_id | string | 账户名 |\n\n**Example** \n```js\nconst tqsdk = new TQSDK()\nconst account = { bid: '快期模拟', user_id: 'test123', password: '123456' }\ntqsdk.on('rtn_brokers', function(brokers){\n tqsdk.addAccount(account) // 仅添加期货账户信息并建立链接，不会登录账户\n tqsdk.login(account) // 发送登录期货账户的请求\n})\ntqsdk.on('rtn_data', function(){\n if (tqsdk.isLogined(account)) {\n let pos = tqsdk.getPositions(account)\n console.log(pos)\n }\n})\n```\n\n* * *\n\n\n\n##### tqsdk.getOrder(payload) ⇒ object \\| null\n获取账户某个合约的委托单信息\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| payload | object | |\n| [payload.bid] | string | |\n| payload.user_id | string | |\n| payload.order_id | string | 委托单 id |\n\n\n* * *\n\n\n\n##### tqsdk.getOrders(payload) ⇒ object \\| null\n获取账户全部委托单信息\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| payload | object | |\n| [payload.bid] | string | 期货公司 |\n| payload.user_id | string | 账户名 |\n\n\n* * *\n\n\n\n##### tqsdk.getOrdersBySymbol(payload) ⇒ object \\| null\n获取账户下某个合约对应的全部委托单信息\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| payload | object | |\n| [payload.bid] | string | 期货公司 |\n| payload.user_id | string | 账户名 |\n| payload.symbol | string | 合约名称 |\n\n\n* * *\n\n\n\n##### tqsdk.getTrade(payload) ⇒ object \\| null\n获取账户某个合约的成交记录\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| payload | object | |\n| [payload.bid] | string | |\n| payload.user_id | string | |\n| payload.trade_id | string | 成交记录 id |\n\n\n* * *\n\n\n\n##### tqsdk.getTrades(payload) ⇒ object \\| null\n获取账户全部成交记录\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| payload | object | |\n| [payload.bid] | string | 期货公司 |\n| payload.user_id | string | 账户名 |\n\n\n* * *\n\n\n\n##### tqsdk.getTradesByOrder(payload) ⇒ object \\| null\n获取账户下某个委托单对应的全部成交记录\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| payload | object | |\n| [payload.bid] | string | 期货公司 |\n| payload.user_id | string | 账户名 |\n| payload.order_id | string | 委托单 id |\n\n\n* * *\n\n\n\n##### tqsdk.getTradesBySymbol(payload) ⇒ object \\| null\n获取账户下某个合约对应的全部成交记录\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| payload | object | |\n| [payload.bid] | string | 期货公司 |\n| payload.user_id | string | 账户名 |\n| payload.symbol | string | 合约名称 |\n\n\n* * *\n\n\n\n##### tqsdk.getHisSettlements(payload) ⇒ object \\| null\n获取账户的历史结算单\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| payload | object | |\n| [payload.bid] | string | 期货公司 |\n| payload.user_id | string | 账户名 |\n\n\n* * *\n\n\n\n##### tqsdk.getHisSettlement(payload) ⇒ object \\| null\n获取账户某一日历史结算单\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| payload | object | |\n| [payload.bid] | string | 期货公司 |\n| payload.user_id | string | 账户名 |\n| payload.trading_day | string | 查询日期 |\n\n\n* * *\n\n\n\n##### tqsdk.confirmSettlement(payload)\n确认结算单， 每个交易日需要确认一次\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| payload | object | |\n| [payload.bid] | string | 期货公司 |\n| payload.user_id | string | 账户名 |\n\n**Example** \n```js\nconst tqsdk = new TQSDK()\nconst account = { bid: '快期模拟', user_id: 'test123', password: '123456' }\ntqsdk.on('rtn_brokers', function(brokers){\n tqsdk.addAccount(account) // 仅添加期货账户信息并建立链接，不会登录账户\n tqsdk.login(account) // 发送登录期货账户的请求\n})\ntqsdk.on('rtn_data', function(){\n if (tqsdk.isLogined(account)) {\n tqsdk.confirmSettlement(account) // 每个交易日都需要在确认结算单后才可以下单\n // tqsdk.insertOrder({....})\n }\n})\n```\n\n* * *\n\n\n\n##### tqsdk.transfer(payload)\n银期转账\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Default | Description |\n| --- | --- | --- | --- |\n| payload | object | | |\n| [payload.bid] | string | | 期货公司 |\n| payload.user_id | string | | 账户名 |\n| payload.bank_id | string | | 银行ID |\n| payload.bank_password | string | | 银行账户密码 |\n| payload.future_account | string | | 期货账户 |\n| payload.future_password | string | | 期货账户密码 |\n| payload.currency | string | "CNY" | 币种代码 |\n| payload.amount | string | | 转账金额 >0 表示转入期货账户, <0 表示转出期货账户 |\n\n\n* * *\n\n\n\n##### tqsdk.hisSettlement(payload)\n查询历史结算单\n\n**Kind**: instance method of [Tqsdk](#exp_module_TQSDK--Tqsdk) \n\n| Param | Type | Description |\n| --- | --- | --- |\n| payload | object | |\n| [payload.bid] | string | 期货公司 |\n| payload.user_id | string | 账户名 |\n| payload.trading_day | string | 交易日 |\n\n\n* * *\n\n\n\n## Vue Plugin\n\nTQSDK - JS 封装为 Vue 插件，可以在组件中监听事件，不需要在单独取消监听。\n\n\n```js\nimport Vue from 'vue'\nimport TQSDK from 'tqsdk'\n\nlet tqsdk = new TQSDK()\n\nconst NOOP = () => {}\nlet tqVmEventMap = {}\nlet tqsdkRE = /^tqsdk:/\n\nfunction mixinEvents(Vue) {\n let on = Vue.prototype.$on\n let emit = Vue.prototype.$emit\n\n Vue.prototype.$on = function proxyOn(eventName, fn = NOOP) {\n const vm = this\n if (Array.isArray(eventName)) {\n eventName.forEach((item) => vm.$on(item, fn));\n } else if (tqsdkRE.test(eventName)) {\n if (!tqVmEventMap[vm._uid]) tqVmEventMap[vm._uid] = {}\n let tq_eventName = eventName.match(/^tqsdk:(.*)/)[1]\n if (!tqVmEventMap[vm._uid][tq_eventName]) tqVmEventMap[vm._uid][tq_eventName] = []\n tqVmEventMap[vm._uid][tq_eventName].push(fn)\n tqsdk.on(tq_eventName, fn.bind(vm))\n } else {\n on.call(vm, eventName, fn)\n }\n return vm\n }\n}\n\nfunction applyMixin(Vue) {\n Vue.mixin({\n beforeDestroy() {\n const vm = this\n const tqevents = tqVmEventMap[vm._uid] || {};\n for (let eventName in tqevents) {\n let eventsArr = tqevents[eventName]\n eventsArr.forEach((fn) => {\n tqsdk.removeEventListener(eventName, fn)\n })\n }\n delete tqVmEventMap[vm._uid];\n }\n })\n}\n\nfunction plugin(Vue) {\n if (VERSION < 2) {\n console.error('[vue-event-proxy] only support Vue 2.0+');\n return;\n }\n // Exit if the plugin has already been installed.\n if (plugin.installed) return\n plugin.installed = true\n mixinEvents(Vue)\n applyMixin(Vue)\n}\n\nVue.use(plugin)\n\nVue.$tqsdk = tqsdk\nVue.prototype.$tqsdk = tqsdk\n\nexport default tqsdk;\n```\n\n© 2017-2022 [Shinnytech](https://www.shinnytech.com/). Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).\n","readmeFilename":"README.md"}