nrgpy.api.catalog module#
- class nrgpy.api.catalog.nrg_api_catalog(serial_number='', site_number='', start_date='2014-01-01', end_date='2023-12-31', client_id='', client_secret='', **kwargs)[source]#
Bases:
nrg_api
Uses NRG hosted web-based API to catalog of available data in text format To sign up for the service, go to https://services.nrgsystems.com/
- Parameters:
- serial_numberstr or int
serial number of data logger (like, 820612345)
- site_numberstr or int
up to 6-digit site number
- start_datestr
“YYYY-MM-DD HH:MM:SS” format, if just date it will return the whole day times are in logger local time
- end_datestr
“YYYY-MM-DD HH:MM:SS” format, if just date it will return the whole day times are in logger local time
- client_idstr
provided by NRG Systems
- client_secretstr
provided by NRG Systems
- Returns:
- object
export object
Examples
Check for available data files for site number 6
>>> import nrgpy >>> client_id = "contact support@nrgsystems.com for access" >>> client_secret = "contact support@nrgsystems.com for access" >>> catalog = nrgpy.nrg_api_catalog( client_id=client_id, client_secret=client_secret, site_number=6, serial_number=820600019, start_date="2020-05-01", end_date="2020-05-03", save_file=False )