Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Next revisionBoth sides next revision
api:estimate [2017/10/07 15:19] – [URL parameters] knutkohlapi:estimate [2021/05/26 11:10] – knutkohl
Line 1: Line 1:
-====== Solar production estimate ======+Examples here use the ''estimate'' mode, you can replace it with ''history'' for historic data or with ''clearsky'' for theoretic results for clear sky weather. 
 + 
 +===== Solar production estimate =====
  
 Get solar production estimate for specific location (defined by **latitude** and **longitude**) and a specific plane orientation (defined by **declination** and **azimuth**) for an installed **module power**. Get solar production estimate for specific location (defined by **latitude** and **longitude**) and a specific plane orientation (defined by **declination** and **azimuth**) for an installed **module power**.
  
-Examples here use the ''estimate'' mode, you can replace it with ''history'' for historic data or with ''clearsky'' for theoretic results for clear sky weather.+===== Historic solar production ===== 
 + 
 +''historic'' means here that the average of all years of the available weather data on that day is considered, the current weather is thus **not** included in the calculation. 
 + 
 +===== Clear sky solar production ===== 
 + 
 +If there were no clouds it would be a clear sky. ''clearsky'' thus calculates the theoretically possible production. 
 + 
 +===== URL parameters ===== 
 + 
 +  * **''apikey''** - personal **API key** for registered users 
 +  * **''lat''** - **latitude** of location, ''-90'' (south) ... ''90'' (north) 
 +  * **''lon''** - **longitude** of location, ''-180'' (west) ... ''180'' (east) 
 +  * **''dec''** - plane **declination**, ''0'' (horizontal) ... ''90'' (vertical) 
 +  * **''az ''**  - plane **azimuth**, ''-180'' ... ''180'' (-180 = north, -90 = east, 0 = south, 90 = west, 180 = north) 
 +  * **''kwp''** - installed **modules power** in ''kilo watt'' 
 + 
 +**''lat''** and **''lon''** can also given as **''<degrees>,<arc minutes>,<arc seconds>''**, e.g. ''12,10,34'' == ''12.17611'' 
 + 
 +You can poke around with the [[http://swagger.forecast.solar/?url=https://api.forecast.solar/swagger.yaml|Swagger Editor]] to build proper request URLs. 
 ===== Public ===== ===== Public =====
  
-One plane can be accessed by an API call:+  * One plane can be accessed by an API call 
 +  * only ''estimate'' data available
  
   https://api.forecast.solar/estimate/:lat/:lon/:dec/:az/:kwp   https://api.forecast.solar/estimate/:lat/:lon/:dec/:az/:kwp
Line 12: Line 35:
 ===== Personal ===== ===== Personal =====
  
-One plane can be accessed by an API call:+  * One plane can be accessed by an API call 
 +  * ''estimate'' and ''history'' data are available
  
   https://api.forecast.solar/:apikey/estimate/:lat/:lon/:dec/:az/:kwp   https://api.forecast.solar/:apikey/estimate/:lat/:lon/:dec/:az/:kwp
Line 18: Line 42:
 ===== Professional ===== ===== Professional =====
  
-Combined data of up to 3 planes can be accessed by one API call.+  * Combined data of up to 3 planes can be accessed by one API call 
 +  * ''estimate'', ''history'' and ''clearsky'' data are available
  
   https://api.forecast.solar/:apikey/estimate/:lat/:lon/:dec/:az/:kwp   https://api.forecast.solar/:apikey/estimate/:lat/:lon/:dec/:az/:kwp
Line 24: Line 49:
   https://api.forecast.solar/:apikey/estimate/:lat/:lon/:dec1/:az1/:kwp1/:dec2/:az2/:kwp2/:dec3/:az3/:kwp3   https://api.forecast.solar/:apikey/estimate/:lat/:lon/:dec1/:az1/:kwp1/:dec2/:az2/:kwp2/:dec3/:az3/:kwp3
  
-===== URL parameters ===== 
- 
-  * **''apikey''** - personal **API key** for registered users 
-  * **''lat''** - **latitude** of location, ''-90'' (south) ... ''90'' (north) 
-  * **''lon''** - **longitude** of location, ''-180'' (west) ... ''180'' (east) 
-  * **''dec''** - plane **declination**, ''0'' (horizontal) ... ''90'' (vertical) 
-  * **''az ''**  - plane **azimuth**, ''-180'' ... ''180'' (-180 = north, -90 = east, 0 = south, 90 = west, 180 = north) 
-  * **''kwp''** - installed **modules power** in ''kilo watt'' 
- 
-You can poke around with the [[http://swagger.forecast.solar/?url=https://api.forecast.solar/swagger.yaml|Swagger UI]] to build proper request URLs. 
 ===== Watts, Watt hours, Watt hours day ===== ===== Watts, Watt hours, Watt hours day =====
  
Line 139: Line 154:
 </code> </code>
  
-The ''watt_hours'' data will **reset to 0 at day change**!+The ''watt_hours'' data will simulate a daily electricity meter and therefor **resets to 0 at day change**!