BSX Exchange Python SDK
==========================

This is the Python SDK for the `BSX Exchange API <https://api-docs.bsx.exchange/reference/general-information>`_.

The latest version of the SDK can be found on `PyPI <https://pypi.org/project/bsx-sdk-py>`_, and the source code is on `GitHub <https://github.com/bsx-engineering/bsx-python-sdk>`_.

.. NOTE::

   👋 Brand new to BSX?

   0. Join the BSX community via `Discord <https://discord.gg/chVhFkfDKr>`_, `Twitter <https://twitter.com/bsx_labs>`_.
   1. Read our `docs <https://docs.bsx.exchange/bsx-docs>`_ to learn the basic concepts.
   2. Visit us at `BSX Exchange <https://www.bsx.exchange/>`_.
   3. Take a look at the :ref:`getting-started` section. It will give you a quick idea of the things you can do via the SDK!

Requirements
------------

- Python 3.9 or above

Installation
------------

Via pip:

.. code-block:: bash

    pip install bsx-sdk-py

You might want to use a virtual environment to isolate your packages.

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   getting-started
   user-reference
   api-reference