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 [2017/10/07 15:11] – [Parameters] knutkohlapi [2021/11/06 18:44] – [Query parameters] knutkohl
Line 9: Line 9:
   https://api.forecast.solar/   https://api.forecast.solar/
  
-There is also a [[http://swagger.forecast.solar/?url=https://api.forecast.solar/swagger.yaml|Swagger UI]] to build proper request URLs.+There is also a [[http://swagger.forecast.solar/?url=https://api.forecast.solar/swagger.yaml|Swagger Editor]] to inspect for proper request URLs.
  
-==== Parameters ====+==== Query parameters ====
  
 === time === === time ===
Line 19: Line 19:
   https://api.forecast.solar/...?time=...   https://api.forecast.solar/...?time=...
  
-If not given, a simple date time format is used: ''2017-09-18 01:00:00''+If not given, a simple parsable date time format is used: ''2017-09-18 01:00:00''
  
 ^ Parameter value  ^ Result format                    ^ ^ Parameter value  ^ Result format                    ^
Line 30: Line 30:
  
 With this parameter you can add a factor to adjust the forecasted watts in the morning and the evening. With this parameter you can add a factor to adjust the forecasted watts in the morning and the evening.
 +
 +  https://api.forecast.solar/...?damping=...
  
 See this [[Damping|further explanations]]. See this [[Damping|further explanations]].
 +
 +=== inverter ===
 +
 +With this parameter you can Forecast.Solar tell what is the maximal power of your inverter in Watts or kVA.
 +
 +  https://api.forecast.solar/...?inverter=...
 +
 +If your inverter is (very) undersized, the maximum prediction power will be limited to this value.
 ===== Response ===== ===== Response =====
 ==== Content type ==== ==== Content type ====
Line 58: Line 68:
 | Expires | Fri, 22 Sep 2017 08:08:52 GMT | | Expires | Fri, 22 Sep 2017 08:08:52 GMT |
 | Last-Modified | Fri, 22 Sep 2017 08:08:38 GMT | | Last-Modified | Fri, 22 Sep 2017 08:08:38 GMT |
-| X-Ratelimit-Limit | 86400 | +| X-Ratelimit-Calls | 323 | 
-| X-Ratelimit-Remaining | 86397 | +| X-Ratelimit-Limit | 720 | 
-| X-Ratelimit-Reset | 48075 |+| X-Ratelimit-Remaining | 397 | 
 +| X-Ratelimit-Reset | 48 |
  
 See rate limit specification [[api#rate_limits|below]]. See rate limit specification [[api#rate_limits|below]].
Line 109: Line 120:
 ==== Rate limits ==== ==== Rate limits ====
  
-| Limit            | The maximum number of requests you're permitted to make per day.              | +Rate limits are defined by hour. 
-| Remaining  | The number of requests remaining in the current rate limit window.            | + 
-| Reset           | The number of seconds left in the current period. |+| Calls      | Calls made this period.                                              | 
 +| Limit      | The maximum number of requests you're permitted to make per period.  | 
 +| Remaining  | The number of requests remaining in the current period.              | 
 +| Reset      | The number of seconds left in the current period.                    |