UNPKG

binance-futures-wrapper

Version:

A comprehensive TypeScript wrapper for Binance USDT-M Futures API with full REST and WebSocket support

126 lines 3.6 kB
/** * WebSocket client for Binance Futures */ import { EventEmitter } from 'events'; import { BinanceConfig, WebSocketConfig } from '../types'; export interface WebSocketClientOptions extends WebSocketConfig { config: BinanceConfig; } export declare class WebSocketClient extends EventEmitter { private config; private wsConfig; private logger; private reconnectionManager; private wsBaseUrl; private marketWs; private userWs; private marketConnected; private userConnected; private marketSubscriptions; private messageId; private keepAliveInterval; private listenKey; constructor(options: WebSocketClientOptions); /** * Connect to market data streams */ connectMarket(): Promise<void>; /** * Connect to user data stream */ connectUser(listenKey: string): Promise<void>; private setupMarketHandlers; private setupUserHandlers; private handleSubscriptionResponse; private handleMarketData; private handleMarketEvent; private handleUserData; private reconnectMarket; private reconnectUser; private startKeepAlive; /** * Subscribe to market streams */ subscribe(streams: string[]): Promise<void>; /** * Unsubscribe from market streams */ unsubscribe(streams: string[]): Promise<void>; /** * Subscribe to aggregate trade stream */ subscribeAggTrade(symbol: string): Promise<void>; /** * Subscribe to mark price stream */ subscribeMarkPrice(symbol: string, updateSpeed?: '1s' | '3s'): Promise<void>; /** * Subscribe to all mark price stream */ subscribeAllMarkPrice(updateSpeed?: '1s' | '3s'): Promise<void>; /** * Subscribe to kline stream */ subscribeKline(symbol: string, interval: string): Promise<void>; /** * Subscribe to continuous contract kline stream */ subscribeContinuousKline(pair: string, contractType: string, interval: string): Promise<void>; /** * Subscribe to mini ticker stream */ subscribeMiniTicker(symbol: string): Promise<void>; /** * Subscribe to all mini ticker stream */ subscribeAllMiniTicker(): Promise<void>; /** * Subscribe to ticker stream */ subscribeTicker(symbol: string): Promise<void>; /** * Subscribe to all ticker stream */ subscribeAllTicker(): Promise<void>; /** * Subscribe to book ticker stream */ subscribeBookTicker(symbol: string): Promise<void>; /** * Subscribe to all book ticker stream */ subscribeAllBookTicker(): Promise<void>; /** * Subscribe to liquidation order stream */ subscribeLiquidationOrder(symbol: string): Promise<void>; /** * Subscribe to all liquidation order stream */ subscribeAllLiquidationOrder(): Promise<void>; /** * Subscribe to partial book depth stream */ subscribePartialBookDepth(symbol: string, levels: 5 | 10 | 20, updateSpeed?: '100ms' | '250ms' | '500ms'): Promise<void>; /** * Subscribe to diff book depth stream */ subscribeDiffBookDepth(symbol: string, updateSpeed?: '100ms' | '250ms' | '500ms'): Promise<void>; /** * Subscribe to composite index stream */ subscribeCompositeIndex(symbol: string): Promise<void>; /** * Close all connections */ close(): void; /** * Get connection status */ getStatus(): { market: boolean; user: boolean; subscriptions: string[]; }; } //# sourceMappingURL=client.d.ts.map