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.

optionalapifyProxySubdivision

apifyProxySubdivision?: string

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

optionalcheckAccess

checkAccess?: boolean

As part of the init process, we verify the configuration by checking the proxy status endpoint. This can make the init slower, to opt-out of this, use checkAccess: false (defaults to true).

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.

externaloptionalinheritednewUrlFunction

newUrlFunction?: ProxyConfigurationFunction

Custom function that allows you to generate the new proxy URL dynamically. 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.

externaloptionalinheritedproxyUrls

proxyUrls?: (null | 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.

optionalsubdivisionCode

subdivisionCode?: string

If set, all proxied requests will use IP addresses geolocated to the specified subdivision (e.g. US state). Requires countryCode to be set. The value must follow the ISO 3166-2 subdivision code format, e.g. 'CA' for California when countryCode is 'US'.

Page Options