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
- Open the bot @xRocket or @xrocket_testnet_bot for the testnet
- Go to: xRocket API -> xRocket Pay → Create App → API token
- 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 invoice
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
Build the docs locally
python -m pip install -e .[docs]
python -m sphinx -b html docs docs/_build/html
python -m http.server 8000 --directory docs/_build/html
👨💻 Authors
📝 License
This project is licensed under GNU GPLv3. Full license text
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file aiorocket2-2.1.tar.gz.
File metadata
- Download URL: aiorocket2-2.1.tar.gz
- Upload date:
- Size: 3.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
be669fbd86bc86d2486d20631a3961962c587f1b73b44a453c75d70c426e1f62
|
|
| MD5 |
e2bda8566d45c14945d2a9de61eba430
|
|
| BLAKE2b-256 |
23188920465ddf58dcceb134eacc043205cb09acb7ac57db647f50b53fada5c4
|
Provenance
The following attestation bundles were made for aiorocket2-2.1.tar.gz:
Publisher:
deploy_pypi.yml on RimMirK/aiorocket2
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
aiorocket2-2.1.tar.gz -
Subject digest:
be669fbd86bc86d2486d20631a3961962c587f1b73b44a453c75d70c426e1f62 - Sigstore transparency entry: 2383538597
- Sigstore integration time:
-
Permalink:
RimMirK/aiorocket2@ae16bda0d9266eaeb2f4354766dfea704b3e74f8 -
Branch / Tag:
refs/tags/2.1 - Owner: https://github.com/RimMirK
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
deploy_pypi.yml@ae16bda0d9266eaeb2f4354766dfea704b3e74f8 -
Trigger Event:
release
-
Statement type:
File details
Details for the file aiorocket2-2.1-py3-none-any.whl.
File metadata
- Download URL: aiorocket2-2.1-py3-none-any.whl
- Upload date:
- Size: 42.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9ff7337a00a618606cdb5a9d0b5ae44eb6b14ce79b35954d23924c512a2ddbfe
|
|
| MD5 |
bc132709385886853f77a0ed172d9dc4
|
|
| BLAKE2b-256 |
ddca1449918d192b5249fb0987627300fb73b964d19f5c9412b4d2e58433317a
|
Provenance
The following attestation bundles were made for aiorocket2-2.1-py3-none-any.whl:
Publisher:
deploy_pypi.yml on RimMirK/aiorocket2
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
aiorocket2-2.1-py3-none-any.whl -
Subject digest:
9ff7337a00a618606cdb5a9d0b5ae44eb6b14ce79b35954d23924c512a2ddbfe - Sigstore transparency entry: 2383539061
- Sigstore integration time:
-
Permalink:
RimMirK/aiorocket2@ae16bda0d9266eaeb2f4354766dfea704b3e74f8 -
Branch / Tag:
refs/tags/2.1 - Owner: https://github.com/RimMirK
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
deploy_pypi.yml@ae16bda0d9266eaeb2f4354766dfea704b3e74f8 -
Trigger Event:
release
-
Statement type:
