Traffic Management

Allocate Residential Proxies Traffic

post

Resellers can implement traffic resource allocation and management for their users through this API.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

langstringOptional

Language：en|cn

Default: enExample: en

Body

multipart/form-data

sub_uidintegerRequired

The id of the sub-user

Example: 123

quantityintegerRequired

Allocated traffic (MB)

Example: 1000

remarkstringOptional

Order Remark

Responses

200Success

application/json

404Error

application/json

post

/v2/residential/allocate

HTTPcURLJavaScriptPython

POST /v2/residential/allocate HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 43

{
  "sub_uid": 123,
  "quantity": 1000,
  "remark": ""
}

{
  "code": 0,
  "data": null,
  "msg": "success",
  "timestamp": 1751455902
}

Deduct Residential Proxies Traffic

post

Manually reclaims sub-user traffic and refunds the value to your wallet based on the current unit price(Note: Expired traffic is processed automatically).

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

langstringOptional

Language：en|cn

Default: enExample: en

Body

multipart/form-data

sub_uidintegerRequired

The id of the sub-user

Example: 123

package_typestringRequired

Package Type:Residential

Example: Residential

deduction_amountnumberOptional

Deduction Amount(M),All resources are deducted when parameters are passed blank

Example: 25.5

Responses

200Success

application/json

post

/v2/residential/deduct

HTTPcURLJavaScriptPython

POST /v2/residential/deduct HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 68

{
  "sub_uid": 123,
  "package_type": "Residential",
  "deduction_amount": 25.5
}

200Success

{
  "code": 0,
  "data": {
    "refund_amount": 6
  },
  "msg": "success",
  "timestamp": 1763346268
}

View Traffic Allocation History

post

Support resellers querying detailed traffic allocation history records through API.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

langstringOptional

Language：en|cn

Default: enExample: en

Body

multipart/form-data

sub_uidintegerRequired

The id of the sub-user

Example: 123

create_time_startstringOptional

Time allocation starts (timestamp)

create_time_endstringOptional

End of time allocation (timestamp)(timestamp)

pageintegerRequired

page number

Example: 1

limitintegerRequired

Number of entries returned per page

Example: 10

Responses

200Success

application/json

404Error

application/json

post

/v2/residential/distribution_history

HTTPcURLJavaScriptPython

POST /v2/residential/distribution_history HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 79

{
  "sub_uid": 123,
  "create_time_start": "",
  "create_time_end": "",
  "page": 1,
  "limit": 10
}

{
  "code": 0,
  "data": {
    "list": [
      {
        "id": 93,
        "order_id": "AC2507021931416468",
        "agent_id": 1,
        "uid": 1718,
        "package_type": "Residential",
        "quantity": 1000,
        "unit": "M",
        "unit_price": 4,
        "amount": 4,
        "balance": 564,
        "after_balance": 560,
        "create_time": 1751455901,
        "update_time": 1751455901,
        "admin": "1",
        "remark": "",
        "username": "test_name"
      }
    ],
    "page": 1,
    "total": 35
  },
  "msg": "success",
  "timestamp": 1751455918
}

View Refund Logs

post

Retrieves records of manual traffic reclamation and refunds.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

langstringOptional

Language：en|cn

Default: enExample: en

Body

multipart/form-data

sub_uidintegerRequired

The id of the sub-user

Example: 2680

package_typestringRequired

Package Type:Residential

pageintegerOptional

page

Example: 1

limitintegerOptional

page size

Example: 10

Responses

200Success

application/json

post

/v2/residential/deduct_history

HTTPcURLJavaScriptPython

POST /v2/residential/deduct_history HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 54

{
  "sub_uid": 2680,
  "package_type": "",
  "page": 1,
  "limit": 10
}

200Success

{
  "code": 0,
  "data": {
    "list": [
      {
        "id": 391,
        "agent_id": 1,
        "uid": 1810,
        "refund_type": 1,
        "package_type": "Residential",
        "deduction_amount": 2000,
        "unit_price": 3,
        "refund_amount": 6,
        "order_id": "2511141057112556",
        "create_time": 1763089032
      }
    ],
    "total": 15
  },
  "msg": "success",
  "timestamp": 1763346175
}

Check Sub-user Remaining Traffic

post

Support resellers to check real-time remaining traffic information of their users.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

langstringOptional

Language：en|cn

Default: enExample: en

Body

multipart/form-data

sub_uidintegerRequired

The id of the sub-user

Example: 123

Responses

200Success

application/json

404Error

application/json

post

/v2/residential/sub_user_remaining

HTTPcURLJavaScriptPython

POST /v2/residential/sub_user_remaining HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 15

{
  "sub_uid": 123
}

{
  "code": 0,
  "data": {
    "balance": 2000,
    "expire_time": "No Expiration"
  },
  "msg": "success",
  "timestamp": 1767954547
}