The energy farm endpoint provides energy output data for energy producing sites. This endpoint will provide estimated observations and forecast energy output from Vaisala’s renewable energy model. By default, the endpoint will return the hourly forecast from the current time out ~10days. Estimated observations are available for the last 24 hours.
Default behavior when providing timestamp with from / to parameters will be based on UTC time. Providing relative time offsets will be localized.
The following actions are supported with the energy/farm endpoint:
| :id | Requesting data by using the :id action is used for returning data for a particular item that has an ID associated with it. This is the primary method for requesting general weather information for a single location (observations, forecasts, advisories, etc.) as the location's name or a zip code serves as the id. Other endpoints may expect a certain value for the ID, such as storm cells whose ID value is a combination of the radar site identifier and unique identifier assigned to every storm cell. Refer to an endpoint's detailed documentation for specific information regarding how to use the :id action. |
The following parameters are optional unless otherwise noted:
| from | from=:string |
Returns the results starting from the value specified. For best practices we recommend using the to parameter as well to define a specific time frame.Supports a UNIX timestamp or a specific date string. Alternatively, common date formats supported by the PHP strtotime() function will be accepted; however, commas are not accepted. Examples: from=tomorrow from=friday from=1302883980 from=MM/DD/YYYY from=YYYY/MM/DD from=+2hours from=2017-02-27 5:00 PM |
| to | to=:string |
Returns the results between now and the value specified. For best practices we recommend using the from parameter as well to define a specific time frame. When used in conjunction with the from parameter, the value of to will be relative to the value of from, not relative to the current time. Supports a UNIX timestamp or a specific date string. Alternatively, common date formats supported by the PHP strtotime() function will be accepted; however, commas are not accepted. Examples: to=+6hours to=+5days to=1302883980 to=MM/DD/YYYY to=YYYY/MM/DD to=2017-02-27 5:00 PM |
| plimit | plimit=:total |
Applied only on the periods property, the total number of periods to return as an integer. The maximum plimit for this endpoint is 250. |
| pskip | pskip=:number |
Applied only on the periods property, used to skip over a specific number of periods in the data set. |
The /[:endpoint]/[:action]? portion within the query template below can be exchanged with any of the examples. Also, please note you will need to input your client credentials in the [ID] and [SECRET] fields which can be found under the Apps section of the members area.
https://api.aerisapi.com/[:endpoint]/[:action]?client_id=[ID]&client_secret=[SECRET]
Returns the current estimated observation and forecast data for the Wilton Wind farm located in the SPP region./energy/farm/spp_wilton-wind
Returns forecast data for the Glacier Hills Wind Park in the MISO region starting 2 hours from now and ending 3 hours from the start time./energy/farm/miso_glacier-hills-wind-park?from=+2hours&to=+3hours
The following is an example of what each object in the response will consist of. Depending on your requested action, the response may contain multiple instances of this object within an array.
{
"success":true,
"error":null,
"response":[
{
"id":"spp_wilton-wind",
"dataSource":"vaisala-renewables",
"loc":{
"long":-100.6777,
"lat":47.1187
},
"place":{
"name":"WILTON WIND",
"state":"nd",
"county":"mclean county",
"country":"us"
},
"periods":[
{
"timestamp":1687435200,
"dateTimeISO":"2023-06-22T07:00:00-05:00",
"powerKW":44257.08602,
"isForecast":true
},
{
"timestamp":1687438800,
"dateTimeISO":"2023-06-22T08:00:00-05:00",
"powerKW":33602.9399,
"isForecast":true
},
{
"timestamp":1687442400,
"dateTimeISO":"2023-06-22T09:00:00-05:00",
"powerKW":25755.87419,
"isForecast":true
},
{
"timestamp":1687446000,
"dateTimeISO":"2023-06-22T10:00:00-05:00",
"powerKW":21064.82098,
"isForecast":true
},
{
"timestamp":1687449600,
"dateTimeISO":"2023-06-22T11:00:00-05:00",
"powerKW":18105.40828,
"isForecast":true
}
],
"profile":{
"tz":"America\/Chicago",
"tzname":"CDT",
"tzoffset":-18000,
"isDST":true,
"elevM":669,
"elevFT":2195,
"site":{
"eiaPlantCodes":[
57120,
5635
],
"maxCapacityKW":102300,
"hardwareModel":"GE:GE16-82.5",
"onlineDate":"2005-12-01T00:00:00+00:00",
"region":{
"name":"SPP",
"subgroup":null
}
}
}
}
]
}
{
"type":"FeatureCollection",
"features":[
{
"type":"Feature",
"id":"spp_wilton-wind",
"geometry":{
"type":"Point",
"coordinates":[
-100.6777,
47.1187
]
},
"properties":{
"id":"spp_wilton-wind",
"dataSource":"vaisala-renewables",
"loc":{
"long":-100.6777,
"lat":47.1187
},
"place":{
"name":"WILTON WIND",
"state":"nd",
"county":"mclean county",
"country":"us"
},
"periods":[
{
"timestamp":1687442400,
"dateTimeISO":"2023-06-22T09:00:00-05:00",
"powerKW":43390.42782,
"isForecast":true
},
{
"timestamp":1687446000,
"dateTimeISO":"2023-06-22T10:00:00-05:00",
"powerKW":32999.3239,
"isForecast":true
},
{
"timestamp":1687449600,
"dateTimeISO":"2023-06-22T11:00:00-05:00",
"powerKW":25802.05174,
"isForecast":true
},
{
"timestamp":1687453200,
"dateTimeISO":"2023-06-22T12:00:00-05:00",
"powerKW":20107.75923,
"isForecast":true
},
{
"timestamp":1687456800,
"dateTimeISO":"2023-06-22T13:00:00-05:00",
"powerKW":18516.92555,
"isForecast":true
}
],
"profile":{
"tz":"America\/Chicago",
"tzname":"CDT",
"tzoffset":-18000,
"isDST":true,
"elevM":669,
"elevFT":2195,
"site":{
"eiaPlantCodes":[
57120,
5635
],
"maxCapacityKW":102300,
"hardwareModel":"GE:GE16-82.5",
"onlineDate":"2005-12-01T00:00:00+00:00",
"region":{
"name":"SPP",
"subgroup":null
}
}
}
}
}
]
}
The following properties will be provided in every response object:
Last modified: September 14, 2023