Proxy 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
Available products

URL

HEADERS
Authorization API Token


Example Request 
import requests

url = "https://bypass.io/api/available-products"

headers = {
    "Authorization": "YOUR_API_TOKEN"
}

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

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

{'success': True, 'products': [{'product_id': 2, 'name': 'Sneaker DC',
                                    'plans': [{'plan_id': 4, 'name': '30 Days', 'price': 2.0, 'minQuantity': 5},
                                              {'plan_id': 16, 'name': '1 day', 'price': 1.0, 'minQuantity': 5}, ...],
                                    'locations': [{'location_id': 3, 'name': 'United States'},
                                                  {'location_id': 4, 'name': 'United Kingdom'}, ...]},
                                   {'product_id': 3, 'name': 'Datacenter',
                                    'plans': [{'plan_id': 5, 'name': '30 Days', 'price': 1.8, 'minQuantity': 5},
                                              {'plan_id': 26, 'name': '60 Days', 'price': 3.6, 'minQuantity': 5}, ...],
                                    'locations': [{'location_id': 6, 'name': 'United States'},
                                                  {'location_id': 7, 'name': 'United Kingdom'}, ...]},
                                   {'product_id': 9, 'name': 'Static Residential',
                                    'plans': [{'plan_id': 22, 'name': '30 Days', 'price': 4.0, 'minQuantity': 1},
                                              {'plan_id': 23, 'name': '1 Day (24 hours)', 'price': 2.0,
                                               'minQuantity': 1}, ...],
                                    'locations': [{'location_id': 16, 'name': 'United States'},
                                                  {'location_id': 17, 'name': 'Austria'}, ...]}
                                   ]}
POST
Calculate order price

URL

Request parameters:

- product_id: integer, "product_id" from "Available products" method, required

- plan_id: integer, "plan_id" from "Available products" method, required

- quantity: integer, from 1 to 10000, required

-country_id: integer, "location_id from "Available products" method", required

HEADERS
Authorization API Token


Example Request 
import requests

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

payload = {
    "product_id": 3,
    "plan_id": 26,
    "quantity": 5,
    "country_id": 7,
}

headers = {
    "Authorization": "YOUR_API_TOKEN"
}

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

print(response.json())
curl -X POST \
https://bypass.io/api/calculate-order-price \
-H 'Authorization: YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"product_id": 3, "plan_id": 26, "quantity": 5, "country_id": 7}'
Example Response 
{
    'success': True,
    'final_price': 17.1,
    'discount': 0.9,
    'discount_percent': 5
}
POST
Create order

URL

Request parameters:

- product_id: integer, "product_id" from "Available products" method, required

- plan_id: integer, "plan_id" from "Available products" method, required

- quantity: integer, from 1 to 10000, required

-country_id: integer, "location_id from "Available products" method", required

-auto_renew: bool, default value: False

HEADERS
Authorization API Token


Example Request 
import requests

url = "https://bypass.io/api/create-order"

payload = {
    "product_id": 9,
    "plan_id": 23,
    "quantity": 1,
    "country_id": 17,
}

headers = {
    "Authorization": "YOUR_API_TOKEN"
}

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

print(response.json())
curl -X POST \
https://bypass.io/api/create-order \
-H 'Authorization: YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"product_id": 9, "plan_id": 23, "quantity": 1, "country_id": 17}'
Example Response 
{
    'success': True,
    'order_id': 371273
}
POST
Get orders

URL

Request parameters:

- proxy_type: string

possible values

• 'static_residential'
• 'datacenter'
• 'sneaker'
• 'lte'

HEADERS
Authorization API Token


Example Request 
import requests

url = "https://bypass.io/api/get-orders"

headers = {
    "Authorization": "YOUR_API_TOKEN"
}

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

print(response.json())
curl -X POST \
https://bypass.io/api/get-orders \
-H 'Authorization: YOUR_API_TOKEN'
Example Response 
{
     'success': True,
     'orders_exists': True,
     'orders': [{'proxy_type': 'static_residential', 'orders_count': 19,
                'orders': [
                {'order_id': 235262,
                'product_name': 'Static residential proxy',
                'plan_name': '1 day',
                'location': ' United Kingdom', 'quantity': 1,
                'auto_renew': False, 'country_id': 20,
                'created_at': '2024-08-01T09:18:22.346843Z',
                'expires': '2024-07-31T16:18:30.205163Z',
                'plan_id': 23, 'paid': 'Paid', 'price': 2.0,
                'status': 'Inactive'}, ...]},
                {'order_id': 457236,
                'product_name': 'LTE proxy',
                'plan_name': '1 Day( 24 hours)',
                'location': 'United States',
                'quantity': 2, 'price': 1.0,
                'country_id': 'US',
                'created_at': '2024-08-13T04:11:28.476813Z',
                'expires': None,
                'paid': 'Not paid',
                'status': 'Active',
                'state': 'DC'}, ...]
}
POST
Get order

URL

Request parameters:

- proxy_type: string, required

possible values

• 'static_residential'
• 'datacenter'
• 'sneaker'
• 'lte'

- order_id: integer, required

HEADERS
Authorization API Token


Example Request 
import requests

url = "https://bypass.io/api/get-order"

payload = {
    "proxy_type": "static_residential",
    "order_id": 457236
}

headers = {
    "Authorization": "YOUR_API_TOKEN"
}

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

print(response.json())
curl -X POST \
https://bypass.io/api/get-order \
-H 'Authorization: YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"proxy_type": "static_residential", "order_id": 457236}'
Example Response 
{
    'success': True, 'order': {
    'order_id': 457236, 'product_name': 'Static residential proxy', 'plan_name': '1 day',
    'location': ' United Kingdom', 'quantity': 1, 'auto_renew': False, 'country_id': 20,
    'created_at': '2024-08-01T09:18:22.346843Z', 'expires': '2024-07-31T16:18:30.205163Z',
    'plan_id': 23, 'paid': 'Paid', 'price': 2.0, 'status': 'Inactive'}
}
POST
Get order credentials

URL

Request parameters:

- proxy_type: string, required

possible values

• 'static_residential'
• 'datacenter'
• 'sneaker'
• 'lte'

- order_id: integer, required

- socks5: bool, required

HEADERS
Authorization API Token


Example Request 
import requests

url = "https://bypass.io/api/get-order-credentials"

payload = {
    "proxy_type": "static_residential",
    "order_id": 457236,
    "socks5": False
}

headers = {
    "Authorization": "YOUR_API_TOKEN"
}

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

print(response.json())
curl -X POST \
https://bypass.io/api/get-order-credentials \
-H "Authorization: YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
    "proxy_type": "static_residential",
    "order_id": 457236,
    "socks5": false
  }'
Example Response 
{
    'success': True,
    'credentials': [
    {'host': '92.61.102.94', 'port': '12323', 'username': '11a013f9vb62v', 'password': '06db1dd8c1'}, ...]
}
POST
Extend order

URL

Request parameters:

- proxy_type: string, required

possible values

• 'static_residential'
• 'datacenter'
• 'sneaker'
• 'lte'

- order_id: integer, required

Returns the new order id

HEADERS
Authorization API Token


Example Request 
import requests

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

payload = {
    "proxy_type": "static_residential",
    "order_id": 457236,
}

headers = {
    "Authorization": "YOUR_API_TOKEN"
}

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

print(response.json())
curl -X POST \
https://bypass.io/api/extend_order \
-H 'Authorization: YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"proxy_type": "static_residential", "order_id": 457236}'
Example Response 
{
    'success': True,
    'order_id': 726734
}
Methods
Get balance Available products Calculate order price Create order Get orders Get order Get order credentials Extend order