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 balanceURL
HEADERS
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())
Example Response
{
"success": True,
"balance": 135.5,
"ref_balance": 5.5
}GET
Get USA statesURL
Returns the state code and the number of available proxies
HEADERS
Example Request
import requests
url = "https://bypass.io/api/lte/get-usa-states"
headers = {
"Authorization": "YOUR_API_TOKEN"
}
response = requests.request("GET", url, headers=headers)
print(response.json())Example Response
{
'success': True, 'states': {
'AK': '28', 'AL': '225', 'AR': '79', 'AZ': '172', 'CA': '704'}
}POST
Get proxies by countryURL
Request parameters:
- country_code: string, country codes can be found by calling this method without parameters
HEADERS
Example Request
import requests
url = "https://bypass.io/api/lte/get-proxies-by-country"
headers = {
"Authorization": "YOUR_API_TOKEN"
}
response = requests.request("POST", url, headers=headers)
print(response.json())Example Response
{
'success': True, 'data': [
{'ct': 'AE', 'online': '25'},
{'ct': 'AF', 'online': '26'},
{'ct': 'AG', 'online': '31'},
{'ct': 'AL', 'online': '4'},
{'ct': 'AM', 'online': '16'}]
}POST
Calculate priceURL
Request parameters:
- country_code: string, from "Get proxies by country" method, required
- state: string, from "Get USA states" method, can only be specified if the country code is "US"
- zip_code: string, from "Get Count By Options" method
- proxy_type: string, from "Get Count By Options" method
- quantity: integer, from 1 to 100, required
HEADERS
Example Request
import requests
url = "https://bypass.io/api/lte/calculate-price"
payload = {
"country_code": "US",
"state": "CO",
"quantity": 5,
}
headers = {
"Authorization": "YOUR_API_TOKEN"
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())Example Response
{
'success': True,
'price': 4.0
}POST
Create orderURL
Request parameters:
- country_code: string, from "Get proxies by country" method, required
- state: string, from "Get USA states" method, can only be specified if the country code is "US"
- zip_code: string, from "Get Count By Options" method
- proxy_type: string, from "Get Count By Options" method
- quantity: integer, from 1 to 100, required
HEADERS
Example Request
import requests
url = "https://bypass.io/api/lte/create-order"
payload = {
"country_code": "US",
"state": "CO",
"quantity": 5,
}
headers = {
"Authorization": "YOUR_API_TOKEN"
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())Example Response
{
'success': True,
'order_id': 172361
'price': 4.0
}POST
Get ordersURL
Request parameters:
- proxy_type: string
possible values
• 'static_residential'
• 'datacenter'
• 'sneaker'
• 'lte'
HEADERS
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())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 credentialsURL
Request parameters:
- order_id: integer, required
HEADERS
Example Request
import requests
url = "https://bypass.io/api/lte/get-order-credentials"
payload = {
"order_id": 457236,
}
headers = {
"Authorization": "YOUR_API_TOKEN"
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())Example Response
{
'success': True, 'proxies': [
{'host': '31.91.176.254', 'port': '626074', 'username': '1gsgbg3', 'password': 'n4y3sn'},
{'host': '67.613.110.468', 'port': '59628', 'username': 'bsdf3u5', 'password': 'vbnwy3hn'}]
}POST
Get Count By OptionsURL
Request parameters:
- country_code: string, from "Get proxies by country" method, required
- state: string, from "Get USA states" method, can only be specified if the country code is "US"
- zip_code: string
- proxy_type: string
The method returns the quantity of available proxies for the specified parameters, as well as the available zip and type lists.
HEADERS
Example Request
import requests
url = "https://bypass.io/api/lte/get-count-by-options"
payload = {
"country_code": "US",
"zip_code": "80907",
"proxy_type": "isp"
}
headers = {
"Authorization": "YOUR_API_TOKEN"
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())Example Response
{
'success': True,
'data': {
'available_quantity': 1,
'zip_list': ['80907'],
'type_list': ['isp']
}
}