UNOFFICIAL Python bindings for Proxyrack Dashboard API
Project description
Proxyrack API
UNOFFICIAL Python bindings for Proxyrack Dashboard API
Installation
pip install pyProxyrack
Usage
Login with API Key:
from pyProxyrack import Proxyrack
# Your Proxyrack login email and password
API_KEY = "" # Generate an API key from your dashboard and store it here
# Initialise the Proxyrack object
user = Proxyrack()
# Optionally, when instantiating you can pass in the following attributes to the Proxyrack class:
Attribute | Description | Default Value |
---|---|---|
API_BASE_URL | The API BASE URL | https://peer.proxyrack.com |
API_PREFIX | The API PREFIX | /api |
API_VERSION | The API VERSION | "" |
# Call the complete_login_flow method to login and set the JWT in self.jwt
user.set_api_key(API_KEY)
Add proxies for future requests:
from pyProxyrack import Proxyrack
# With authentication & protocol
user.set_proxy("ip:port:username:password", "socks5")
# Without authentication & protocol
user.set_proxy("ip:port", "socks5")
# Alternative way
user.set_socks5_proxy("ip:port")
user.set_socks5_proxy("ip:port:username:password")
user.set_https_proxy("ip:port")
user.set_https_proxy("ip:port:username:password")
Functions
-
Get device bandwidth
# Get device bandwidth used from date_start to date_end. user.get_device_bandwidth_usage(device_id: str, date_start: str, date_end: str)
device_id
is required (if not passed, it'll combine the usage for all the devices and return the same) anddate_start
anddate_end
are optional and need the formatY-m-d
(Eg: 2023-04-25)Do note you need to use
date_start
anddate_end
together even if you just want to use one.
-
Remove a proxy
# Removes a proxy for future requests. user.remove_proxy()
-
Add/link a device
# Add/link a device to your account user.add_device(device_id: str, device_name: str)
Both are required fields.
-
Delete/unlink a device
# Delete/unlink a device from your account user.delete_device(device_id: str)
-
Is Logged In
# Check if you're logged in user.is_logged_in()
-
Logout
# Logged out user.logout()
-
Get payout balance
# Get available payout balance user.get_balance()
Exceptions
- The following exceptions are defined.
Exception Reason NotLoggedInError
Raised when you try to access protected routes (bandwidth usage, add devices, delete devices, etc).
Liked my work?
Consider donating:
-
BTC: bc1qh04l5tx7gd96wnyyqhr68uptdmqmwwwkcg3hj0
-
LTC: Lg5mMHUCrsSkaRYrfqaum4hodBAt9BSi91
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pyProxyrack-0.1.1.tar.gz
(4.5 kB
view hashes)
Built Distribution
Close
Hashes for pyProxyrack-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e03cbed8f6c2fc0f33e6bd7a3d293bb4a91c09c06631de4fe00f08f5a3297ef6 |
|
MD5 | 6288dc04091faaf71d169aa6dcab7b97 |
|
BLAKE2b-256 | 40f1582ae14f5f7e3e34a850c5bdc380edf29876d8d6595c166a7a2d02e4428e |