Skip to main content
This example demonstrates how to generate a list of sticky residential proxies in the US for a specific proxy user using the /residential/list endpoint.

Key Parameters Explained

When generating a residential proxy list for a specific user, you need to specify:
  • proxy_user_id: The ID of the specific proxy user who will authenticate with these proxies
  • country_id: The country code (in this case “us” for United States)
  • list_session_type: Set to “sticky” for sticky residential sessions
  • list_count: Number of proxies to generate
  • list_format: Format of the returned proxies (e.g., “socks5h”)

Expected Output Format

The API will return a list of ready-to-use proxy strings. For example, with list_format=socks5h:

Important Notes

  • Unlike datacenter and ISP proxies, residential proxies are generated on-demand
  • The proxy user must have sufficient residential data allocation
  • Every request for residential proxies consumes a small amount of data
  • Each generated proxy contains location targeting information in its name