Country Targeting
When generating residential proxies, you can specify the country using the ISO country code:City Targeting
For more precise targeting, you can generate proxies from specific cities:city_london).
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
How to target specific countries and cities with residential proxies
# Generate 5 proxies from the United States
curl --request GET \
--url 'https://api.byteful.com/1.0/public/user/residential/list?country_id=us&list_count=5' \
--header 'X-API-Public-Key: your_public_key' \
--header 'X-API-Private-Key: your_private_key'
{
"data": [
"socks5h://your_user_c_us_s_DDINPY7TQ0781XEO:your_password@residential.byteful.com:8000",
"socks5h://your_user_c_us_s_XIINPY7TQ0781XEA:your_password@residential.byteful.com:8000",
"socks5h://your_user_c_us_s_PPINPY7TQ0781XEB:your_password@residential.byteful.com:8000",
"socks5h://your_user_c_us_s_QQINPY7TQ0781XEC:your_password@residential.byteful.com:8000",
"socks5h://your_user_c_us_s_RRINPY7TQ0781XED:your_password@residential.byteful.com:8000"
],
"message": "Residential list successfully created."
}
# Generate 3 proxies from London, UK
curl --request GET \
--url 'https://api.byteful.com/1.0/public/user/residential/list?country_id=gb&city_alias=london&list_count=3' \
--header 'X-API-Public-Key: your_public_key' \
--header 'X-API-Private-Key: your_private_key'
{
"data": [
"socks5h://your_user_c_gb_city_london_s_DDINPY7TQ0781XEO:your_password@residential.byteful.com:8000",
"socks5h://your_user_c_gb_city_london_s_XIINPY7TQ0781XEA:your_password@residential.byteful.com:8000",
"socks5h://your_user_c_gb_city_london_s_PPINPY7TQ0781XEB:your_password@residential.byteful.com:8000"
],
"message": "Residential list successfully created."
}
city_london).
# Generate 3 proxies from California, US
curl --request GET \
--url 'https://api.byteful.com/1.0/public/user/residential/list?country_id=us&subdivision_id=us-ca&list_count=3' \
--header 'X-API-Public-Key: your_public_key' \
--header 'X-API-Private-Key: your_private_key'
# List cities in the United Kingdom
curl --request GET \
--url 'https://api.byteful.com/1.0/public/user/city/search?country_id=gb&city_is_populous=true' \
--header 'X-API-Public-Key: your_public_key' \
--header 'X-API-Private-Key: your_private_key'
# Generate 3 proxies from AT&T (ASN 7018) in the US
curl --request GET \
--url 'https://api.byteful.com/1.0/public/user/residential/list?country_id=us&asn_id=7018&list_count=3' \
--header 'X-API-Public-Key: your_public_key' \
--header 'X-API-Private-Key: your_private_key'
