Residential Documentation

Harness the power of data collection through

Get started!

All requests require an API Token, you can get it in your personal account

All requests return a boolean value "status", or the request is unsuccessful, then "message" with the error text is also returned

GET
Get balance

URL

HEADERS
Authorization API Token


Example Request 
import requests

url = "https://bypass.io/api/balance"

headers = {
    "Authorization": "YOUR_API_TOKEN"
}

response = requests.request("GET", url, headers=headers)

print(response.json())
                        
curl -X GET \
https://bypass.io/api/balance \
-H 'Authorization: YOUR_API_TOKEN'
Example Response 
{
    "success": True,
    "balance": 135.5,
    "ref_balance": 5.5
}
GET
Show available traffic

URL

HEADERS
Authorization API Token


Example Request 
import requests

url = "https://bypass.io/api/residential/avaiable-traffic"

headers = {
    "Authorization": "YOUR_API_TOKEN"
}

response = requests.request("GET", url, headers=headers)

print(response.json())
                        
curl -X GET \
https://bypass.io/api/residential/avaiable-traffic \
-H 'Authorization: YOUR_API_TOKEN'
Example Response 

{
    "success": True,
    "available_traffic": 2.55
}
POST
Calculate price

URL

Request parameters:

- traffic: integer, from 1 to 5000, required

HEADERS
Authorization API Token


Example Request 
import requests

url = "https://bypass.io/api/residential/calculate-price"

payload = {
    "traffic": 5
}
headers = {
    "Authorization": "YOUR_API_TOKEN"
}

response = requests.request("POST", url, headers=headers, json=payload)

print(response.json())
curl -X POST \
https://bypass.io/api/residential/calculate-price \
-H 'Authorization: YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"traffic": 5}'
Example Response 

{
    'success': True,
    'final_price': 29.8,
    'discount': 5.2,
    'discount_percent': 15
}
GET
Available countries

URL

HEADERS
Authorization API Token


Example Request 
import requests

url = "https://bypass.io/api/residential/avaiable-countries"

headers = {
    "Authorization": "YOUR_API_TOKEN"
}

response = requests.request("GET", url, headers=headers)

print(response.json())
curl -X GET \
https://bypass.io/api/residential/avaiable-countries \
-H 'Authorization: YOUR_API_TOKEN'
Example Response 
{
'success': True, 'countries': [
  ['ad', 'Andorra'],
  ['ae', 'United Arab Emirates'],
  ['af', 'Afghanistan'], ...
  ]
}
POST
Available cities

URL

Request parameters:

- country_code: string, country code from "Available countries" method, required

Returns lists of cities where the first element is the city code and the second element is the city name

HEADERS
Authorization API Token


Example Request 
import requests

url = "https://bypass.io/api/residential/avaiable-cities"

payload = {
    "country_code": "us"
}

headers = {
    "Authorization": "YOUR_API_TOKEN"
}

response = requests.request("POST", url, headers=headers, json=payload)

print(response.json())
curl -X POST \
https://bypass.io/api/residential/avaiable-cities \
-H 'Authorization: YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"country_code": "us"}'
Example Response 
{"success": True, "cities": [
    ["abbeville", "Abbeville"],
    ["aberdeen", "Aberdeen"],
    ["abilene", "Abilene"],
    ["acworth", "Acworth"],
    ["adrian", "Adrian"], ...]
 }
POST
Generate proxy list

URL

Request parameters:

- format: string

default: '{hostname}:{port}:{username}:{password}'

possible values:

• '{hostname}:{port}:{username}:{password}'
• '{hostname}:{port}@{username}:{password}'
• '{username}:{password}:{hostname}:{port}'
• '{username}:{password}@{hostname}:{port}'

- protocol: string

default: 'http|https'

possible values:

• 'http|https'
•'socks5'

- rotation, string

default: 'random'

possible values:

• 'random'
• 'sticky'

-lifetime: string, if rotation type is sticky, you can provide a timeframe

default: '24h'

possible values:

• 1-59s
• 1-59m
• 1-24h

- country:string, country code from "Available countries" method

- city:string, city code from "Available cities" method, the parameter can only be specified if the "country" parameter is specified

- proxy_count: integer, number of proxies to generate, from 1 to 5000

default: 10

HEADERS
Authorization API Token


Example Request 
import requests

url = "https://bypass.io/api/residential/generate-proxy-list"

payload = {
    "country": "us",
    "city": "adrian",
    "rotation": "sticky",
    "lifetime": "30m",
    "proxy_count": 5
}

headers = {
    "Authorization": "YOUR_API_TOKEN"
}

response = requests.request("POST", url, headers=headers, json=payload)

print(response.json())
curl -X POST \
https://bypass.io/api/residential/generate-proxy-list \
-H 'Authorization: YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"country": "us", "city": "adrian", "rotation": "sticky", "lifetime": "30m", "proxy_count": 5}'
Example Response 
{'success': True, 'proxies_list': [
    'proxy.bypass.io:12321:mEHbdr23:8qzb39xCQ4hEBx_country-us_city-adrian_session-03281e7c_lifetime-30m',
    'proxy.bypass.io:12321:mEHbdr23:8qzb39xCQ4hEBx_country-us_city-adrian_session-a6117bd3_lifetime-30m',
    'proxy.bypass.io:12321:mEHbdr23:8qzb39xCQ4hEBx_country-us_city-adrian_session-46s98b88_lifetime-30m',
    'proxy.bypass.io:12321:mEHbdr23:8qzb39xCQ4hEBx_country-us_city-adrian_session-fzf6nc0c_lifetime-30m',
    'proxy.bypass.io:12321:mEHbdr23:8qzb39xCQ4hEBx_country-us_city-adrian_session-f7e8845e_lifetime-30m']
 }
POST
Change proxy password

URL

HEADERS
Authorization API Token


Example Request 
import requests

url = "https://bypass.io/api/residential/change-password"

headers = {
    "Authorization": "YOUR_API_TOKEN"
}

response = requests.request("POST", url, headers=headers)

print(response.json())
curl -X POST \
https://bypass.io/api/residential/change-password \
-H 'Authorization: YOUR_API_TOKEN'
Example Response 
{
    'success': True,
    'new_password': 'gGDFnh36sbh57h4'
}
POST
Buy traffic

URL

Request parameters:

- traffic: integer, from 1 to 5000, required

HEADERS
Authorization API Token


Example Request 
import requests

url = "https://bypass.io/api/residential/buy-traffic"

payload = {
    "traffic": 5,
}

headers = {
    "Authorization": "YOUR_API_TOKEN"
}

response = requests.request("POST", url, headers=headers, json=payload)

print(response.json())
curl -X POST \
https://bypass.io/api/residential/buy-traffic \
-H 'Authorization: YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"traffic": 5}'
Example Response 
{
    'success': True,
    'available_traffic': 12.55,
    'order_id': 182652
}
Methods
Get balance Show available traffic Calculate price Available countries Available cities Generate proxy list Change proxy password Buy traffic