bw_hestia_bridge.hestia_api.base_api
====================================

.. py:module:: bw_hestia_bridge.hestia_api.base_api


Attributes
----------

.. autoapisummary::

   bw_hestia_bridge.hestia_api.base_api.adapter
   bw_hestia_bridge.hestia_api.base_api.hestia_session
   bw_hestia_bridge.hestia_api.base_api.nested_elements
   bw_hestia_bridge.hestia_api.base_api.retries
   bw_hestia_bridge.hestia_api.base_api.retry
   bw_hestia_bridge.hestia_api.base_api.stable_url
   bw_hestia_bridge.hestia_api.base_api.staging_url
   bw_hestia_bridge.hestia_api.base_api.valid_types


Functions
---------

.. autoapisummary::

   bw_hestia_bridge.hestia_api.base_api.hestia_request


Module Contents
---------------

.. py:function:: hestia_request(endpoint: str, staging: bool, query: Optional[dict] = None, req_type: Literal['get', 'post'] = 'get') -> dict

   Query the Hestia API.

   :param endpoint: The API endpoint (e.g. "search").
   :type endpoint: str
   :param staging: Whether to use the staging API.
   :type staging: bool
   :param query: Additional queries (passed via something like "?q1=v1&q2=v2").
   :type query: dict, optional (default: None)
   :param req_type: The type of request that will be performed.
   :type req_type: str, "get" or "post"


.. py:data:: adapter

.. py:data:: hestia_session

.. py:data:: nested_elements

.. py:data:: retries
   :value: 3


.. py:data:: retry

.. py:data:: stable_url
   :value: 'https://api.hestia.earth'


.. py:data:: staging_url
   :value: 'https://api-staging.hestia.earth'


.. py:data:: valid_types