.. toctree::
   :hidden:

   Documentation Home <self>

.. image:: ../assets/logo_dark.png
   :alt: Auraxium Logo
   :align: center

Auraxium is an object-oriented Python wrapper for the `PlanetSide 2 <https://www.planetside2.com/home>`_ API.

This package provides a comprehensive object model representation of the API data that facilitates the creation of bots and utilities without requiring deep knowledge of the API and its idiosyncrasies.

`Release notes <https://github.com/leonhard-s/auraxium/releases>`_
•
`Issue tracker <https://github.com/leonhard-s/auraxium/issues>`_
•
`Repository <https://github.com/leonhard-s/auraxium>`_
•
`PyPI <https://pypi.org/project/auraxium/>`_

=====

======================
Documentation Contents
======================

.. toctree::
   :caption: Basic Usage
   :maxdepth: 1

   usage/basic/getting-started
   usage/basic/rest
   usage/basic/event
   usage/basic/census
   usage/basic/logging

.. toctree::
   :caption: Advanced Features
   :maxdepth: 1

   usage/advanced/queries
   usage/advanced/caching

.. toctree::
   :caption: API Reference
   :maxdepth: 1

   api/ps2
   api/event
   api/payloads
   api/rest
   api/errors
   api/types

.. toctree::
   :caption: Miscellaneous
   :maxdepth: 1

   misc/collections

Indices and Tables
==================

* :ref:`genindex`
* :ref:`search`