Binance TypeScript SDK example: ws-proxy-socks.ts

Binance WebSocket Misc websocket proxy socks example for the Siebly Binance SDK, with TypeScript source for exchange REST API and WebSocket integration, setup, and production SDK docs.

What This Example Covers

  • Binance WebSocket stream example in TypeScript.
  • Uses the Siebly Binance SDK package binance instead of hand-written WebSocket plumbing.
  • Source path: Binance/WebSockets/Misc/ws-proxy-socks.ts.
  • Example category: WebSocket Misc.
  • Imports SDK symbols including WebsocketClient.
  • Calls SDK methods such as on(), subscribeAll24hrTickers().

How To Use This Example

  • Start here for the specific request or stream pattern, then check the matching SDK guide for install, credentials, and operational notes.
  • For WebSocket examples, keep reconnect, resubscribe, heartbeat, and event-handler behavior explicit in your service.
  • Open the repository source when you need the latest committed version: GitHub source file.

Example Path

Binance/WebSockets/Misc/ws-proxy-socks.ts

Source Link

Repository source: https://github.com/sieblyio/crypto-api-examples/blob/master/examples/Binance/WebSockets/Misc/ws-proxy-socks.ts

Related SDK Docs

Example Source

/**
 * Minimal example for using a socks proxy with the ws client, extracted from https://github.com/tiagosiebler/binance/pull/319
 */
import { WebsocketClient } from 'binance';
import { SocksProxyAgent } from 'socks-proxy-agent';
// const { SocksProxyAgent } = require('socks-proxy-agent');

const agent = new SocksProxyAgent(process.env.http_proxy || '');
const wsClient = new WebsocketClient({
  beautify: true,
  wsOptions: {
    agent: agent,
  },
});

wsClient.on('formattedMessage', (data) => {
  console.log('log formattedMessage: ', data);
});
wsClient.on('open', (data) => {
  console.log('connection opened open:', data.wsKey, data.wsUrl);
});

wsClient.on('response', (data) => {
  console.log('log response: ', JSON.stringify(data, null, 2));
});
wsClient.on('reconnecting', (data) => {
  console.log('ws automatically reconnecting.... ', data?.wsKey);
});
wsClient.on('reconnected', (data) => {
  console.log('ws has reconnected ', data?.wsKey);
});

wsClient.subscribeAll24hrTickers('usdm');