Skip to main content
POST
/
schedules
/
limit
/
{id}
Schedule by price limit
curl --request POST \
  --url https://api.flatpeak.com/schedules/limit/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "start_time": "2023-06-15T09:00:00Z",
  "end_time": "2023-06-16T09:00:00Z",
  "direction": "IMPORT",
  "segment": "HIGH",
  "relative": 0.1,
  "absolute": 0.17
}'
{
  "id": "spl_65e42cdd73e9f861edda35d7",
  "object": "schedule_limit",
  "live_mode": true,
  "location_id": "loc_65e42ce4d3b813479b252160",
  "location_timezone": "Europe/London",
  "currency_code": "EUR",
  "direction": "IMPORT",
  "duration": 180,
  "next_update": "2022-05-24T23:00:00Z",
  "request": {
    "direction": "IMPORT",
    "segment": "HIGH",
    "absolute": 4.2,
    "relative": 0.5,
    "start_time": "2022-12-28T00:00:00Z",
    "end_time": "2022-12-28T06:00:00Z"
  },
  "data": [
    {
      "start_time": "2022-12-28T01:00:00Z",
      "end_time": "2022-12-28T02:30:00Z",
      "tariff": {
        "rate_avg": 4.998,
        "confidence": 1
      }
    }
  ],
  "time_created": "2022-05-24T15:15:22Z",
  "account_id": "acc_661677911f2197045e6cf1b1"
}

Authorizations

​
Authorization
string
header
required

Authenticate with bearer_token you obtained from /login endpoint.

Path Parameters

​
id
string
required

Flatpeak location_id.

Body

application/json
​
start_time
string
required

Time when data will start must be in RFC3339 format, e.g., 2023-06-15T09:00:00Z or with time offset, e.g., 2023-06-15T08:00:00+01:00. Use either Zulu time (UTC) or time offset; if time offsets differ, end_time takes priority.

Example:

"2023-06-15T09:00:00Z"

​
end_time
string
required

Time when data will end, in RFC3339 format, e.g. 2023-06-15T13:00:00Z or with time offset, e.g. 2023-06-15T12:00:00+01:00. Use either Zulu time (UTC) or time offset; if time offsets differ, end_time takes priority. The maximum period between start_time and end_time for a single request is 3 days.

Example:

"2023-06-16T09:00:00Z"

​
segment
string
required

Set to HIGH to get the most expensive rate segment and to LOW to get the cheapest segment.

Example:

"HIGH"

​
direction
string

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

Example:

"IMPORT"

​
relative
number

Relative tariff threshold. The highest tariff is 1, and the lowest is 0.01. Either relative or absolute must be provided.

Example:

0.1

​
absolute
number
default:0.17

Absolute tariff threshold in local currency. Either absolute or relative must be provided. Absolute threshold overrides relative if it was provided. Use major currency units.

Response

Example response

This object is a container for tariff rate segments.

​
id
string
required

Flatpeak unique object id.

Example:

"spl_65e42cdd73e9f861edda35d7"

​
object
string
required

Represents the object's type.

Example:

"schedule_limit"

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

​
location_id
string
required

The unique Flatpeak ID of the location.

Example:

"loc_65e42ce4d3b813479b252160"

​
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 at the location in ISO 4217.

Example:

"EUR"

​
direction
string
required

Direction of tariff. Supported options are IMPORT and EXPORT.

Example:

"IMPORT"

​
duration
number
required

Total amount of time in minutes for all calculated slots.

Example:

180

​
next_update
string
required

Time when we recommend fetching new rates. In the format of the request, e.g. UTC or time-offset.

Example:

"2022-05-24T23:00:00Z"

​
request
object
required

Your original request.

​
data
object[]
required

Rates response data.

​
time_created
string<date-time>
required

Time when this response was calculated. In UTC.

Example:

"2022-05-24T15:15:22Z"

​
account_id
string
required

Flatpeak account ID.

Example:

"acc_661677911f2197045e6cf1b1"

⌘I