Skip to main content

Create a residential list

Build a geo-targeted residential proxy list with rotation through the API.

This guide shows you how to build a geo-targeted residential proxy list with rotation.

Every request uses your personal API key from your account dashboard (how to get your API key). In the examples below, replace YOUR_API_KEY with your own key. To pay from your account balance, use paymentId = 1.

Step 1 — Check the package

Confirm the residential package is active and has traffic left. Copy the package_key.

Endpoint

GET https://proxy-seller.com/personal/api/v1/YOUR_API_KEY/resident/package

Response

{
  "status": "success",
  "data": {
    "rotation": 60,
    "traffic_limit": "7516192768",
    "traffic_usage": "10",
    "traffic_left": "10",
    "package_key": "1234567890abcdefedcb",
    "expired_at": "d.m.Y",
    "is_active": true,
    "tarif_id": 2
  },
  "errors": []
}

Step 2 — Get the available locations

Download the available locations (country / region / city / ISP) so you know the exact GEO values to use. The response is a JSON/ZIP with the full GEO tree.

Endpoint

GET https://proxy-seller.com/personal/api/v1/YOUR_API_KEY/resident/geo

Response

[
  {
    "code": "US",
    "name": "United States",
    "regions": [
      { "name": "Washington", "cities": [ { "name": "Garfield", "isps": [ "FIRST-STEP" ] } ] }
    ]
  }
]

Step 3 — Create the list

Create the list with a title, the geo object (from Step 2), the export settings and a rotation value.

Endpoint

POST https://proxy-seller.com/personal/api/v1/YOUR_API_KEY/resident/list/add

Request body

Name

Type

Description

title

String

Name of the list.

whitelist (optional)

String

IPs for authorization. Leave blank to authorize with login:password.

geo

object

Object with country, region, city, isp from the GEO database (case-sensitive).

export

object

Object: ports (number of IPs, max 1000) and ext (export format).

rotation

Number

Rotation: -1 = sticky, 0 = per request, 1..3600 = seconds.

Example

https://proxy-seller.com/personal/api/v1/YOUR_API_KEY/resident/list/add

Response

{
  "status": "success",
  "data": {
    "id": 561,
    "title": "US Washington Garfield FIRST-STEP",
    "login": "3c8aa1d4",
    "password": "AZT62Dx3",
    "geo": { "country": "US", "region": "Washington", "city": "Garfield", "isp": "FIRST-STEP" },
    "export": { "ports": 10000, "ext": "txt" }
  },
  "errors": []
}

Step 4 — Check the new list

List your residential lists to confirm it was created and grab the connection details.

Endpoint

GET https://proxy-seller.com/personal/api/v1/YOUR_API_KEY/resident/lists

Response

{
  "status": "success",
  "data": [
    { "id": 561, "title": "US Washington", "login": "3c8aa1d4", "rotation": 60 }
  ],
  "errors": []
}

Full API reference

Did this answer your question?