aiorocket2 documentation
=========================

.. image:: https://img.shields.io/pypi/v/aiorocket2?color=blue&logo=python&style=flat-square
   :target: https://pypi.org/project/aiorocket2/
   :alt: PyPI

.. image:: https://img.shields.io/pypi/pyversions/aiorocket2?style=flat-square
   :target: https://www.python.org/
   :alt: Python Version

.. image:: https://img.shields.io/badge/license-GPLv3-blue?style=flat-square
   :target: https://www.gnu.org/licenses/gpl-3.0.en.html
   :alt: License

.. image:: https://img.shields.io/badge/docs-online-brightgreen?style=flat-square
   :target: https://docs.aiorocket2.rimmirk.dev
   :alt: Documentation

.. image:: https://img.shields.io/github/issues/RimMirK/aiorocket2?style=flat-square
   :target: https://github.com/RimMirK/aiorocket2/issues
   :alt: Issues

.. image:: https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg
   :target: https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md
   :alt: StandWithUkraine

Async Python client for the xRocket Pay API.

This documentation is primarily an API reference for the Python package.
It is intended for developers who want to inspect available clients,
models, enums, exceptions, tags and helper utilities, and use them in
real integrations with xRocket Pay.

If you are looking for the upstream service documentation, use the
official xRocket API reference:

- xRocket API: https://pay.xrocket.exchange/api

Quick navigation
----------------

.. grid:: 1 2 2 2
   :gutter: 3

   .. grid-item-card:: Quick start
      :link: api/client.html

      Start with the main client and its async interface.

   .. grid-item-card:: API reference
      :link: api/index.html

      Explore models, enums, exceptions and utilities.

   .. grid-item-card:: Examples
      :link: examples.html

      Common usage patterns and invoice creation examples.

   .. grid-item-card:: Links
      :link: links.html

      Links to GitHub, Telegram and other contact channels.

Contents
--------

.. toctree::
   :maxdepth: 2
   :caption: Documentation

   quickstart
   examples
   api/index
   faq
   resources
   links
