Version: Next

ProxyInfo

The main purpose of the ProxyInfo object is to provide information about the current proxy connection used by the crawler for the request. Outside of crawlers, you can get this object by calling ProxyConfiguration.newProxyInfo.

Example usage:

const proxyConfiguration = await Actor.createProxyConfiguration({
  groups: ['GROUP1', 'GROUP2'] // List of Apify Proxy groups
  countryCode: 'US',
});

// Getting proxyInfo object by calling class method directly
const proxyInfo = proxyConfiguration.newProxyInfo();

// In crawler
const crawler = new CheerioCrawler({
  // ...
  proxyConfiguration,
  requestHandler({ proxyInfo }) {
      // Getting used proxy URL
      const proxyUrl = proxyInfo.url;

      // Getting ID of used Session
      const sessionIdentifier = proxyInfo.sessionId;
  }
})

Hierarchy

ProxyInfo
- ProxyInfo

Index

Properties

optionalcountryCode

countryCode?: string

If set and relevant proxies are available in your Apify account, all proxied requests will use IP addresses that are geolocated to the specified country. For example GB for IPs from Great Britain. Note that online services often have their own rules for handling geolocation and thus the country selection is a best attempt at geolocation, rather than a guaranteed hit. This parameter is optional, by default, each proxied request is assigned an IP address from a random country. The country code needs to be a two letter ISO country code. See the full list of available country codes. This parameter is optional, by default, the proxy uses all available proxy servers from all countries.

groups

groups: string[]

An array of proxy groups to be used by the Apify Proxy. If not provided, the proxy will select the groups automatically.

externalhostname

hostname: string

Hostname of your proxy.

password

password: string

User's password for the proxy. By default, it is taken from the APIFY_PROXY_PASSWORD environment variable, which is automatically set by the system when running the Actors on the Apify cloud, or when using the Apify CLI.

externalport

port: string | number

Proxy port.

externaloptionalproxyTier

proxyTier?: number

Proxy tier for the current proxy, if applicable (only for tieredProxyUrls).

externaloptionalsessionId

sessionId?: string

The identifier of used Session, if used.

externalurl

url: string

The URL of the proxy.

externaloptionalusername

username?: string

Username for the proxy.