Proxy-seller

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

get_resident_package

🟢 read

Traffic limit, used and remaining traffic, expiry, default rotation, auto-renew state, package_key.

get_resident_geo

🟢 read

Without country — available countries.

get_resident_geo_count

🟢 read

How many residential nodes a location has.

get_resident_isp_codes

🟢 read

Search the ISP catalogue with numeric codes.

list_resident_lists

🟢 read

All residential lists: id, title, credentials, whitelist, geo, rotation, export settings.

add_resident_list

🟡 write

Create a residential list.

set_resident_rotation

🟡 write

Change the rotation of one residential list.

rename_resident_list

🟡 write

Rename one residential list.

delete_resident_list

🔴 delete

Delete one residential list.

create_resident_tools_list

🟡 write

Create the special API Tools list and return its login and password.

get_resident_consumption

🟢 read

Traffic used and its cost, per list, plus package totals and price per GB.

get_resident_traffic_details

🟢 read

Raw usage timeline per list and timestamp.

calc_resident_order

🟢 read

Price of a residential traffic package.

make_resident_order

💳 pays

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

country

string

ISO2 code, e.g. DE

region

string

Region name as listed for the country, e.g. State of Berlin

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

country

string

ISO2 code

region, city, isp

string

Substring filters

get_resident_isp_codes

🟢 read-only · account:read

Search the ISP catalogue with numeric codes.

Parameter

Type

Description

search

string

Part of the provider name, e.g. comcast

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

reveal

boolean

Return password in clear instead of ••••. The assistant confirms with you first — see Proxy passwords and the AI provider

add_resident_list

🟡 changes account state · account:write

Create a residential list. Traffic is billed only when used.

Parameter

Type

Description

title required

string

List name

ports required

integer

Number of proxies, 1–1000

rotation required

integer

-1, 0 or 1–3600

country

string

ISO2 code

region, city, isp

string

Geo filters, spelled exactly as get_resident_geo lists them. A city needs its region; when region is omitted the tool resolves it from the city (and asks for it when the same city name exists in several regions)

whitelist

string

Comma-separated IPs; empty for login/password

ext

string

Export format: txt, csv or a template

set_resident_rotation

🟡 changes account state · account:write

Change the rotation of one residential list.

Parameter

Type

Description

id required

string | integer

List id

rotation required

integer

-1, 0 or 1–3600

rename_resident_list

🟡 changes account state · account:write

Rename one residential list.

Parameter

Type

Description

id required

string | integer

List id

title required

string

New name

delete_resident_list

🔴 destructive · account:write

Delete one residential list.

Parameter

Type

Description

id required

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

login

string

One list, by its login

date_start, date_end

string

yyyy-MM-dd or dd.MM.yyyy

get_resident_traffic_details

🟢 read-only · account:read

Raw usage timeline per list and timestamp. Use a narrow date range.

Parameter

Type

Description

packageKey required

string

Your own key from get_resident_package, or a subpackage key to read a subuser's usage

login

string

One list within that package

date_start, date_end

string

yyyy-MM-dd or dd.MM.yyyy

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

tarifId required

string

Tariff code from get_reference with type: "resident", e.g. 1-gb

paymentId required

string

balance or paddle_subscription

coupon

string

Promo code

Next steps

On this page