Account Subscriptions

Example context

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

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

subscribeAsset

Signature

subscribeAsset(account?: string): void

Purpose

Subscribes to asset updates. A full asset snapshot is pushed every five seconds by default. Live and paper trading accounts use the same interval.

Parameters, defaults, and constraints

Returns

void

Type-checked example

pushClient.subscribeAsset(config.account);

unsubscribeAsset

Signature

unsubscribeAsset(): void

Purpose

Unsubscribes from asset updates.

Parameters, defaults, and constraints

No parameters.

Returns

void

Type-checked example

pushClient.unsubscribeAsset();

subscribePosition

Signature

subscribePosition(account?: string): void

Purpose

Subscribes to position updates. A full position snapshot is pushed every five seconds by default. Live and paper trading accounts use the same interval.

Parameters, defaults, and constraints

Returns

void

Type-checked example

pushClient.subscribePosition(config.account);

unsubscribePosition

Signature

unsubscribePosition(): void

Purpose

Unsubscribes from position updates.

Parameters, defaults, and constraints

No parameters.

Returns

void

Type-checked example

pushClient.unsubscribePosition();

subscribeOrder

Signature

subscribeOrder(account?: string): void

Purpose

Subscribes to order updates.

Parameters, defaults, and constraints

Returns

void

Type-checked example

pushClient.subscribeOrder(config.account);

unsubscribeOrder

Signature

unsubscribeOrder(): void

Purpose

Unsubscribes from order updates.

Parameters, defaults, and constraints

No parameters.

Returns

void

Type-checked example

pushClient.unsubscribeOrder();

subscribeTransaction

Signature

subscribeTransaction(account?: string): void

Purpose

Subscribes to transaction updates.

Parameters, defaults, and constraints

Returns

void

Type-checked example

pushClient.subscribeTransaction(config.account);

unsubscribeTransaction

Signature

unsubscribeTransaction(): void

Purpose

Unsubscribes from transaction updates.

Parameters, defaults, and constraints

No parameters.

Returns

void

Type-checked example

pushClient.unsubscribeTransaction();