SOCKS5 HTTP Client for Node.js

Common errors

Warnings

Install

Imports

• shttp
  wrong

  import shttp from 'socks5-http-client';

  correct

  const shttp = require('socks5-http-client');

  This package is CommonJS only. Attempting to use ES module import syntax will result in an error.

• Agent
  wrong

  import { Agent } from 'socks5-http-client/lib/Agent';

  correct

  const Agent = require('socks5-http-client/lib/Agent');

  The `Agent` constructor for integrating with `http.request` or deprecated libraries like `request` is found in a sub-path and is CommonJS only.

• get
  wrong

  const { get } = require('socks5-http-client');

  correct

  const shttp = require('socks5-http-client'); shttp.get('http://example.com', () => {});

  The main client object `shttp` is a default-like export; methods like `get` are accessed directly on the `shttp` object, not destructured.

Quickstart

This example demonstrates how to make a basic HTTP GET request through a SOCKS5 proxy configured via environment variables, logging the initial part of the response body.

const shttp = require('socks5-http-client');

const SOCKS_HOST = process.env.SOCKS_HOST ?? 'localhost';
const SOCKS_PORT = parseInt(process.env.SOCKS_PORT ?? '1080', 10);

shttp.get({
  hostname: 'www.example.com',
  path: '/',
  socksHost: SOCKS_HOST,
  socksPort: SOCKS_PORT,
  // Optional SOCKS5 authentication
  // socksUsername: process.env.SOCKS_USERNAME,
  // socksPassword: process.env.SOCKS_PASSWORD,
}, function(res) {
  res.setEncoding('utf8');
  let data = '';
  res.on('data', function(chunk) {
    data += chunk;
  });
  res.on('end', function() {
    console.log('Received response:');
    console.log(data.substring(0, 200) + '...'); // Log first 200 chars
  });
}).on('error', (e) => {
  console.error(`Request failed: ${e.message}`);
});