Get usage slots for required time amount
Returns a time slot when tariff is highest or lowest, over requested time period.
Useful when you need 5 hours of lowest price time over a given day. Slot might be split into a multiple segments unless you set continuous to true.
Authorizations
Authenticate with bearer_token you obtained from /login endpoint.
Path Parameters
FlatPeak Location ID
Query Parameters
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; mixed values are not allowed.
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; mixed values are not allowed. The maximum period between start_time and end_time for a single request is 90 days.
Indicates direction you want to work with. Set to IMPORT or EXPORT. Defaults to IMPORT.
Set to HIGH to get most expensive rate segment and to LOW to get cheapest segment.
Amount of time in minutes you need with lowest or highest (set segment=HIGH/LOW) tariff over requested period.
Returns single time period, without breaks.
Response
This object is a container for tariff slots response.
FlatPeak unique object id.
Represents the object's type.
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
The unique FlatPeak ID of the location.
The timezone at the location, in 'tz database format'. I.e. 'Europe/Berlin'.
Currency at the location in ISO 4217.
Direction of tariff. Supported options are IMPORT and EXPORT.
Time when we recommend fetching new rates. In format of the request, e.g. UTC or time-offset.
Your original request.
Slots response data.
Time when this response was calculated. In UTC.
FlatPeak account ID.
Was this page helpful?