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-userURL
HEADERS
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())
Example Response
{
'success': True, 'sub_user': {
'id': 26512, 'username': 'h7FoIb2858AMqb1vRFlcEL', 'password': '9373dyqv1q2wjE',
'available_traffic': 0, 'used_traffic': 0}
}
POST
Give trafficURL
Request parameters:
- traffic: float | integer, required
- sub_user_id: integer, required
HEADERS
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())
Example Response
{
'success': True, 'sub_user': {
'id': 26512, 'username': 'h7FoIb2858AMqb1vRFlcEL', 'password': '9373dyqv1q2wjE',
'available_traffic': 3.5, 'used_traffic': 0}
}
POST
Take trafficURL
Request parameters:
- traffic: float | integer, required
- sub_user_id: integer, required
HEADERS
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())
Example Response
{
'success': True, 'sub_user': {
'id': 26512, 'username': 'h7FoIb2858AMqb1vRFlcEL', 'password': '9373dyqv1q2wjE',
'available_traffic': 1.2, 'used_traffic': 1.3}
}
POST
Delete sub-userURL
Request parameters:
- sub_user_id: integer, required
Traffic left will be transferred back to main user.
HEADERS
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())
Example Response
{
'success': True
}
POST
Sub-user infoURL
Request parameters:
- sub_user_id: integer, required
HEADERS
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())
Example Response
{
'success': True, 'sub_user': {
'id': 26512, 'username': 'h7FoIb2858AMqb1vRFlcEL', 'password': '9373dyqv1q2wjE',
'available_traffic': 1.2, 'used_traffic': 1.3}
}
POST
Update sub-userURL
Request parameters:
- sub_user_id: integer, required
- new_username: bool, default value: False
- new_password: bool. default value: False
HEADERS
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())
Example Response
{
'success': True, 'sub_user': {
'id': 26512, 'username': 'dfbdf235d', 'password': '9373dyqv1q2wjE',
'available_traffic': 1.2, 'used_traffic': 1.3}
}
GET
Show sub-usersURL
- Returns the number and list of sub-users
HEADERS
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())
Example Response
{
'success': True, 'count': 3, 'sub_users_ids': [1561, 351, 734734]
}