cryptodatapy.util.api_requester
===============================

.. py:module:: cryptodatapy.util.api_requester


Attributes
----------

.. autoapisummary::

   cryptodatapy.util.api_requester.logger


Classes
-------

.. autoapisummary::

   cryptodatapy.util.api_requester.APIRequester


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

.. py:data:: logger

.. py:class:: APIRequester

   A robust client for making external API GET requests.

   Encapsulates retry logic, error handling, and throttling based on
   parameters supplied by the DataRequest object.


   .. py:method:: get_request(url: str, params: Dict[str, Union[str, int]], headers: Optional[Dict[str, str]] = None, trials: int = 3, pause: float = 0.1) -> Optional[Dict[str, Any]]
      :staticmethod:


      Submits a resilient GET request to the API with retry logic.

      :param url: The target endpoint URL for the GET request.
      :type url: str
      :param params: Dictionary containing query parameters for the request.
      :type params: dict
      :param headers: Dictionary containing HTTP headers for the request.
      :type headers: dict, optional
      :param trials: Maximum number of attempts to make for the request.
      :type trials: int, default=3
      :param pause: Number of seconds to pause between failed attempts.
      :type pause: float, default=0.1

      :returns: Data response in JSON format (dict) if successful, otherwise None.
      :rtype: Optional[Dict[str, Any]]