Sign in

v1

latestOpenAPI 3.0.12026-07-265331168.0 KB
Residential

Generated Residential List

This endpoint creates a list of residential proxies based on filter parameters. The search parameters allow the user to filter the proxies by location, session type, and format (e.g., http, socks5, socks5h).

get/public/user/residential/list

Query parameters

list_countinteger

Number of proxies to return in the list.

list_format'standard' | 'http' | 'https' | 'socks5' | 'socks5h'

Desired format for the proxies (e.g., "http", "https", "socks5", "socks5h", or "standard").

proxy_user_idstring

ID of the proxy_user you want to use to authenticate with the proxies.

list_session_type'sticky' | 'rotating'

Session type of the residential proxies you want returned in the search list.

country_idstring

ISO Country Code (ISO 3166-1 alpha-2) to generate residential proxies in.

city_idinteger

ID of the City to generate residential proxies in.

city_aliasstring

Alias of the City to generate residential proxies in.

zip_code_idinteger

ID of the Zip Code to generate residential proxies in.

subdivision_idinteger

ID of the US Subdivision to generate the residential proxies in.

list_smartpath_enabledboolean

Is SmartPath enabled for the residential proxies you want returned in the search list.

list_session_ttlstring

The session ttl of the residential proxies you want returned in the search list

list_mode'general' | 'size' | 'speed'

Desired mode for residential network optimization

Response

Residential list successfully generated.

datastring[]

List of residential proxies.

messagestring

Success message.

Example response

{
  "data": [
    "socks5h://1_oGDQZ_c_gb_city_norwich_m_general_s_DDINPY7TQ0781XEO:vxqaFAA99F@residential.byteful.com:8000",
    "socks5h://1_oGDQZ_c_gb_city_norwich_m_general_s_XIINPY7TQ0781XEA:vxqaFAA99F@residential.byteful.com:8000"
  ],
  "message": "Residential list successfully generated."
}