Skip to main content
Version: Next

ProxyConfigurationOptions

Hierarchy

  • ProxyConfigurationOptions
    • ProxyConfigurationOptions

Index

Properties

Properties

optionalapifyProxyCountry

apifyProxyCountry?: string

Same option as countryCode which can be used to configurate the proxy by UI input schema. You should use the countryCode option in your crawler code.

optionalapifyProxyGroups

apifyProxyGroups?: string[]

Same option as groups which can be used to configurate the proxy by UI input schema. You should use the groups option in your crawler code.

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. on the Apify cloud, or when using the Apify CLI.

optionalgroups

groups?: string[]

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

externaloptionalnewUrlFunction

newUrlFunction?: ProxyConfigurationFunction

Custom function that allows you to generate the new proxy URL dynamically. It gets the sessionId as a parameter and an optional parameter with the Request object when applicable. Can return either stringified proxy URL or null if the proxy should not be used. Can be asynchronous.

This function is used to generate the URL when ProxyConfiguration.newUrl or ProxyConfiguration.newProxyInfo is called.

optionalpassword

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.

externaloptionalproxyUrls

proxyUrls?: string[]

An array of custom proxy URLs to be rotated. Custom proxies are not compatible with Apify Proxy and an attempt to use both configuration options will cause an error to be thrown on initialize.

optionaltieredProxyConfig

tieredProxyConfig?: Omit<ProxyConfigurationOptions, keyof ProxyConfigurationOptions | tieredProxyConfig>[]

Multiple different ProxyConfigurationOptions stratified into tiers. Crawlee crawlers will switch between those tiers based on the blocked request statistics.

externaloptionaltieredProxyUrls

tieredProxyUrls?: string[][]

An array of custom proxy URLs to be rotated stratified in tiers. This is a more advanced version of proxyUrls that allows you to define a hierarchy of proxy URLs If everything goes well, all the requests will be sent through the first proxy URL in the list. Whenever the crawler encounters a problem with the current proxy on the given domain, it will switch to the higher tier for this domain. The crawler probes lower-level proxies at intervals to check if it can make the tier downshift.

This feature is useful when you have a set of proxies with different performance characteristics (speed, price, antibot performance etc.) and you want to use the best one for each domain.