Create consumption or export schedule for a given duration of time, speed of transfer and amount of energy required

curl --request POST \
  --url https://api.flatpeak.com/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "location_id": "loc_641b90b758fb8e6293716e40",
  "max_power": {
    "units": "W",
    "value": 14000
  },
  "shaving_threshold": {
    "relative": 0.83,
    "absolute": 0.123
  },
  "data": [
    {
      "device_id": "dev_65e6d8334c8d715963d99db3",
      "direction": "IMPORT",
      "start_time": "2022-02-01T20:14:00Z",
      "end_time": "2022-02-02T06:00:00Z",
      "energy": {
        "units": "WH",
        "value": 24500
      },
      "max_power": {
        "units": "W",
        "value": 7000
      }
    }
  ]
}
'

{
  "id": "sch_65ea3fb185c1541f247c251e",
  "object": "schedule",
  "live_mode": true,
  "location_id": "loc_641b90b758fb8e6293716e40",
  "location_timezone": "Europe/London",
  "currency_code": "GBP",
  "max_power": {
    "units": "W",
    "value": 14000
  },
  "tariff": {
    "value": 928.372,
    "confidence": 1
  },
  "savings": {
    "value": 0.0239,
    "percentage": 1.34
  },
  "time_created": "2022-01-24T14:15:22Z",
  "account_id": "acc_661677911f2197045e6cf1b1",
  "shaving_threshold": {
    "relative": 0.83,
    "absolute": 0.123
  },
  "data": [
    {
      "device_id": "dev_664525107c44d88a37ca1ad7",
      "direction": "IMPORT",
      "start_time": "2022-02-01T20:14:00Z",
      "end_time": "2022-02-02T06:00:00Z",
      "energy": {
        "units": "WH",
        "value": 34000
      },
      "tariff": {
        "value": 928.372,
        "confidence": 1
      },
      "savings": {
        "value": 0.2375,
        "percentage": 0.11
      },
      "schedule": [
        {
          "start_time": "2022-02-02T02:00:00Z",
          "end_time": "2022-02-02T04:30:00Z",
          "power": {
            "units": "W",
            "value": 11000
          }
        }
      ],
      "max_power": {
        "units": "W",
        "value": 7000
      }
    }
  ]
}

POST

schedules

curl --request POST \
  --url https://api.flatpeak.com/schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "location_id": "loc_641b90b758fb8e6293716e40",
  "max_power": {
    "units": "W",
    "value": 14000
  },
  "shaving_threshold": {
    "relative": 0.83,
    "absolute": 0.123
  },
  "data": [
    {
      "device_id": "dev_65e6d8334c8d715963d99db3",
      "direction": "IMPORT",
      "start_time": "2022-02-01T20:14:00Z",
      "end_time": "2022-02-02T06:00:00Z",
      "energy": {
        "units": "WH",
        "value": 24500
      },
      "max_power": {
        "units": "W",
        "value": 7000
      }
    }
  ]
}
'

{
  "id": "sch_65ea3fb185c1541f247c251e",
  "object": "schedule",
  "live_mode": true,
  "location_id": "loc_641b90b758fb8e6293716e40",
  "location_timezone": "Europe/London",
  "currency_code": "GBP",
  "max_power": {
    "units": "W",
    "value": 14000
  },
  "tariff": {
    "value": 928.372,
    "confidence": 1
  },
  "savings": {
    "value": 0.0239,
    "percentage": 1.34
  },
  "time_created": "2022-01-24T14:15:22Z",
  "account_id": "acc_661677911f2197045e6cf1b1",
  "shaving_threshold": {
    "relative": 0.83,
    "absolute": 0.123
  },
  "data": [
    {
      "device_id": "dev_664525107c44d88a37ca1ad7",
      "direction": "IMPORT",
      "start_time": "2022-02-01T20:14:00Z",
      "end_time": "2022-02-02T06:00:00Z",
      "energy": {
        "units": "WH",
        "value": 34000
      },
      "tariff": {
        "value": 928.372,
        "confidence": 1
      },
      "savings": {
        "value": 0.2375,
        "percentage": 0.11
      },
      "schedule": [
        {
          "start_time": "2022-02-02T02:00:00Z",
          "end_time": "2022-02-02T04:30:00Z",
          "power": {
            "units": "W",
            "value": 11000
          }
        }
      ],
      "max_power": {
        "units": "W",
        "value": 7000
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Authenticate with bearer_token you obtained from /login endpoint.

Body

application/json

location_id

string

required

Flatpeak location ID for which you want to generate the schedule.

Example:

"loc_641b90b758fb8e6293716e40"

max_power

object

required

Maximum speed of power transfer for that location.

Show child attributes

max_power.units

string

required

Units of measure of power transfer. Supported value is W and KW.

Example:

"W"

max_power.value

number

required

Speed power transfer is power.units.

Example:

14000

shaving_threshold

object

Tariff cap. Specifies up to what price you are willing to pay to buy (or, in reverse, sell) energy.

Show child attributes

shaving_threshold.relative

number

Relative tariff cap. Where the highest tariff over the requested period is 1 and the lowest is 0.01, provide the value up to which you are willing to buy energy.

Example:

0.83

shaving_threshold.absolute

number

Absolute tariff cap in local currency. Overrides relative value if provided.

Example:

0.123

data

object[]

This object that contains device schedule requests.

Show child attributes

data.device_id

string

required

Flatpeak device ID.

Example:

"dev_65e6d8334c8d715963d99db3"

data.direction

string

required

Indicates direction you want to work with. Set to IMPORT or EXPORT. Defaults to IMPORT.

Example:

"IMPORT"

data.start_time

string<date-time>

required

Time when transfer of energy may begin. In RFC3339 format e.g. 2023-06-15T09:00:00Z or with time-offset, e.g. 2023-06-15T08:00:00+01:00.

Example:

"2022-02-01T20:14:00Z"

data.end_time

string<date-time>

required

Time when transfer of energy must be completed. In RFC3339 format e.g. 2023-06-15T11:00:00Z or with time-offset, e.g. 2023-06-15T10:00:00+01:00.

Example:

"2022-02-02T06:00:00Z"

data.energy

object

required

Energy requirement envelope.

Show child attributes

data.energy.units

string

required

Units of measure, supported values are WH, KWH.

Example:

"WH"

data.energy.value

number

required

Amount of energy required.

Example:

24500

data.max_power

object

Requested speed of power transfer.

Show child attributes

data.max_power.units

string

Units of measure of power transfer. Supported values are W and KW.

Example:

"W"

data.max_power.value

number

Speed power transfer is power.units.

Example:

7000

Response

string

required

Flatpeak schedule id.

Example:

"sch_65ea3fb185c1541f247c251e"

object

string

required

Represents the object’s type.

Example:

"schedule"

live_mode

boolean

required

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Example:

true

location_id

string

required

Flatpeak location ID where this schedule applies.

Example:

"loc_641b90b758fb8e6293716e40"

location_timezone

string

required

The timezone at the location, in 'tz database format'. I.e. 'Europe/Berlin'.

Example:

"Europe/London"

currency_code

string

required

Currency code for cost of energy measure. Always returned in large currency units.

Example:

"GBP"

max_power

object

required

Maximum speed of power transfer for that location.

Show child attributes

max_power.units

string

required

Units of measure of power transfer. Supported value is W and KW.

Example:

"W"

max_power.value

number

required

Speed power transfer is power.units.

Example:

14000

tariff

object

required

Monetary cost of energy in the schedule.

Show child attributes

tariff.value

number

required

Monetary energy cost in large currency units.

Example:

928.372

tariff.confidence

number

required

Estimated confidence of data where '1' is 100% accurate and 0.1 is 10% accurate.

Example:

1

savings

object

required

Savings provided by the schedule by applying (1) tariff shaving and (2) tariff-based optimisation. The shaving is applied first.

Show child attributes

savings.value

number

required

Amount of money, in large currency units saved.

Example:

0.0239

savings.percentage

number

required

Percentage of cost saved.

Example:

1.34

time_created

string<date-time>

required

Time when this object was created, in UTC.

Example:

"2022-01-24T14:15:22Z"

account_id

string

required

Flatpeak account ID.

Example:

"acc_661677911f2197045e6cf1b1"

shaving_threshold

object

Tariff cap. Specifies up to what price you are willing to pay to buy (or, in reverse, sell) energy.

Show child attributes

shaving_threshold.relative

number

Relative tariff cap. Where the highest tariff over the requested period is 1 and the lowest is 0.01, provide the value up to which you are willing to buy energy. Defaults to 1.

Example:

0.83

shaving_threshold.absolute

number

Absolute tariff cap in local currency using large units. Defaults to unlimited if no value is provided. Overrides relative value if provided.

Example:

0.123

data

object[]

This object that contains device schedules.

Show child attributes

data.device_id

string

required

Flatpeak device ID.

Example:

"dev_664525107c44d88a37ca1ad7"

data.direction

string

required

Example:

"IMPORT"

data.start_time

string<date-time>

required

Time when energy transfer can begin, in timezone of the original request.

Example:

"2022-02-01T20:14:00Z"

data.end_time

string<date-time>

required

Time when energy transfer must be completed, in timezone of the original request.

Example:

"2022-02-02T06:00:00Z"

data.energy

object

required

Amount of energy required.

Show child attributes

data.energy.units

string

required

Units of energy measure. Supported values are WH and KWH.

Example:

"WH"

data.energy.value

number

required

Amount of energy to be transferred.

Example:

34000

data.tariff

object

required

Monetary value of energy.

Show child attributes

data.tariff.value

number

required

Monetary value in large currency units.

Example:

928.372

data.tariff.confidence

number

required

Estimated confidence of data where '1' is 100% accurate and 0.1 is 10% accurate.

Example:

1

data.savings

object

required

Savings provided by the schedule by applying (1) tariff shaving and (2) tariff-based optimisation. The shaving is applied first.

Show child attributes

data.savings.value

number

required

Amount of money, in large currency units saved.

Example:

0.2375

data.savings.percentage

number

required

Percentage of cost saved.

Example:

0.11

data.schedule

object[]

required

Core schedule object.

Show child attributes

data.schedule.start_time

string<date-time>

required

Time when energy transfer must start, in timezone of the original request.

Example:

"2022-02-02T02:00:00Z"

data.schedule.end_time

string<date-time>

required

Time when energy transfer must end, in timezone of the original request.

Example:

"2022-02-02T04:30:00Z"

data.schedule.power

object

required

Speed of power transfer.

Show child attributes

data.schedule.power.units

string

required

Units of measure of power transfer.

Example:

"W"

data.schedule.power.value

number

required

Speed power transfer is power.units.

Example:

11000

data.max_power

object

Requested speed of power transfer.

Show child attributes

data.max_power.units

string

Units of measure of power transfer. Supported value is W and KW.

Example:

"W"

data.max_power.value

number

Speed power transfer is power.units.

Example:

7000

By price limit Instantly on-demand

Connect

Scheduling

Cost Reporting

Create consumption or export schedule for a given duration of time, speed of transfer and amount of energy required

Authorizations

Body

Response