aiorocket2


Nameaiorocket2 JSON
Version 2.0.4 PyPI version JSON
download
home_pageNone
SummaryAsynchronous Python client for xRocket API.
upload_time2025-08-15 11:48:47
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseGNU GPLv3
keywords crypto telegram async asynchronous payments rocket cryptocurrency asyncio crypto-bot cryptopayments xrocket aiorocket aiorocket
VCS
bugtrack_url
requirements aiohttp
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # aiorocket2 🚀

[![PyPI](https://img.shields.io/pypi/v/aiorocket2?color=blue&logo=python&style=flat-square)](https://pypi.org/project/aiorocket2/)
[![Python Version](https://img.shields.io/pypi/pyversions/aiorocket2?style=flat-square)](https://www.python.org/)
[![License](https://img.shields.io/badge/license-GPLv3-blue?style=flat-square)](https://www.gnu.org/licenses/gpl-3.0.en.html)
[![Documentation](https://img.shields.io/badge/docs-online-brightgreen?style=flat-square)](https://aiorocket2.rimmirk.pp.ua)
[![Issues](https://img.shields.io/github/issues/RimMirK/aiorocket2?style=flat-square)](https://github.com/RimMirK/aiorocket2/issues)

**aiorocket2** is an asynchronous Python client for the **xRocket Pay API**, providing full access to all methods and parameters of the payment system.  
All types, enums, and data structures are mirrored as closely as possible to the original API.

---

## 🚀 Features

- Complete wrapper for all xRocket API methods  
- Asynchronous access via `asyncio`  
- Full typing support and enums  
- Direct parameter mapping from API  
- Production-ready and test-friendly  

---

## 📦 Installation

```bash
pip install aiorocket2
```

> Requires Python 3.7+

---

## 🔑 Getting an API Key

1. Open the bot [@xRocket](https://t.me/xRocket) or [@xrocket\_testnet\_bot](https://t.me/xrocket_testnet_bot) for the testnet
2. Go to: **Rocket Pay → Create App → API token**
3. Copy the token and use it in your code

---

## ⚡ Quick Start

```python
import asyncio
from aiorocket2 import xRocketClient

async def main():
    client = xRocketClient(api_key="YOUR_API_KEY")
    
    # Get application info
    info = await client.get_info()
    print(info)
    
    # Example: create a payment
    invoice = await client.create_invoice(
        amount=10, # 10 USDT to pay
        min_payment=0, # For single payment pass 0
        num_payments=1, # For single payment pass 1
        currency="USDT",
        description="Buy some products",
        hidden_message="Thanks for payment!", # this will appear to the payer after payment
        comments_enabled=True
    )
    print(invoice.link)

asyncio.run(main())
```

> All library methods mirror the xRocket API exactly, including types, required and optional parameters.

---

## 📚 Documentation

Full documentation is available online: [aiorocket2 Docs](https://aiorocket2.rimmirk.pp.ua)
Includes:

* Description of all API methods
* Usage examples
* List of all enums and data structures

---

## 👨‍💻 Authors

* [RimMirK](https://github.com/RimMirK)

---

## 📝 License

This project is licensed under **GNU GPLv3**.
[Full license text](https://www.gnu.org/licenses/gpl-3.0.en.html)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "aiorocket2",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "crypto, telegram, async, asynchronous, payments, rocket, cryptocurrency, asyncio, crypto-bot, cryptopayments, xrocket, aiorocket, aiorocket",
    "author": null,
    "author_email": "RimMirK <me@rimmirk.pp.ua>",
    "download_url": "https://files.pythonhosted.org/packages/36/2e/8302fe9d6fee09a723c22ebd6da12d0ce6ab1027c88cb7f56954a5b3d137/aiorocket2-2.0.4.tar.gz",
    "platform": null,
    "description": "# aiorocket2 \ud83d\ude80\r\n\r\n[![PyPI](https://img.shields.io/pypi/v/aiorocket2?color=blue&logo=python&style=flat-square)](https://pypi.org/project/aiorocket2/)\r\n[![Python Version](https://img.shields.io/pypi/pyversions/aiorocket2?style=flat-square)](https://www.python.org/)\r\n[![License](https://img.shields.io/badge/license-GPLv3-blue?style=flat-square)](https://www.gnu.org/licenses/gpl-3.0.en.html)\r\n[![Documentation](https://img.shields.io/badge/docs-online-brightgreen?style=flat-square)](https://aiorocket2.rimmirk.pp.ua)\r\n[![Issues](https://img.shields.io/github/issues/RimMirK/aiorocket2?style=flat-square)](https://github.com/RimMirK/aiorocket2/issues)\r\n\r\n**aiorocket2** is an asynchronous Python client for the **xRocket Pay API**, providing full access to all methods and parameters of the payment system.  \r\nAll types, enums, and data structures are mirrored as closely as possible to the original API.\r\n\r\n---\r\n\r\n## \ud83d\ude80 Features\r\n\r\n- Complete wrapper for all xRocket API methods  \r\n- Asynchronous access via `asyncio`  \r\n- Full typing support and enums  \r\n- Direct parameter mapping from API  \r\n- Production-ready and test-friendly  \r\n\r\n---\r\n\r\n## \ud83d\udce6 Installation\r\n\r\n```bash\r\npip install aiorocket2\r\n```\r\n\r\n> Requires Python 3.7+\r\n\r\n---\r\n\r\n## \ud83d\udd11 Getting an API Key\r\n\r\n1. Open the bot [@xRocket](https://t.me/xRocket) or [@xrocket\\_testnet\\_bot](https://t.me/xrocket_testnet_bot) for the testnet\r\n2. Go to: **Rocket Pay \u2192 Create App \u2192 API token**\r\n3. Copy the token and use it in your code\r\n\r\n---\r\n\r\n## \u26a1 Quick Start\r\n\r\n```python\r\nimport asyncio\r\nfrom aiorocket2 import xRocketClient\r\n\r\nasync def main():\r\n    client = xRocketClient(api_key=\"YOUR_API_KEY\")\r\n    \r\n    # Get application info\r\n    info = await client.get_info()\r\n    print(info)\r\n    \r\n    # Example: create a payment\r\n    invoice = await client.create_invoice(\r\n        amount=10, # 10 USDT to pay\r\n        min_payment=0, # For single payment pass 0\r\n        num_payments=1, # For single payment pass 1\r\n        currency=\"USDT\",\r\n        description=\"Buy some products\",\r\n        hidden_message=\"Thanks for payment!\", # this will appear to the payer after payment\r\n        comments_enabled=True\r\n    )\r\n    print(invoice.link)\r\n\r\nasyncio.run(main())\r\n```\r\n\r\n> All library methods mirror the xRocket API exactly, including types, required and optional parameters.\r\n\r\n---\r\n\r\n## \ud83d\udcda Documentation\r\n\r\nFull documentation is available online: [aiorocket2 Docs](https://aiorocket2.rimmirk.pp.ua)\r\nIncludes:\r\n\r\n* Description of all API methods\r\n* Usage examples\r\n* List of all enums and data structures\r\n\r\n---\r\n\r\n## \ud83d\udc68\u200d\ud83d\udcbb Authors\r\n\r\n* [RimMirK](https://github.com/RimMirK)\r\n\r\n---\r\n\r\n## \ud83d\udcdd License\r\n\r\nThis project is licensed under **GNU GPLv3**.\r\n[Full license text](https://www.gnu.org/licenses/gpl-3.0.en.html)\r\n",
    "bugtrack_url": null,
    "license": "GNU GPLv3",
    "summary": "Asynchronous Python client for xRocket API.",
    "version": "2.0.4",
    "project_urls": {
        "Documentation": "https://aiorocket2.rimmirk.pp.ua",
        "Homepage": "https://github.com/RimMirK/aiorocket2",
        "Issues": "https://github.com/RimMirK/aiorocket2/issues",
        "Repository": "https://github.com/RimMirK/aiorocket2"
    },
    "split_keywords": [
        "crypto",
        " telegram",
        " async",
        " asynchronous",
        " payments",
        " rocket",
        " cryptocurrency",
        " asyncio",
        " crypto-bot",
        " cryptopayments",
        " xrocket",
        " aiorocket",
        " aiorocket"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "00b519846798109a8bd4a2a516235e71b8dd079ad0643a7ed0cc1125d9068d7a",
                "md5": "fce8cdc179e6bc2558488ed209464759",
                "sha256": "1a82589f3fc4361f21bfdf0347e466a3cfe860274f663b9d09e43435fc88f20b"
            },
            "downloads": -1,
            "filename": "aiorocket2-2.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fce8cdc179e6bc2558488ed209464759",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 38526,
            "upload_time": "2025-08-15T11:48:46",
            "upload_time_iso_8601": "2025-08-15T11:48:46.092119Z",
            "url": "https://files.pythonhosted.org/packages/00/b5/19846798109a8bd4a2a516235e71b8dd079ad0643a7ed0cc1125d9068d7a/aiorocket2-2.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "362e8302fe9d6fee09a723c22ebd6da12d0ce6ab1027c88cb7f56954a5b3d137",
                "md5": "16f5ff0306c708cfef813f29392d30ae",
                "sha256": "c9a4754c96cbe6e8d619fb8a7223d57f1499c51c0f5296c08ae4fd63f5b2f85e"
            },
            "downloads": -1,
            "filename": "aiorocket2-2.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "16f5ff0306c708cfef813f29392d30ae",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 30014,
            "upload_time": "2025-08-15T11:48:47",
            "upload_time_iso_8601": "2025-08-15T11:48:47.349524Z",
            "url": "https://files.pythonhosted.org/packages/36/2e/8302fe9d6fee09a723c22ebd6da12d0ce6ab1027c88cb7f56954a5b3d137/aiorocket2-2.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-15 11:48:47",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "RimMirK",
    "github_project": "aiorocket2",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "aiohttp",
            "specs": []
        }
    ],
    "lcname": "aiorocket2"
}
        
Elapsed time: 1.12749s