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

Response

200
application/json

Example response

This object is a container for tariff rate segments.