polygon_io
==========

.. py:module:: polygon_io


Attributes
----------

.. autoapisummary::

   polygon_io.app


Classes
-------

.. autoapisummary::

   polygon_io.FileType


Functions
---------

.. autoapisummary::

   polygon_io.fetch_polygon
   polygon_io.pull_data


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

.. py:data:: app

.. py:class:: FileType

   Bases: :py:obj:`str`, :py:obj:`enum.Enum`


   str(object='') -> str
   str(bytes_or_buffer[, encoding[, errors]]) -> str

   Create a new string object from the given object. If encoding or
   errors is specified, then the object must expose a data buffer
   that will be decoded using the given encoding and error handler.
   Otherwise, returns the result of object.__str__() (if defined)
   or repr(object).
   encoding defaults to 'utf-8'.
   errors defaults to 'strict'.


   .. py:attribute:: parquet
      :value: 'parquet'



   .. py:attribute:: json
      :value: 'json'



   .. py:attribute:: csv
      :value: 'csv'



.. py:function:: fetch_polygon(endpoint=str, params=dict)

.. py:function:: pull_data(config_file = typer.Option(..., help='Path to the JSON configuration file'), output_file = typer.Option(None, help='Path to the output file (optional)'), file_type = FileType.parquet)

   Pull data via json configuration file