Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.flatpeak.com/llms.txt

Use this file to discover all available pages before exploring further.

When you need to create a schedule based on an energy price threshold — for example, only consuming energy when the price is below €0.05/kWh — call the schedule-by-limit endpoint. Flatpeak uses the Location’s tariff and, if a PV array is present, the local solar generation forecast to identify all time slots that meet your specified price level (high or low). You must specify either the relative or the absolute parameter when making the request: 
curl --request POST \
  --url https://api.flatpeak.com/schedules/limit/loc_641b90b758fb8e6293716e40 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "start_time": "2023-06-15T18:43:00Z",
  "end_time": "2023-06-16T06:00:00Z",
  "tariff_direction": "IMPORT",
  "segment": "LOW",
  "relative": 0.1,
  "absolute": 0.05
}'