账户订阅

示例上下文

import { createClientConfig, PushClient } from '@tigeropenapi/tigeropen';

const config = createClientConfig();
const pushClient = new PushClient(config);

订阅资产变动

签名

subscribeAsset(account?: string): void

用途

订阅 asset 推送。默认每 5 秒推送一次全量资产快照,实盘和模拟盘频率一致。

参数、默认值与约束

参数类型必填SDK 默认值约束
accountstringconfig.account省略或传空字符串时使用配置账户

返回

void

示例

pushClient.subscribeAsset(config.account);

取消订阅资产变动

签名

unsubscribeAsset(): void

用途

取消 asset 推送。

参数、默认值与约束

无参数。

返回

void

示例

pushClient.unsubscribeAsset();

订阅持仓变动

签名

subscribePosition(account?: string): void

用途

订阅 position 推送。默认每 5 秒推送一次全量持仓快照,实盘和模拟盘频率一致。

参数、默认值与约束

参数类型必填SDK 默认值约束
accountstringconfig.account省略或传空字符串时使用配置账户

返回

void

示例

pushClient.subscribePosition(config.account);

取消订阅持仓变动

签名

unsubscribePosition(): void

用途

取消 position 推送。

参数、默认值与约束

无参数。

返回

void

示例

pushClient.unsubscribePosition();

订阅订单变动

签名

subscribeOrder(account?: string): void

用途

订阅 order 推送。

参数、默认值与约束

参数类型必填SDK 默认值约束
accountstringconfig.account省略或传空字符串时使用配置账户

返回

void

示例

pushClient.subscribeOrder(config.account);

取消订阅订单变动

签名

unsubscribeOrder(): void

用途

取消 order 推送。

参数、默认值与约束

无参数。

返回

void

示例

pushClient.unsubscribeOrder();

订阅成交

签名

subscribeTransaction(account?: string): void

用途

订阅 transaction 推送。

参数、默认值与约束

参数类型必填SDK 默认值约束
accountstringconfig.account省略或传空字符串时使用配置账户

返回

void

示例

pushClient.subscribeTransaction(config.account);

取消订阅成交

签名

unsubscribeTransaction(): void

用途

取消 transaction 推送。

参数、默认值与约束

无参数。

返回

void

示例

pushClient.unsubscribeTransaction();

Did this page help you?