Skip to main content

Set up a residential subaccount

Create a sub-user package with its own traffic limit and lists (reseller scenario) through the API.

This guide shows you how to create a sub-user package with its own traffic limit and lists — useful for reselling.

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 — Create the sub-user package

Create the sub-user package with a traffic limit, rotation and expiry. From the response copy the package_key.

Endpoint

POST https://proxy-seller.com/personal/api/v1/YOUR_API_KEY/residentsubuser/create

Request body

Name

Type

Description

traffic_limit

String

Traffic limit in bytes.

rotation

Number

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

expired_at

String

Expiry date of the package.

is_link_date

Boolean

Boolean — link the expiry to the main package.

Response

{
  "status": "success",
  "data": {
    "package_key": "ab12cd34ef56",
    "rotation": 60,
    "traffic_limit": "1073741824",
    "is_active": true
  },
  "errors": []
}

Step 2 — Create an IP list in the package

Create an IP list inside that package using the package_key plus the geo, export and rotation settings.

Endpoint

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

Request body

Name

Type

Description

package_key

String

Package key (from package info).

title

String

Name of the list.

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.

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 3 — Confirm the package

List the sub-user packages to confirm everything is set up correctly.

Endpoint

GET https://proxy-seller.com/personal/api/v1/YOUR_API_KEY/residentsubuser/packages

Response

{
  "status": "success",
  "data": [
    { "package_key": "ab12cd34ef56", "traffic_limit": "1073741824", "is_active": true, "expired_at": "d.m.Y" }
  ],
  "errors": []
}

Full API reference

Did this answer your question?