{"id":16323117,"url":"https://github.com/danielstjules/toragent","last_synced_at":"2025-10-25T10:13:15.838Z","repository":{"id":36481036,"uuid":"40786604","full_name":"danielstjules/toragent","owner":"danielstjules","description":"HTTP(S) requests through Tor for Node","archived":false,"fork":false,"pushed_at":"2018-09-28T10:05:25.000Z","size":15,"stargazers_count":32,"open_issues_count":2,"forks_count":9,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-06-01T08:03:38.019Z","etag":null,"topics":["agent","nodejs","tor"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/danielstjules.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-08-15T21:38:12.000Z","updated_at":"2022-06-12T20:35:43.000Z","dependencies_parsed_at":"2022-08-30T12:30:21.850Z","dependency_job_id":null,"html_url":"https://github.com/danielstjules/toragent","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/danielstjules/toragent","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielstjules%2Ftoragent","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielstjules%2Ftoragent/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielstjules%2Ftoragent/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielstjules%2Ftoragent/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/danielstjules","download_url":"https://codeload.github.com/danielstjules/toragent/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danielstjules%2Ftoragent/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264139444,"owners_count":23563239,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agent","nodejs","tor"],"created_at":"2024-10-10T22:54:00.068Z","updated_at":"2025-10-12T13:01:44.199Z","avatar_url":"https://github.com/danielstjules.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# toragent\n\nEasily manage HTTP(S) requests through Tor. TorAgent spawns Tor processes,\nhandles both HTTP and HTTPS requests, and offers easy IP address rotation.\nCompatible with `http.request` and libraries like `request`.\n\n[![Build Status](https://travis-ci.org/danielstjules/toragent.svg?branch=master)](https://travis-ci.org/danielstjules/toragent)\n\n## Installation\n\nRequires Node \u003e= 4.\n\n```\nnpm install --save toragent\n```\n\n## Overview\n\nWorks with promises.\n\n``` javascript\nvar TorAgent = require('toragent');\nvar Promise  = require('bluebird');\nvar request  = Promise.promisify(require('request'));\n\nTorAgent.create().then((agent) =\u003e {\n  return request({\n    url: 'https://www.google.com',\n    agent: agent,\n  });\n}).spread((res, body) =\u003e {\n  console.log(body);\n});\n```\n\nAnd callbacks too!\n\n``` javascript\nvar TorAgent = require('toragent');\nvar request  = require('request');\n\nTorAgent.create(false, (err, agent) =\u003e {\n  if (err) return console.log(err);\n\n  request({\n    url: 'https://www.google.com',\n    agent: agent,\n  }, (err, res, body) =\u003e {\n    console.log(err || body);\n  });\n});\n```\n\n## TorAgent\n\nAn HTTP Agent for proxying requests through Tor using SOCKS5. In the following\nexamples, `agent` refers to an instance of `TorAgent`.\n\n#### TorAgent.create(verbose, [fn])\n\nSpawns a Tor process listening on a random unused port, and creates an\nagent for use with HTTP(S) requests. The optional verbose param will enable\nconsole output while initializing Tor. Accepts an optional callback,\notherwise it returns a promise that resolves with an instance of TorAgent.\nNote that since the Tor process is using a new DataDirectory with no cached\nmicrodescriptors or any other state, bootstrapping can take between 15 - 60s.\nThe resulting child process is automatically killed when node exits.\n\n``` javascript\nTorAgent.create(true).then((agent) =\u003e {\n  // Spawning Tor\n  // Tor spawned with pid 42776 listening on 55683\n});\n```\n\n#### agent.rotateAddress()\n\nRotates the IP address used by Tor by sending a SIGHUP. Returns a promise\nthat resolves when complete.\n\n``` javascript\nTorAgent.create().then(agent =\u003e agent.rotateAddress());\n```\n\n#### agent.destroy()\n\nCloses all sockets handled by the agent, and closes the Tor process. Returns\na promise that resolves when the Tor process has closed.\n\n``` javascript\nTorAgent.create().then(agent =\u003e agent.destroy());\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielstjules%2Ftoragent","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanielstjules%2Ftoragent","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanielstjules%2Ftoragent/lists"}