Skip to main content

Asynchronous Python client for xRocket API.

Project description

aiorocket2 🚀

PyPI Python Version License Documentation 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

pip install aiorocket2

Requires Python 3.7+


🔑 Getting an API Key

  1. Open the bot @xRocket or @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

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 Includes:

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

👨‍💻 Authors


📝 License

This project is licensed under GNU GPLv3. Full license text

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

aiorocket2-2.0.4.tar.gz (30.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aiorocket2-2.0.4-py3-none-any.whl (38.5 kB view details)

Uploaded Python 3

File details

Details for the file aiorocket2-2.0.4.tar.gz.

File metadata

  • Download URL: aiorocket2-2.0.4.tar.gz
  • Upload date:
  • Size: 30.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.9

File hashes

Hashes for aiorocket2-2.0.4.tar.gz
Algorithm Hash digest
SHA256 c9a4754c96cbe6e8d619fb8a7223d57f1499c51c0f5296c08ae4fd63f5b2f85e
MD5 16f5ff0306c708cfef813f29392d30ae
BLAKE2b-256 362e8302fe9d6fee09a723c22ebd6da12d0ce6ab1027c88cb7f56954a5b3d137

See more details on using hashes here.

File details

Details for the file aiorocket2-2.0.4-py3-none-any.whl.

File metadata

  • Download URL: aiorocket2-2.0.4-py3-none-any.whl
  • Upload date:
  • Size: 38.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.9

File hashes

Hashes for aiorocket2-2.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1a82589f3fc4361f21bfdf0347e466a3cfe860274f663b9d09e43435fc88f20b
MD5 fce8cdc179e6bc2558488ed209464759
BLAKE2b-256 00b519846798109a8bd4a2a516235e71b8dd079ad0643a7ed0cc1125d9068d7a

See more details on using hashes here.

Supported by

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