Usage Statistics

Check Sub-user Traffic Usage

post

Retrieve the user's daily consumption or hourly consumption within the same day. If the start date and end date parameters are not provided, retrieve data for the most recent 30-day period. If the start date and end date are identical, retrieve hourly consumption data for that specific day.

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: 652

start_datestringOptional

Start time. Grouped by hour if equal to end time; otherwise grouped by day.

Example: 2025-12-08 00:00:00

end_datestringOptional

End time

Example: 2025-12-08 00:00:00

time_zonestringOptional

The timezone for the data stats.Defaults to UTC if not provided.

Example: America/Sao_Paulo

Responses

200Success

application/json

404Error

application/json

post

/v2/residential/sub_user_traffic_usage

HTTPcURLJavaScriptPython

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

{
  "sub_uid": 652,
  "start_date": "2025-12-08 00:00:00",
  "end_date": "2025-12-08 00:00:00",
  "time_zone": "America/Sao_Paulo"
}

{
  "code": 0,
  "data": {
    "list": [
      {
        "sub_uid": 652,
        "flow_traffic_usage": 0,
        "day": "2025-12-08",
        "hour": "00:00"
      }
    ]
  },
  "msg": "success",
  "timestamp": 1769514775
}

Check Users Traffic Usage

post

Support resellers to check real-time authentication account traffic usage 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: 652

uidintegerRequired

The id of the user

Example: 262

start_datenumberOptional

Start time. Grouped by hour if equal to end time; otherwise grouped by day.

Example: 2025-12-08 00:00:00

end_datenumberOptional

End Time (datetime)

Example: 2025-12-08 00:00:00

time_zonestringOptional

The timezone for the data stats.Defaults to UTC if not provided.

Example: America/Sao_Paulo

Responses

200Success

application/json

404Error

application/json

post

/v2/residential/user_traffic_usage

HTTPcURLJavaScriptPython

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

{
  "sub_uid": 652,
  "uid": 262,
  "start_date": "2025-12-08 00:00:00",
  "end_date": "2025-12-08 00:00:00",
  "time_zone": "America/Sao_Paulo"
}

{
  "code": 0,
  "data": {
    "count": 0,
    "list": [
      {
        "uid": 262,
        "sub_uid": 652,
        "flow_traffic_usage": 0,
        "day": "2025-12-08",
        "hour": "00:00"
      }
    ]
  },
  "msg": "success",
  "timestamp": 1769514659
}

Check IP Whitelist Traffic Consumption

post

Support resellers to check real-time IP whitelist traffic usage 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

ip_whiteliststringRequired

Ip whitelist

Example: 10.0.0.1

start_datenumberOptional

Start time. Grouped by hour if equal to end time; otherwise grouped by day.

Example: 2025-12-08 00:00:00

end_datenumberOptional

End Time (datetime)

Example: 2025-12-08 00:00:00

time_zonestringOptional

The timezone for the data stats.Defaults to UTC if not provided.

Example: America/Sao_Paulo

Responses

200Success

application/json

404Error

application/json

post

/v2/residential/ip_whitelist_traffic_usage

HTTPcURLJavaScriptPython

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

{
  "sub_uid": 123,
  "ip_whitelist": "10.0.0.1",
  "start_date": "2025-12-08 00:00:00",
  "end_date": "2025-12-08 00:00:00",
  "time_zone": "America/Sao_Paulo"
}

{
  "code": 0,
  "data": {
    "count": 0,
    "list": [
      {
        "sub_uid": 2926,
        "ip_whitelist": "6.21.16.33",
        "day": "2025-12-08",
        "hour": "00:00",
        "residential_traffic_usage": 0
      }
    ]
  },
  "msg": "success",
  "timestamp": 1766643974
}

Get Target Traffic Stats

post

Retrieves traffic usage statistics grouped by target for a specified time range.

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

uidintegerOptional

The id of the user

Example: 668

ip_whiteliststringOptional

Ip whitelist

Example: 10.0.0.1

start_datestringOptional

Start time. Grouped by hour if equal to end time; otherwise grouped by day.

Example: 2025-12-08 00:00:00

end_datestringOptional

End time

Example: 2025-12-08 00:00:00

targetintegerOptional

target

Example: google.com

time_zoneintegerOptional

The timezone for the data stats.Defaults to UTC if not provided.

Example: America/Sao_Paulo

pageintegerOptional

page

Example: 1

limitintegerOptional

page size

Example: 10

Responses

200Success

application/json

post

/v2/residential/get_target_traffic_stats

HTTPcURLJavaScriptPython

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

{
  "sub_uid": 123,
  "uid": 668,
  "ip_whitelist": "10.0.0.1",
  "start_date": "2025-12-08 00:00:00",
  "end_date": "2025-12-08 00:00:00",
  "target": "google.com",
  "time_zone": "America/Sao_Paulo",
  "page": 1,
  "limit": 10
}

200Success

{
  "code": 0,
  "data": {
    "list": [
      {
        "uid": 24,
        "account_id": 14,
        "white_ip": "",
        "address": "test11232300.com",
        "flow": 23,
        "count": 1
      }
    ],
    "total": 4
  },
  "msg": "success",
  "timestamp": 1766397614
}

Get Traffic Usage Logs

post

Retrieves traffic consumption details for each proxy request within a specified time range.

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

uidintegerOptional

The id of the user

Example: 668

ip_whiteliststringOptional

Ip whitelist

Example: 10.0.0.1

start_datestringOptional

Start time (datetime)

Example: 2025-12-08 00:00:00

end_datestringOptional

End Time (datetime)

Example: 2025-12-08 00:00:00

time_zonestringOptional

The timezone for the data stats.Defaults to UTC if not provided.

Example: America/Sao_Paulo

pageintegerOptional

page

Example: 1

limitintegerOptional

page size

Example: 10

Responses

200Success

application/json

post

/v2/residential/get_traffic_usage_logs

HTTPcURLJavaScriptPython

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

{
  "sub_uid": 123,
  "uid": 668,
  "ip_whitelist": "10.0.0.1",
  "start_date": "2025-12-08 00:00:00",
  "end_date": "2025-12-08 00:00:00",
  "time_zone": "America/Sao_Paulo",
  "page": 1,
  "limit": 10
}

200Success

{
  "code": 0,
  "data": {
    "list": [
      {
        "uid": 12,
        "account_id": 0,
        "use_time": "2025-12-19 04:00:00",
        "mark_user_ip": "12.18.14.77",
        "mark_user_port": "0323",
        "address": "test12190300.com",
        "flow": 2,
        "country": "va"
      }
    ]
  }
}