Package entsoe
Class EntsoeClient
java.lang.Object
entsoe.EntsoeClient
- All Implemented Interfaces:
EntsoeDefines
Access the ENTSO-E Transparency Platform.
To be able to use the library, an API TOKEN is required. See README.md
Please note that some constants make only sense for users in Germany.
-
Field Summary
Fields inherited from interface entsoe.EntsoeDefines
ENTSOE_SECURITY_TOKEN -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor which reads ENTSOE_SECURITY_TOKEN from Java Properties or ENV Variable.EntsoeClient(String entsoeSecurityToken) Explicit constructor that takes the ENTSOE_SECURITY_TOKEN as parameter. -
Method Summary
Modifier and TypeMethodDescriptiongetRequestURL(EntsoeDate entsoeDate) Assemble the request URL for a specific dategetSpotpriceDataRaw(EntsoeDate entsoeDateIn) Returns the raw spot price data as XML String.getTimeSeries(EntsoeDate entsoeDate, EntsoeResolution entsoeResolution) Returns a TimeSeries that is truncated at the specified cutOffDate.getTimeSeries(EntsoeDate entsoeDate, EntsoeResolution entsoeResolution, ZonedDateTime cutOffDate) Returns a TimeSeries that is truncated at the specified cutOffDate.
-
Constructor Details
-
EntsoeClient
Explicit constructor that takes the ENTSOE_SECURITY_TOKEN as parameter.- Parameters:
entsoeSecurityToken- The ENTSOE_SECURITY_TOKEN as parameter - must not be null
-
EntsoeClient
public EntsoeClient()Default constructor which reads ENTSOE_SECURITY_TOKEN from Java Properties or ENV Variable. A Java Property has precedence over an ENV variable.
-
-
Method Details
-
getTimeSeries
public TreeMap<EntsoeDate,BigDecimal> getTimeSeries(EntsoeDate entsoeDate, EntsoeResolution entsoeResolution, ZonedDateTime cutOffDate) Returns a TimeSeries that is truncated at the specified cutOffDate. SeegetTimeSeries(EntsoeDate, EntsoeResolution)- Parameters:
entsoeDate- The date to request the day ahead spot price data forentsoeResolution- The resolution of the data. For spot price plans in GermanyEntsoeResolution.PT60Mmust be used.cutOffDate- The cutoff date. Data before this date will be removed.- Returns:
- A map that correlates timeslots and day ahead spot prices
-
getTimeSeries
public TreeMap<EntsoeDate,BigDecimal> getTimeSeries(EntsoeDate entsoeDate, EntsoeResolution entsoeResolution) Returns a TimeSeries that is truncated at the specified cutOffDate.- Parameters:
entsoeDate- The date to request the day ahead spot price data forentsoeResolution- The resolution of the data. For spot price plans in GermanyEntsoeResolution.PT60Mmust be used.- Returns:
- A map that correlates timeslots and day ahead spot prices
-
getSpotpriceDataRaw
Returns the raw spot price data as XML String.- Parameters:
entsoeDateIn- The date to request the day ahead spot price data for- Returns:
- the raw XML response of the ENTSO-E API
-
getRequestURL
Assemble the request URL for a specific date- Parameters:
entsoeDate- The date to request the day ahead spot price data for- Returns:
- the URL to call
-