List schedules

GET

schedules

curl --request GET \
  --url https://api.flatpeak.com/schedules \
  --header 'Authorization: Bearer <token>'

{
  "object": "list",
  "url": "/schedules",
  "has_more": true,
  "data": [
    {
      "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
      },
      "shaving_threshold": {
        "relative": 0.83,
        "absolute": 0.123
      },
      "tariff": {
        "value": 928.372,
        "confidence": 1
      },
      "savings": {
        "value": 0.0239,
        "percentage": 1.34
      },
      "data": [
        {
          "device_id": "dev_664525107c44d88a37ca1ad7",
          "direction": "IMPORT",
          "start_time": "2022-02-01T20:14:00Z",
          "end_time": "2022-02-02T06:00:00Z",
          "max_power": {
            "units": "W",
            "value": 7000
          },
          "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
              }
            }
          ]
        }
      ],
      "time_created": "2022-01-24T14:15:22Z",
      "account_id": "acc_661677911f2197045e6cf1b1"
    }
  ]
}

Authorizations

Authorization

string

header

required

Authenticate with bearer_token you obtained from /login endpoint.

Query Parameters

location_id

string

Filter by FlatPeak Location ID.

starting_after

string

Specifies a cursor for pagination use; provider_id defines the place in the list. To retrieve the next page in the list include starting_after where ID is the last ID in the currently retrieved list.

limit

integer

A limit on the number of objects to be returned. Can range between 1 and 100, and the default is 30.

ending_before

string

Specifies a cursor for pagination use; provider_id defines the place in the list. To retrieve the previous page in the list include ending_before where is the first ID in the currently retrieved list.

Response

200

application/json

object

string

required

Represents the object’s type. i.e. list.

Example:

"list"

url

string

required

Represents url slug for the object.

Example:

"/schedules"

has_more

boolean

required

Is set to true if more objects are available.

data

object[]

data.id

string

required

FlatPeak schedule id.

Example:

"sch_65ea3fb185c1541f247c251e"

data.object

string

required

Represents the object’s type.

Example:

"schedule"

data.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

data.location_id

string

required

FlatPeak location ID where this schedule applies.

Example:

"loc_641b90b758fb8e6293716e40"

data.location_timezone

string

required

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

Example:

"Europe/London"

data.currency_code

string

required

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

Example:

"GBP"

data.max_power

object

required

Maximum speed of power transfer for that location.

data.tariff

object

required

Monetary cost of energy in the schedule.

data.savings

object

required

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

data.time_created

string

required

Time when this object was created, in UTC.

Example:

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

data.account_id

string

required

FlatPeak account ID.

Example:

"acc_661677911f2197045e6cf1b1"

data.shaving_threshold

object

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

data.data

object[]

This object that contains device schedules.

data.data.device_id

string

required

FlatPeak device ID.

Example:

"dev_664525107c44d88a37ca1ad7"

data.data.direction

string

required

Example:

"IMPORT"

data.data.start_time

string

required

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

Example:

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

data.data.end_time

string

required

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

Example:

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

data.data.energy

object

required

Amount of energy required.

data.data.tariff

object

required

Monetary value of energy.

data.data.savings

object

required

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

data.data.schedule

object[]

required

Core schedule object.

data.data.max_power

object

Requested speed of power transfer.

Was this page helpful?

Suggest edits Raise issue

Tariff level threshold Create a schedule

curl --request GET \
  --url https://api.flatpeak.com/schedules \
  --header 'Authorization: Bearer <token>'

{
  "object": "list",
  "url": "/schedules",
  "has_more": true,
  "data": [
    {
      "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
      },
      "shaving_threshold": {
        "relative": 0.83,
        "absolute": 0.123
      },
      "tariff": {
        "value": 928.372,
        "confidence": 1
      },
      "savings": {
        "value": 0.0239,
        "percentage": 1.34
      },
      "data": [
        {
          "device_id": "dev_664525107c44d88a37ca1ad7",
          "direction": "IMPORT",
          "start_time": "2022-02-01T20:14:00Z",
          "end_time": "2022-02-02T06:00:00Z",
          "max_power": {
            "units": "W",
            "value": 7000
          },
          "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
              }
            }
          ]
        }
      ],
      "time_created": "2022-01-24T14:15:22Z",
      "account_id": "acc_661677911f2197045e6cf1b1"
    }
  ]
}

Service objects

Reporting

Planning

Authorizations

Query Parameters

Response