Reseller 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

POST
Create sub-user

URL

HEADERS
Authorization API Token


Example Request 
import requests

url = "https://bypass.io/api/residential/reseller/create-sub-user"

headers = {
    "Authorization": "YOUR_API_TOKEN"
}

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

print(response.json())
                        
curl -X POST \
https://bypass.io/api/residential/reseller/create-sub-user \
-H 'Authorization: YOUR_API_TOKEN'
Example Response 
{
    'success': True, 'sub_user': {
        'id': 26512, 'username': 'h7FoIb2858AMqb1vRFlcEL', 'password': '9373dyqv1q2wjE',
        'available_traffic': 0, 'used_traffic': 0}
}
POST
Give traffic

URL

Request parameters:

- traffic: float | integer, required

- sub_user_id: integer, required

HEADERS
Authorization API Token


Example Request 
import requests

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

payload = {
    "traffic": 2.5,
    "sub_user_id": 26512
}
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/reseller/give-traffic \
-H 'Authorization: YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"traffic": 2.5, "sub_user_id": 26512}'
Example Response 
{
    'success': True, 'sub_user': {
        'id': 26512, 'username': 'h7FoIb2858AMqb1vRFlcEL', 'password': '9373dyqv1q2wjE',
        'available_traffic': 3.5, 'used_traffic': 0}
}
POST
Take traffic

URL

Request parameters:

- traffic: float | integer, required

- sub_user_id: integer, required

HEADERS
Authorization API Token


Example Request 
import requests

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

payload = {
    "traffic": 1.5,
    "sub_user_id": 26512
}
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/reseller/take-traffic \
-H 'Authorization: YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"traffic": 1.5, "sub_user_id": 26512}'
Example Response 
{
    'success': True, 'sub_user': {
        'id': 26512, 'username': 'h7FoIb2858AMqb1vRFlcEL', 'password': '9373dyqv1q2wjE',
        'available_traffic': 1.2, 'used_traffic': 1.3}
}
POST
Delete sub-user

URL

Request parameters:

- sub_user_id: integer, required

Traffic left will be transferred back to main user.

HEADERS
Authorization API Token


Example Request 
import requests

url = "https://bypass.io/api/residential/reseller/delete-sub-user"

payload = {
    "sub_user_id": 26512
}
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/reseller/delete-sub-user \
-H 'Authorization: YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"sub_user_id": 26512}'
Example Response 
{
    'success': True
}
POST
Sub-user info

URL

Request parameters:

- sub_user_id: integer, required

HEADERS
Authorization API Token


Example Request 
import requests

url = "https://bypass.io/api/residential/reseller/info"

payload = {
    "sub_user_id": 26512
}
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/reseller/info \
-H 'Authorization: YOUR_API_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"sub_user_id": 26512}'
Example Response 
{
    'success': True, 'sub_user': {
        'id': 26512, 'username': 'h7FoIb2858AMqb1vRFlcEL', 'password': '9373dyqv1q2wjE',
        'available_traffic': 1.2, 'used_traffic': 1.3}
}
POST
Update sub-user

URL

Request parameters:

- sub_user_id: integer, required

- new_username: bool, default value: False

- new_password: bool. default value: False

HEADERS
Authorization API Token


Example Request 
import requests

url = "https://bypass.io/api/residential/reseller/update-sub-user"

payload = {
    "sub_user_id": 26512,
    "new_username": True,
}
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/reseller/update-sub-user \
-H "Authorization: YOUR_API_TOKEN" \
-H 'Content-Type: application/json' \
-d '{"sub_user_id": 26512, "new_username": true}'
Example Response 
{
    'success': True, 'sub_user': {
        'id': 26512, 'username': 'dfbdf235d', 'password': '9373dyqv1q2wjE',
        'available_traffic': 1.2, 'used_traffic': 1.3}
}
GET
Show sub-users

URL

- Returns the number and list of sub-users

HEADERS
Authorization API Token


Example Request 
import requests

url = "https://bypass.io/api/residential/reseller/sub-users-list"
                      
headers = {
    "Authorization": "YOUR_API_TOKEN"
}

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

print(response.json())
curl -X GET \
https://bypass.io/api/residential/reseller/sub-users-list \
-H 'Authorization: YOUR_API_TOKEN'
Example Response 
{
    'success': True, 'count': 3, 'sub_users_ids': [1561, 351, 734734]
}
Methods
Create sub-user Give traffic Take traffic Delete sub-user Sub-user info Update sub-user Show sub-users