API Documentation

/data

Usage: To retrieve filtered historical data.

Expected Params: dataset, start, end, columns

Optional: filtering based on a value for a column (e.g. cityName=Meiningen)

Sample Request: http://139.174.11.24/data?dataset=irradiationdataforcities&start=2022-08-01&end=2022-08-04&columns=GHI,BHI,cityName&cityName=Meiningen

Note: -99999 in data is standing for the missing values.

Remove Anomalies:

Additional Params: fraction, removeanomalies=True, anomalycolumns

Sample Request: http://139.174.11.24/data?dataset=irradiationdataforcities&start=2022-08-01&end=2022-08-04&columns=GHI,BHI,cityName&cityName=Meiningen&fraction=0.1&removeanomalies=True&anomalycolumns=GHI,BHI

Note: -99999 in data is standing for the missing values.

/databases

Usage: To retrieve the list of collection names

Expected Params: -

Sample Request: http://139.174.11.24/databases

/dbcolumns

Usage: To retrieve the column names of a collection

Expected Params: dataset (values could be taken from /databases)

Sample Request: http://139.174.11.24/dbcolumns?dataset=irradiation

/evaluate

Usage: To retrieve the evaluation of the best model for a period of time

Expected Params: start, end

Sample Request: http://139.174.11.24/evaluate?start=2022-09-23&end=2022-09-27

Base URL (/)

Usage: To retrieve forecasts for the requested date

Expected Params: date

Sample Request: http://139.174.11.24/?date=2022-05-20