pyIPRoyalPawns

UNOFFICIAL Python bindings for IPRoyal Pawns (Pawns.app) Dashboard API


Keywords
python, iproyal, ipr, passive, income, pawns, api, dashboard, app
License
MIT
Install
pip install pyIPRoyalPawns==1.1.5

Documentation

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


  1. Get user balance

    # Get balance and traffic sold as shown on the dashboard.
    user.balance()

  1. Remove a proxy

    # Removes a proxy for future requests.
    user.remove_proxy()

  1. Get all the devices

    # Get all the devices
    user.devices()

  1. Payout history

    # Get payout history
    user.payout_history()

  1. Is Logged In

    # Check if you're logged in
    user.is_logged_in()

  1. Logout

    # Logged out
    user.logout()

  1. 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