General parameters

result
Result format

Optional

  • Type: number
  • Default: 0

Possible values

  • 0 - Full
  • 1 - Short
  • 2 - Both, array of [full, short]

'short' result returns only modes and required watts if applicable.

accuracy
Optimization accuracy

Optional

  • Type: number
  • Default: 0

Possible values

  • 0 - Low
  • 1 - Medium
  • 2 - High

The higher the accuracy, the more variants are calculated and the longer it takes. For some load combinations, no valid variant can be calculated with level "low"!

start
Start optimization

Optional

  • Type: string

Format: HH[:MM][+1]|+h

Start optimization at this time, if lower than "now" it will be correctetd to "now". e.g. only optimize tomorrow use "00+1" (next midnight)
If end times for loads will be defined, e.g. next morning, then you should always calculate from "now", not only for "tomorrow" so that favourable prices can be used throughout the whole night.

feed_in
Feed in tariff

Required

  • Type: string
  • Unit: €/kWh

Respectively 1 value (fixed for whole day, mostly), 2 values (each 30 min.) / 4 values (each 15 min.) for repeating hourly profiles, 24 values (hourly), 48 values (1/2 hourly) or 96 values (each 15 min.); comma separated

tariff
Electricity purchase price

Optional

  • Type: string
  • Unit: €/kWh

Respectively 1 value (fixed for whole day), 2 values (each 30 min.) / 4 values (each 15 min.) for repeating hourly profiles, 24 values (hourly), 48 values (1/2 hourly) or 96 values (each 15 min.); comma separated

tariff_variable
Use a variable tariff

Optional

  • Type: string
  • Default: ''

Possible values

  • '' - No
  • 'epexspot' - EPEX SPOT based (e.g. Awattar)
  • 'tibber' - Tibber

Germany only at the moment.

tariff_plus
EPEX SPOT: Market price surcharge

Optional

  • Type: number
  • Unit: €
  • Min: 0
  • Step: 0.001

Approximate/average value if this is also variable and linked to the market value.

postal_code
Tibber: Postal code Germany

Optional

  • Type: string
consumption
Consumption profiles

Optional

  • Type: string
  • Unit: W

Array of strings

Array of: Respectively 1 value (for whole day), 2 values (each 30 min.) / 4 values (each 15 min.) for repeating hourly profiles, 24 values (hourly), 48 values (1/2 hourly) or 96 values (each 15 min.); comma separated

© 2024 - 2025 by Forecast.Solar | v0.0.0-alpha