Residential proxy
Manage residential proxy packages, lists, and sessions programmatically.
A package is your residential subscription — it has a traffic limit and an expiration date. Inside a package you create lists: named bundles of IPs filtered by GEO and rotation rules. You connect to the proxy via the list's login/password, and one package can hold many lists for different use-cases.
Lists
create, configure, and remove proxy lists
Read
GET/resident/lists
Get existing IP lists
All lists in your packages with credentials, GEO, rotation, and whitelist.
GET/resident/geo
Get all locations
Reference for valid country/region/city/ISP values when creating a list.
Write
POST/resident/list/add
Create list
Create a new list with a custom name, GEO filter, and auth method.
POST/resident/list/rename
Rename list
Change a list's display name without affecting credentials or settings.
POST/resident/list/rotation
Change rotation settings
Set sticky, per-request, or time-based rotation (1–3600 seconds).
DELETE/resident/list/delete
Delete list
Remove a list from a package. Active connections drop within ~60 seconds.
Package
GET/resident/package
Package information
Rotation, traffic limit, expiration, package key.
POST/resident/consumption
Consumption cost
Spend report by list and date range.
POST/resident/traffic/details
Traffic usage
Bandwidth used per list over a date range.
More controls
Subaccounts
create subusers, assign packages, control access
Session ID + TTL
session control and direct connection to an unlimited number of IPs
Common to all residential endpoints
Base URL
https://proxy-seller.com/personal/api/v1/{YourApiKey}/resident/Authentication
API key in URL path — never log full request URLs.
Error model
Business errors return HTTP 200 with errors[] populated.