Class TorLens

TorLens - A library for fetching and analyzing Tor node information

Constructors

constructor

new TorLens(options?): TorLens
Creates a new TorLens instance
Parameters
- options: TorLensOptions = {}
  Configuration options
Returns TorLens
- Defined in TorLens.ts:14

Properties

`Private` baseUrl

baseUrl: string

Methods

advancedSearch

advancedSearch(params): Promise<TorDetails>
Performs an advanced search with multiple parameters
Parameters
- params: Record<string, string>
  The search parameters to use
Returns Promise<TorDetails>
Details about matching Tor nodes
- Defined in TorLens.ts:32

getAllBridges

getAllBridges(): Promise<TorBridge[]>
Fetches all bridges

Returns Promise<TorBridge[]>
Array of all bridges
- Defined in TorLens.ts:265

getBridgeByFingerprint

getBridgeByFingerprint(fingerprint): Promise<undefined | TorBridge>
Gets a bridge by its fingerprint
Parameters
- fingerprint: string
  The bridge's fingerprint
Returns Promise<undefined | TorBridge>
The bridge data if found, undefined otherwise
- Defined in TorLens.ts:275

getBridgesByTransport

getBridgesByTransport(transport): Promise<TorBridge[]>
Fetches bridges by specific transport type
Parameters
- transport: string
  The transport type to filter by (e.g., "obfs4")
Returns Promise<TorBridge[]>
Array of bridges supporting the specified transport
- Defined in TorLens.ts:285

getRelayByFingerprint

getRelayByFingerprint(fingerprint): Promise<undefined | TorRelay>
Fetches a specific relay by its fingerprint
Parameters
- fingerprint: string
  The relay's fingerprint
Returns Promise<undefined | TorRelay>
The relay data if found, undefined otherwise
- Defined in TorLens.ts:41

getRelaysByAS

getRelaysByAS(asNumber): Promise<TorRelay[]>
Fetches relays by autonomous system (AS) number
Parameters
- asNumber: string
  The AS number with or without the "AS" prefix
Returns Promise<TorRelay[]>
Array of relays with the specified AS number
- Defined in TorLens.ts:158

getRelaysByASName

getRelaysByASName(asName): Promise<TorRelay[]>
Fetches relays by autonomous system (AS) name
Parameters
- asName: string
  The AS name to search for
Returns Promise<TorRelay[]>
Array of relays with AS names containing the search term
- Defined in TorLens.ts:170

getRelaysByContact

getRelaysByContact(contactInfo): Promise<TorRelay[]>
Fetches relays by contact information
Parameters
- contactInfo: string
  The contact information to search for
Returns Promise<TorRelay[]>
Array of relays with matching contact information
- Defined in TorLens.ts:252

getRelaysByCountry

getRelaysByCountry(countryCode): Promise<TorRelay[]>
Fetches relays by country code
Parameters
- countryCode: string
  The two-letter country code
Returns Promise<TorRelay[]>
Array of relays in the specified country
- Defined in TorLens.ts:147

getRelaysByExitAddress

getRelaysByExitAddress(exitAddress): Promise<TorRelay[]>
Fetches relays by exit address (IP)
Parameters
- exitAddress: string
  The exit address to search for
Returns Promise<TorRelay[]>
Array of relays with matching exit address
- Defined in TorLens.ts:75

getRelaysByFlags

getRelaysByFlags(flags): Promise<TorRelay[]>
Fetches relays that have specific flags
Parameters
- flags: string[]
  Array of flags to filter by
Returns Promise<TorRelay[]>
Array of relays with all the specified flags
- Defined in TorLens.ts:183

getRelaysByHostname

getRelaysByHostname(hostname): Promise<TorRelay[]>
Fetches relays by host name (verified or unverified)
Parameters
- hostname: string
  The hostname to search for
Returns Promise<TorRelay[]>
Array of relays with matching hostname
- Defined in TorLens.ts:87

getRelaysByMinBandwidth

getRelaysByMinBandwidth(minBandwidth): Promise<TorRelay[]>
Fetches relays by minimum bandwidth rate
Parameters
- minBandwidth: number
  The minimum bandwidth rate in bytes per second
Returns Promise<TorRelay[]>
Array of relays with at least the specified bandwidth rate
- Defined in TorLens.ts:239

getRelaysByMinRunTime

getRelaysByMinRunTime(minDays): Promise<TorRelay[]>
Fetches relays running for at least the specified duration
Parameters
- minDays: number
  The minimum number of days the relay has been running
Returns Promise<TorRelay[]>
Array of relays running for at least the specified duration
- Defined in TorLens.ts:344

getRelaysByNickname

getRelaysByNickname(nickname): Promise<TorRelay[]>
Fetches relays by nickname
Parameters
- nickname: string
  The relay nickname to search for
Returns Promise<TorRelay[]>
Array of matching relays
- Defined in TorLens.ts:51

getRelaysByORAddress

getRelaysByORAddress(orAddress): Promise<TorRelay[]>
Fetches relays by OR address (IP:port)
Parameters
- orAddress: string
  The OR address to search for
Returns Promise<TorRelay[]>
Array of relays with matching OR address
- Defined in TorLens.ts:63

getRelaysByPlatform

getRelaysByPlatform(platform): Promise<TorRelay[]>
Fetches relays by platform (e.g., "Tor 0.4.8.16 on Linux")
Parameters
- platform: string
  The platform string to search for
Returns Promise<TorRelay[]>
Array of relays with matching platform
- Defined in TorLens.ts:198

getRelaysByPort

getRelaysByPort(port): Promise<TorRelay[]>
Fetches relays that allow a specific port
Parameters
- port: number
  The port number to check
Returns Promise<TorRelay[]>
Array of relays that allow the specified port
- Defined in TorLens.ts:298

getRelaysByUnverifiedHostname

getRelaysByUnverifiedHostname(hostname): Promise<TorRelay[]>
Fetches relays by unverified host name
Parameters
- hostname: string
  The unverified hostname to search for
Returns Promise<TorRelay[]>
Array of relays with matching unverified hostname
- Defined in TorLens.ts:115

getRelaysByVerifiedHostname

getRelaysByVerifiedHostname(hostname): Promise<TorRelay[]>
Fetches relays by verified host name
Parameters
- hostname: string
  The verified hostname to search for
Returns Promise<TorRelay[]>
Array of relays with matching verified hostname
- Defined in TorLens.ts:131

getRelaysByVersion

getRelaysByVersion(version): Promise<TorRelay[]>
Fetches relays by Tor version
Parameters
- version: string
  The Tor version to search for
Returns Promise<TorRelay[]>
Array of relays with the specified Tor version
- Defined in TorLens.ts:212

getRelaysByVersionStatus

getRelaysByVersionStatus(status): Promise<TorRelay[]>
Fetches relays by version status (e.g., "recommended")
Parameters
- status: string
  The version status to filter by
Returns Promise<TorRelay[]>
Array of relays with the specified version status
- Defined in TorLens.ts:225

getTopRelaysByWeight

getTopRelaysByWeight(limit?): Promise<TorRelay[]>
Fetches the top relays by consensus weight
Parameters
- limit: number = 10
  The maximum number of relays to return
Returns Promise<TorRelay[]>
Array of relays sorted by consensus weight (descending)
- Defined in TorLens.ts:331

search

search(searchTerm?): Promise<TorDetails>
Fetches Tor node details based on a search term
Parameters
- Optional searchTerm: string
  The term to search for (nickname, fingerprint, IP address, etc.)
Returns Promise<TorDetails>
Details about matching Tor nodes
- Defined in TorLens.ts:23