# IPRoyal Pawns API
UNOFFICIAL Python bindings for IPRoyal Pawns Dashboard API
## Installation
```BASH
pip install pyIPRoyalPawns
```
## Usage
---
### Login with username and password:
```PYTHON
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 |
```PYTHON
# 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:
```PYTHON
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
```PYTHON
# Get balance and traffic sold as shown on the dashboard.
user.balance()
```
---
2. Remove a proxy
```PYTHON
# Removes a proxy for future requests.
user.remove_proxy()
```
---
3. Get all the devices
```PYTHON
# Get all the devices
user.devices()
```
---
4. Payout history
```PYTHON
# Get payout history
user.payout_history()
```
---
5. Is Logged In
```PYTHON
# Check if you're logged in
user.is_logged_in()
```
---
6. Logout
```PYTHON
# Logged out
user.logout()
```
---
7. Set JWT Token
```PYTHON
# 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
Raw data
{
"_id": null,
"home_page": "https://github.com/coder-amogh/pyIPRoyalPawns",
"name": "pyIPRoyalPawns",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,iproyal,ipr,passive income,iproyal pawns api,iproyal pawns dashboard,python iproyal pawns,pawns.app",
"author": "coder-amogh (Amogh Datar)",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/46/e1/c6aeb9f8c8d21e97c097885cb2221bbe22e417e22d21854c2bd95304c1f2/pyIPRoyalPawns-1.1.5.tar.gz",
"platform": null,
"description": "\n# IPRoyal Pawns API\n\nUNOFFICIAL Python bindings for IPRoyal Pawns Dashboard API\n\n## Installation\n\n```BASH\npip install pyIPRoyalPawns\n```\n\n## Usage\n\n---\n\n### Login with username and password:\n\n```PYTHON\nfrom pyIPRoyalPawns import IPRoyalPawns\n\n# Your IPRoyalPawns (IPR) login username/email and password\nUSERNAME = \"\"\nPASSWORD = \"\"\n\n# Initialise the IPRoyalPawns object\nuser = IPRoyalPawns()\n\n# Optionally, when instantiating you can pass in the following attributes to the IPRoyalPawns class:\n```\n\n| Attribute | Description | Default Value |\n|----------------|--------------------|---------------------------------|\n| API_BASE_URL | The API BASE URL | https://api.pawns.app |\n| API_PREFIX | The API PREFIX | /api |\n| API_VERSION | The API VERSION | /v1 |\n\n```PYTHON\n# Call the complete_login_flow method to login and set the JWT in self.jwt\nuser.complete_login_flow(USERNAME, PASSWORD)\n```\n\n---\n\n### Add proxies for future requests:\n\n```PYTHON\nfrom pyIPRoyalPawns import IPRoyalPawns\n\n# With authentication & protocol\nuser.set_proxy(\"ip:port:username:password\", \"socks5\")\n\n# Without authentication & protocol\nuser.set_proxy(\"ip:port\", \"socks5\")\n\n# Alternative way\nuser.set_socks5_proxy(\"ip:port\")\nuser.set_socks5_proxy(\"ip:port:username:password\")\nuser.set_https_proxy(\"ip:port\")\nuser.set_https_proxy(\"ip:port:username:password\")\n```\n\n## Functions\n\n---\n\n1. Get user balance\n\n ```PYTHON\n # Get balance and traffic sold as shown on the dashboard.\n user.balance()\n ```\n---\n\n2. Remove a proxy\n\n ```PYTHON\n # Removes a proxy for future requests.\n user.remove_proxy()\n ```\n---\n\n3. Get all the devices\n\n ```PYTHON\n # Get all the devices\n user.devices()\n ```\n---\n\n4. Payout history\n\n ```PYTHON\n # Get payout history\n user.payout_history()\n ```\n---\n\n5. Is Logged In\n\n ```PYTHON\n # Check if you're logged in\n user.is_logged_in()\n ```\n---\n\n6. Logout\n\n ```PYTHON\n # Logged out\n user.logout()\n ```\n---\n\n7. Set JWT Token\n\n ```PYTHON\n # Set JWT Token if you have one (otherwise use the login())\n user.set_jwt_token(TOKEN)\n ```\n---\n\n## Exceptions\n\n- The following exceptions are defined.\n Exception | Reason\n --- | ---\n `NotLoggedInError` | Raised when you try to access protected routes (dashboard, payout history, etc).\n `AlreadyLoggedInError` | Raised when you try to login when you're already logged in.\n---\n\n## Liked my work?\n\n---\n\nConsider donating:\n\n- BTC: bc1q5y8z0cpgvafedvmwcfjn682skpr67e2du00acy\n\n- LTC: LcquWHprnVRHY86u5rNDW6U8VD3WVbZV4h\n\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "UNOFFICIAL Python bindings for IPRoyal Pawns (Pawns.app) Dashboard API",
"version": "1.1.5",
"split_keywords": [
"python",
"iproyal",
"ipr",
"passive income",
"iproyal pawns api",
"iproyal pawns dashboard",
"python iproyal pawns",
"pawns.app"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "874bacbe5548a4b2d7cd661df6c52b2527b5f2b0eb1812eabf08becc6ac52ec2",
"md5": "38576558ad7ae65158797adf9a17e478",
"sha256": "a76d1a984b6229004b01a1139b74c91ec78b7f56e24607fd42835f34796338cb"
},
"downloads": -1,
"filename": "pyIPRoyalPawns-1.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "38576558ad7ae65158797adf9a17e478",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6066,
"upload_time": "2023-01-21T03:10:00",
"upload_time_iso_8601": "2023-01-21T03:10:00.203487Z",
"url": "https://files.pythonhosted.org/packages/87/4b/acbe5548a4b2d7cd661df6c52b2527b5f2b0eb1812eabf08becc6ac52ec2/pyIPRoyalPawns-1.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "46e1c6aeb9f8c8d21e97c097885cb2221bbe22e417e22d21854c2bd95304c1f2",
"md5": "4346a8681e8fdb77bdf151c3267152a1",
"sha256": "79c14e0f1f7d2ef461975170427b0d51d38cf4469bd615ca86e9e548f550d9f1"
},
"downloads": -1,
"filename": "pyIPRoyalPawns-1.1.5.tar.gz",
"has_sig": false,
"md5_digest": "4346a8681e8fdb77bdf151c3267152a1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5261,
"upload_time": "2023-01-21T03:10:02",
"upload_time_iso_8601": "2023-01-21T03:10:02.720268Z",
"url": "https://files.pythonhosted.org/packages/46/e1/c6aeb9f8c8d21e97c097885cb2221bbe22e417e22d21854c2bd95304c1f2/pyIPRoyalPawns-1.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-21 03:10:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "coder-amogh",
"github_project": "pyIPRoyalPawns",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pyiproyalpawns"
}
JSON
