Subuser usage requests - ProxyScrape Docs

GET

/

v4

/

account

/

{subAccountId}

/

residential

/

subuser

/

{subUserId}

/

usage-requests

Subuser usage requests

curl --request GET \
  --url https://api.proxyscrape.com/v4/account/{subAccountId}/residential/subuser/{subUserId}/usage-requests \
  --header 'api-token: <api-key>'

import requests

url = "https://api.proxyscrape.com/v4/account/{subAccountId}/residential/subuser/{subUserId}/usage-requests"

headers = {"api-token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'api-token': '<api-key>'}};

fetch('https://api.proxyscrape.com/v4/account/{subAccountId}/residential/subuser/{subUserId}/usage-requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "Host": "<string>",
    "requests": 123,
    "bytes": 123,
    "avg_bytes_per_request": 123
  }
]

Authorizations

api-token

string

header

required

API key. Create and manage keys at /v4/account/api-keys or in the dashboard.

Path Parameters

subAccountId

string<uuid>

required

The residential account id.

subUserId

string

required

The residential sub-user id — the id field returned by GET /v4/account/{subAccountId}/residential/subuser/get. For the primary residential account this is the same value as subAccountId.

Query Parameters

days

integer

default:1

Number of days of history to include, counting back from now. Data is bucketed per hour, so the window covers days × 24 hours. Defaults to 1.

Required range: x >= 1

length

integer

default:10

Maximum number of hosts to return (page size). Defaults to 10.

Required range: x >= 1

start

integer

default:1

Offset of the first host to return, for pagination. Defaults to 1.

Required range: x >= 0

Response

200 - application/json

Per-host request statistics, ordered by bytes used (descending).

Host

string

Destination host.

requests

integer

Number of requests made to this host.

bytes

integer

Total bytes used for this host.

avg_bytes_per_request

number

Average bytes per request for this host.

Subuser usage requests

curl --request GET \
  --url https://api.proxyscrape.com/v4/account/{subAccountId}/residential/subuser/{subUserId}/usage-requests \
  --header 'api-token: <api-key>'

import requests

url = "https://api.proxyscrape.com/v4/account/{subAccountId}/residential/subuser/{subUserId}/usage-requests"

headers = {"api-token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'api-token': '<api-key>'}};

fetch('https://api.proxyscrape.com/v4/account/{subAccountId}/residential/subuser/{subUserId}/usage-requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "Host": "<string>",
    "requests": 123,
    "bytes": 123,
    "avg_bytes_per_request": 123
  }
]