GET
/
slots
/
threshold
/
{id}
curl --request GET \
  --url https://api.flatpeak.com/slots/threshold/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "slt_65e42cdd73e9f861edda35d7",
  "object": "slot_threshold",
  "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

Query Parameters

start_time
string

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 90 days.

Example:

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

direction
string
default:IMPORT

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

Example:

"IMPORT"

segment
string
required

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

Example:

"LOW"

relative
number

Relative tariff threshold. Highest tariff is 1 and lowest is 0.01. Either relative or absolute must be provided.

absolute
number

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

Response

200
application/json

Example response

This object is a container for tariff rates segments.