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/06 08:51] – [Public] knutkohlapi:estimate [2019/12/30 14:50] – [Personal] 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**.
 +
 +===== 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.
  
 ===== 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
  
-===== Private =====+===== 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/:key/estimate/:lat/:lon/:dec/:az/:kwp+  https://api.forecast.solar/:apikey/estimate/:lat/:lon/:dec/:az/:kwp
  
 ===== Professional ===== ===== Professional =====
  
-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/:key/estimate/:lat/:lon/:dec/:az/:kwp +  https://api.forecast.solar/:apikey/estimate/:lat/:lon/:dec/:az/:kwp 
-  https://api.forecast.solar/:key/estimate/:lat/:lon/:dec1/:az1/:kwp1/:dec2/:az2/:kwp2 +  https://api.forecast.solar/:apikey/estimate/:lat/:lon/:dec1/:az1/:kwp1/:dec2/:az2/:kwp2 
-  https://api.forecast.solar/:key/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 ===== ===== URL parameters =====
  
-  * **''key''** - personal **API key** for registered users+  * **''apikey''** - personal **API key** for registered users
   * **''lat''** - **latitude** of location, ''-90'' (south) ... ''90'' (north)   * **''lat''** - **latitude** of location, ''-90'' (south) ... ''90'' (north)
   * **''lon''** - **longitude** of location, ''-180'' (west) ... ''180'' (east)   * **''lon''** - **longitude** of location, ''-180'' (west) ... ''180'' (east)
Line 41: Line 54:
   https://api.forecast.solar/estimate/watthours/day/:lat/:lon/:dec/:az/:kwp   https://api.forecast.solar/estimate/watthours/day/:lat/:lon/:dec/:az/:kwp
  
-The same for Private and Professional accounts with API key+The same for Personal and Professional accounts with API key
  
-  https://api.forecast.solar/:key/estimate/watts/:lat/:lon/:dec/:az/:kwp +  https://api.forecast.solar/:apikey/estimate/watts/:lat/:lon/:dec/:az/:kwp 
-  https://api.forecast.solar/:key/estimate/watthours/:lat/:lon/:dec/:az/:kwp +  https://api.forecast.solar/:apikey/estimate/watthours/:lat/:lon/:dec/:az/:kwp 
-  https://api.forecast.solar/:key/estimate/watthours/day/:lat/:lon/:dec/:az/:kwp+  https://api.forecast.solar/:apikey/estimate/watthours/day/:lat/:lon/:dec/:az/:kwp
  
 Here you can query with a Professional account also up to 3 planes at once. Here you can query with a Professional account also up to 3 planes at once.
Line 139: Line 152:
  
 The ''watt_hours'' data will **reset to 0 at day change**! The ''watt_hours'' data will **reset to 0 at day change**!
-