Skip to main content

UNOFFICIAL Python bindings for IPRoyal Pawns 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 HoneyGain 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://pawns.iproyal.com
# Call the login method
user.login(USERNAME, PASSWORD)

Add proxies for future requests:

from pyIPRoyalPawns import IPRoyalPawns

# With authentication
user.set_proxy("ip:port:username:password")

# Without authentication
user.set_proxy("ip:port")

Functions


  1. Get user dashboard

    user.dashboard()
    

  1. Remove a proxy

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

  1. Get all the devices

    # Get all the devices shown on dashboard
    user.devices()
    

Exceptions

  • The following exceptions are defined.
    Exception Reason
    NotLoggedInError Raised when you try to access protected routes (dashboard, payout history, etc).
    HTMLWebpageParserError Raised when the webpage parser cannot parse the response of the dashboard request (typically when you're rate limited or a broken connection)

Liked my work?


Consider donating:

  • BTC: bc1q5y8z0cpgvafedvmwcfjn682skpr67e2du00acy

  • LTC: LcquWHprnVRHY86u5rNDW6U8VD3WVbZV4h

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyIPRoyalPawns-0.2.2.tar.gz (5.3 kB view hashes)

Uploaded Source

Built Distribution

pyIPRoyalPawns-0.2.2-py3-none-any.whl (5.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page