Skip to main content
POST
/
schedules
/
soc
Schedule by State of Charge
curl --request POST \
  --url https://api.flatpeak.com/schedules/soc \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "device_id": "dev_63a6087272941ef077a8fd3e",
  "schedule_horizon": 24
}
'
{
  "device_id": "dev_6563a6757360a6d6a628e839",
  "location_id": "loc_641b90b758fb8e6293716e40",
  "id": "ssc_65ea3fb185c1541f247c251e",
  "object": "schedule_soc",
  "account_id": "acc_661677911f2197045e6cf1b1",
  "live_mode": true,
  "location_timezone": "Europe/London",
  "currency_code": "GBP",
  "time_created": "2022-01-24T14:15:22Z",
  "data": [
    {
      "start_time": "2022-02-01T20:14:00Z",
      "end_time": "2022-02-02T06:00:00Z",
      "cost": {
        "value": 928.372,
        "confidence": 1
      },
      "schedule": [
        {
          "start_time": "2022-02-02T02:00:00Z",
          "end_time": "2022-02-02T04:30:00Z",
          "energy_flow_direction": "IMPORT",
          "power_kw": 4.3,
          "vpp_event": false
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Authenticate with bearer you obtained from authentication endpoint.

Body

application/json
​
device_id
string
required

Flatpeak Device ID.

Example:

"dev_63a6087272941ef077a8fd3e"

​
schedule_horizon
number
required

Number of hours into the future for which the schedule should be generated. Flatpeak may return a shorter schedule if sufficient data is unavailable. When omitted, the maximum available horizon is used.

Example:

24

​
device_state
Submit a device state · object

Submit the current operational state of a device, such as BESS state of charge and power.

Response

Example response

​
device_id
string
required

Flatpeak device ID.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$
Example:

"dev_6563a6757360a6d6a628e839"

​
location_id
string
required

Flatpeak location ID.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$
Example:

"loc_641b90b758fb8e6293716e40"

​
id
string
required

Flatpeak schedule id.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$
Example:

"ssc_65ea3fb185c1541f247c251e"

​
object
enum<string>
default:schedule_soc
required

Object type.

Available options:
schedule_soc
Example:

"schedule_soc"

​
account_id
string
required

Flatpeak Account ID.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$
Example:

"acc_661677911f2197045e6cf1b1"

​
live_mode
boolean
required

Set to true if the object exists in live mode, otherwise false.

Example:

true

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

Pattern: ^[A-Z]{3}$
Example:

"GBP"

​
time_created
string<date-time>
required

Time when this object was created, in UTC.

Example:

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

​
data
object[]

This object that contains device schedules.