polygon_io

Attributes

app

Classes

FileType

str(object='') -> str

Functions

`fetch_polygon`([endpoint, params])
`pull_data`([config_file, output_file, file_type])	Pull data via json configuration file

Module Contents

polygon_io.app

class polygon_io.FileType

Bases: str, 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’.

parquet = 'parquet'

json = 'json'

csv = 'csv'

polygon_io.fetch_polygon(endpoint=str, params=dict)

polygon_io.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

Parameters:

config_file (str)
output_file (str)
file_type (typing_extensions.Annotated[FileType, typer.Option(case_sensitive=False)])