Residential Proxies

Operations for residential proxies

Purchase additional traffic (Residential)

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idintegerRequired

Body

amountintegerRequired

Amount in GB

Example: 5

promo_codestring · nullableOptional

Responses

200

Success

application/json

successbooleanRequired

post/user/api/orders/{id}/add-bandwidth

POST /user/api/orders/{id}/add-bandwidth HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "amount": 5,
  "promo_code": "text"
}

200

Success

{
  "success": true
}

Parent (account owner) traffic

get

Returns the parent account's own total and remaining data for the given proxy type, aggregated across the parent's orders. Unlike the sub-user endpoints, this reflects the data of the account owner, not a sub-user.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

proxy_typestringRequired

Proxy type (standart | premium)

Example: standart

Responses

200

Success

application/json

successbooleanRequired

dataintegerRequired

Total allocated data in bytes

data_remainintegerRequired

Remaining data in bytes

data_spentintegerRequired

Consumed data in bytes

400

User resident not set / invalid proxy type

application/json

401

Unauthorized

application/json

get/user/api/proxies/profile

GET /user/api/proxies/profile?proxy_type=standart HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "data": 1,
  "data_remain": 1,
  "data_spent": 1
}

Sub-user list

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

proxy_typestringRequired

Proxy type (standart | premium)

Example: standart

offsetintegerOptionalExample: 0

limitintegerOptionalExample: 20

Responses

200

Success

application/json

successbooleanOptional

get/user/api/proxies/sub-users

GET /user/api/proxies/sub-users?proxy_type=standart HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "success": true,
  "data": [
    {
      "user_id": "text",
      "first_name": "text",
      "proxy_password": "text",
      "data": 1,
      "data_spent": 1,
      "data_remain": 1
    }
  ]
}

Get sub-user by ID

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

user_idstringRequired

Query parameters

proxy_typestringRequired

Proxy type (standart | premium)

Example: standart

Responses

200

Success

application/json

successbooleanOptional

get/user/api/proxies/sub-user/{user_id}

GET /user/api/proxies/sub-user/{user_id}?proxy_type=standart HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "success": true,
  "data": [
    {
      "first_name": "text",
      "proxy_password": "text",
      "data": 1,
      "data_spent": 1
    }
  ]
}

Delete sub-user

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

user_idstringRequired

Responses

200

Success

application/json

successbooleanOptional

dataobjectOptional

delete/user/api/proxies/sub-user/{user_id}

DELETE /user/api/proxies/sub-user/{user_id} HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "success": true,
  "data": {}
}

Edit sub-user (name/package)

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

user_idstringRequired

Query parameters

proxy_typestringRequired

Proxy type (standart | premium)

Example: standart

Body

namestringRequired

Responses

200

Success

application/json

successbooleanOptional

dataobjectOptional

patch/user/api/proxies/sub-user/{user_id}

PATCH /user/api/proxies/sub-user/{user_id}?proxy_type=standart HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

200

Success

{
  "success": true,
  "data": {}
}

Create sub-user

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

proxy_typestringRequired

Proxy type (standart | premium)

Example: standart

Body

namestringRequired

dataintegerRequired

Responses

200

Success

application/json

successbooleanOptional

post/user/api/proxies/sub-user

POST /user/api/proxies/sub-user?proxy_type=standart HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "name": "text",
  "data": 1
}

200

Success

{
  "success": true,
  "data": [
    {
      "user_id": "text",
      "first_name": "text",
      "proxy_password": "text",
      "data": 1,
      "data_spent": 1
    }
  ]
}

Add traffic to sub-user

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

user_idstringRequired

Query parameters

proxy_typestringRequired

Proxy type (standart | premium)

Example: standart

Body

dataintegerRequired

Amount in GB

Example: 5

Responses

200

Success

application/json

successbooleanOptional

dataobjectOptional

post/user/api/proxies/sub-user/{user_id}/data/add

POST /user/api/proxies/sub-user/{user_id}/data/add?proxy_type=standart HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 10

{
  "data": 5
}

200

Success

{
  "success": true,
  "data": {}
}

Subtract traffic from sub-user

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

user_idstringRequired

Query parameters

proxy_typestringRequired

Proxy type (standart | premium)

Example: standart

Body

dataintegerRequired

Amount in GB

Example: 5

Responses

200

Success

application/json

successbooleanOptional

dataobjectOptional

post/user/api/proxies/sub-user/{user_id}/data/subtract

POST /user/api/proxies/sub-user/{user_id}/data/subtract?proxy_type=standart HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 10

{
  "data": 5
}

200

Success

{
  "success": true,
  "data": {}
}

Change sub-user password

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

user_idstringRequired

Query parameters

proxy_typestringRequired

Proxy type (standart | premium)

Example: standart

Responses

200

Success

application/json

successbooleanOptional

dataobjectOptional

post/user/api/proxies/sub-user/{user_id}/password

POST /user/api/proxies/sub-user/{user_id}/password?proxy_type=standart HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "success": true,
  "data": {}
}

Country list

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

proxy_typestringRequired

Proxy type (standart | premium)

Example: standart

Responses

200

Success

application/json

countintegerRequired

get/user/api/proxies/countries

GET /user/api/proxies/countries?proxy_type=standart HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "count": 1,
  "results": [
    {
      "code": "text",
      "name": "text"
    }
  ]
}

Region list

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

proxy_typestringRequired

Proxy type (standart | premium)

Example: standart

country_codestringRequired

ISO country code

Example: DE

Responses

200

Success

application/json

countintegerRequired

get/user/api/proxies/regions

GET /user/api/proxies/regions?proxy_type=standart&country_code=DE HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "count": 1,
  "results": [
    {
      "code": "text",
      "name": "text",
      "country": {
        "code": "text",
        "name": "text"
      }
    }
  ]
}

City list

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

proxy_typestringRequired

Proxy type (standart | premium)

Example: standart

country_codestringRequired

ISO country code

Example: DE

region_codestringRequired

Region code (state/province code)

Example: BE

Responses

200

Success

application/json

countintegerRequired

get/user/api/proxies/cities

GET /user/api/proxies/cities?proxy_type=standart&country_code=DE&region_code=BE HTTP/1.1
Host: user-api.proxyshard.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Success

{
  "count": 1,
  "results": [
    {
      "code": "text",
      "name": "text",
      "country": {
        "code": "text",
        "name": "text"
      },
      "region": {
        "code": "text",
        "name": "text"
      }
    }
  ]
}

PreviousDatacenter & ISP Proxies NextGeneral

Last updated 1 month ago

Was this helpful?