Residential proxies
Updated:
Residential proxies are a traffic pool (GB), not individual IPs. You connect through lists — each list has its own geo filter, rotation, number of ports and credentials.
Permissions: account:read, account:write, billing:write
In this group
Tool | What it does | |
|---|---|---|
🟢 | Traffic limit, used and remaining traffic, expiry, default rotation, auto-renew state, | |
🟢 | Without | |
🟢 | How many residential nodes a location has. | |
🟢 | Search the ISP catalogue with numeric codes. | |
🟢 | All residential lists: id, title, credentials, whitelist, geo, rotation, export settings. | |
🟡 | Create a residential list. | |
🟡 | Change the rotation of one residential list. | |
🟡 | Rename one residential list. | |
🔴 | Delete one residential list. | |
🟡 | Create the special API Tools list and return its login and password. | |
🟢 | Traffic used and its cost, per list, plus package totals and price per GB. | |
🟢 | Raw usage timeline per list and timestamp. | |
🟢 | Price of a residential traffic package. | |
💳 | Buy the first residential package or add traffic to an existing one. |
get_resident_package
🟢 read-only · account:read
Traffic limit, used and remaining traffic, expiry, default rotation, auto-renew state, package_key.
get_resident_geo
🟢 read-only · account:read
Without country — available countries. With country — its regions and their city names. With country and region — that region's cities with their ISPs.
Parameter | Type | Description |
|---|---|---|
| string | ISO2 code, e.g. |
| string | Region name as listed for the country, e.g. |
Returns: Without country: {countries: [{code, name}]}. With country: {code, name, regions: [{code, name, cities: [name]}]}. With region: {code, name, region: {code, name, cities: [{name, isps[]}]}}. Unknown code or region: {country | region: null, message, available[]}.
get_resident_geo_count
🟢 read-only · account:read
How many residential nodes a location has. Use before creating a list for a specific city or ISP.
Parameter | Type | Description |
|---|---|---|
| string | ISO2 code |
| string | Substring filters |
get_resident_isp_codes
🟢 read-only · account:read
Search the ISP catalogue with numeric codes.
Parameter | Type | Description |
|---|---|---|
| string | Part of the provider name, e.g. |
list_resident_lists
🟢 read-only · account:read
All residential lists: id, title, credentials, whitelist, geo, rotation, export settings. password comes back masked unless you ask for it.
Parameter | Type | Description |
|---|---|---|
| boolean | Return |
add_resident_list
🟡 changes account state · account:write
Create a residential list. Traffic is billed only when used.
Parameter | Type | Description |
|---|---|---|
| string | List name |
| integer | Number of proxies, 1–1000 |
| integer |
|
| string | ISO2 code |
| string | Geo filters, spelled exactly as get_resident_geo lists them. A city needs its region; when |
| string | Comma-separated IPs; empty for login/password |
| string | Export format: |
set_resident_rotation
🟡 changes account state · account:write
Change the rotation of one residential list.
Parameter | Type | Description |
|---|---|---|
| string | integer | List id |
| integer |
|
rename_resident_list
🟡 changes account state · account:write
Rename one residential list.
Parameter | Type | Description |
|---|---|---|
| string | integer | List id |
| string | New name |
delete_resident_list
🔴 destructive · account:write
Delete one residential list.
Parameter | Type | Description |
|---|---|---|
| string | integer | List id |
create_resident_tools_list
🟡 changes account state · account:write
Create the special API Tools list and return its login and password. No parameters.
get_resident_consumption
🟢 read-only · account:read
Traffic used and its cost, per list, plus package totals and price per GB.
Parameter | Type | Description |
|---|---|---|
| string | One list, by its login |
| string |
|
get_resident_traffic_details
🟢 read-only · account:read
Raw usage timeline per list and timestamp. Use a narrow date range.
Parameter | Type | Description |
|---|---|---|
| string | Your own key from get_resident_package, or a subpackage key to read a subuser's usage |
| string | One list within that package |
| string |
|
calc_resident_order
🟢 read-only · account:read
Price of a residential traffic package. Same parameters as make_resident_order.
make_resident_order
💳 spends money · billing:write
Buy the first residential package or add traffic to an existing one. Purchased GB are added to the remaining traffic.
Parameter | Type | Description |
|---|---|---|
| string | Tariff code from get_reference with |
| string |
|
| string | Promo code |