Welcome to Polygon API Access’s documentation!
Polygon API Access
- class polygon_api_access.PolygonAPIAccess(location, table_name)[source]
Instantiate the PolygonAPIAccess class and takes in 2 parameters.
- Parameters
location (str) – The file path to store the database
table_name (str) – Name of the database
- access(currency_pairs)[source]
- Parameters
currency_pairs (list) – A dictionary defining the set of currency pairs we will be pulling data for
- aggregate_raw_data_tables(engine, currency_pairs)[source]
This function is called every 6 minutes to aggregate the data, store it in the aggregate table, and then delete the raw data
- Parameters
engine (sqlalchemy.future.engine.Engine) – Engine to connect to the database
currency_pairs (list) – A dictionary defining the set of currency pairs we will be pulling data for
- initialize_aggregated_tables(engine, currency_pairs)[source]
This creates a table for storing the (6 min interval) aggregated price data for each currency pair in the SQLite database
- Parameters
engine (sqlalchemy.future.engine.Engine) – Engine to connect to the database
currency_pairs (list) – A dictionary defining the set of currency pairs we will be pulling data for
- initialize_raw_data_tables(engine, currency_pairs)[source]
This creates a table for storing the raw, unaggregated price data for each currency pair in the SQLite database
- Parameters
engine (sqlalchemy.future.engine.Engine) – Engine to connect to the database
currency_pairs (list) – A dictionary defining the set of currency pairs we will be pulling data for
- reset_raw_data_tables(engine, currency_pairs)[source]
Function which clears the raw data tables once we have aggregated the data in a 6 minute interval
- Parameters
engine (sqlalchemy.future.engine.Engine) – Engine to connect to the database
currency_pairs (list) – A dictionary defining the set of currency pairs we will be pulling data for