energy_forecast.production_forecast module#

class energy_forecast.production_forecast.ProductionForecast[source]#

Bases: TypedDict

forecasts: list[ProductionForecastOneDay]#
class energy_forecast.production_forecast.ProductionForecastAPI(secret: str | None = None)[source]#

Bases: RTEAPROAuth2

Access the RTE API to get the daily forecast of production.

Example

>>> r = ProductionForecastAPI(secret)
>>> r.get_raw_data("SOLAR", "D-1", "2021-01-01", "2021-01-10")
assert_duration(start_date: Timestamp, end_date: Timestamp, autofix: bool = False) → tuple[Timestamp, Timestamp][source]#
get_raw_data(production_type: Literal['AGGREGATED_PROGRAMMABLE_FRANCE', 'AGGREGATED_NON_PROGRAMMABLE_FRANCE', 'WIND_ONSHORE', 'WIND_OFFSHORE', 'SOLAR', 'AGGREGATED_CPC', 'MDSETRF', 'MDSESTS'] | None = None, type: Literal['CURRENT', 'ID', 'D-1', 'D-2', 'D-3'] | None = None, start_date: str | Timestamp | None = None, end_date: str | Timestamp | None = None, horizon='1d') → ProductionForecast[source]#
url_api: str = 'https://digital.iservices.rte-france.com/open_api/generation_forecast/v2/forecasts'#
class energy_forecast.production_forecast.ProductionForecastOneDay[source]#

Bases: TypedDict

end_date: str#
production_type: str#
start_date: str#
sub_type: str#
type: str#
class energy_forecast.production_forecast.ProductionForecastOneEntry[source]#

Bases: TypedDict

The type of the production forecast.

end_date: str#
start_date: str#
updated_date: str#
value: int#