UNOFFICIAL Python bindings for IPRoyal Pawns (Pawns.app) Dashboard API
Project description
IPRoyal Pawns API
UNOFFICIAL Python bindings for IPRoyal Pawns Dashboard API
Installation
pip install pyIPRoyalPawns
Usage
Login with username and password:
from pyIPRoyalPawns import IPRoyalPawns
# Your IPRoyalPawns (IPR) login username/email and password
USERNAME = ""
PASSWORD = ""
# Initialise the IPRoyalPawns object
user = IPRoyalPawns()
# Optionally, when instantiating you can pass in the following attributes to the IPRoyalPawns class:
Attribute | Description | Default Value |
---|---|---|
API_BASE_URL | The API BASE URL | https://api.pawns.app |
API_PREFIX | The API PREFIX | /api |
API_VERSION | The API VERSION | /v1 |
# Call the complete_login_flow method to login and set the JWT in self.jwt
user.complete_login_flow(USERNAME, PASSWORD)
Add proxies for future requests:
from pyIPRoyalPawns import IPRoyalPawns
# 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 user balance
# Get balance and traffic sold as shown on the dashboard. user.balance()
-
Remove a proxy
# Removes a proxy for future requests. user.remove_proxy()
-
Get all the devices
# Get all the devices user.devices()
-
Payout history
# Get payout history user.payout_history()
-
Is Logged In
# Check if you're logged in user.is_logged_in()
-
Logout
# Logged out user.logout()
-
Set JWT Token
# Set JWT Token if you have one (otherwise use the login()) user.set_jwt_token(TOKEN)
Exceptions
- The following exceptions are defined.
Exception Reason NotLoggedInError
Raised when you try to access protected routes (dashboard, payout history, etc). AlreadyLoggedInError
Raised when you try to login when you're already logged in.
Liked my work?
Consider donating:
-
BTC: bc1q5y8z0cpgvafedvmwcfjn682skpr67e2du00acy
-
LTC: LcquWHprnVRHY86u5rNDW6U8VD3WVbZV4h
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
pyIPRoyalPawns-1.1.3.tar.gz
(5.2 kB
view hashes)
Built Distribution
Close
Hashes for pyIPRoyalPawns-1.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 23307d264e63357a5285c8026084eec100274e69bfd44dfac1ce4f28bc88433c |
|
MD5 | f53159affbfcde240d7792e49e88edd9 |
|
BLAKE2b-256 | 2f30dc472931401be9beb4d649a595121afa5183956e59e1b6c96c8b28350d57 |