Service objects
- Introduction
- API Authorization
- Connect Authorization
- Events
- Customers
- Locations
- Tariff elements
- Devices
Reporting
- Metering
- Cost calculations
- Tariff rates
Planning
- Slots
- Schedules
Retrieve a location status
commodity_import, commodity_export, non_commodity_import, and non_commodity_export tariff elements, covering all use cases currently supported by Connect. If your implementation requires more (typically complex industrial cases) contact support for assistance.Retrieves current status of a location.
curl --request GET \
--url https://api.flatpeak.com/locations/{id}/status \
--header 'Authorization: Bearer <token>'{
"id": "loc_641b90b758fb8e6293716e40",
"object": "location_status",
"live_mode": true,
"tariff_status": {
"commodity_import": {
"status": "CONNECTED",
"connection_type": "DIRECT",
"provider": {
"id": "prv_63a6087272921ef075a8fd3e",
"display_name": "Octopus Energy",
"logo_url": "https://s.flatpeak.com/83b06a60e38c2.png"
},
"tariff": {
"id": "trf_66ba584eb6923d7c3b942ef6",
"display_name": "Flexible Go 2023",
"structure_type": "FIXED",
"contract_end_date": "2024-01-01T00:00:00Z"
}
},
"commodity_export": {
"status": "CONNECTED ",
"connection_type": "MANUAL",
"provider": {
"id": "prv_63374fb151ea87296cd39ced",
"display_name": "Eon Next",
"logo_url": "https://s.flatpeak.com/83b06a60e38c2.png"
},
"tariff": {
"id": "trf_66ba584eb6923d7c3b942ef6",
"display_name": "Export 2023",
"structure_type": "TIME_OF_DAY",
"contract_end_date": "2024-01-01T00:00:00Z"
}
},
"non_commodity_import": {
"status": "ERROR",
"connection_type": "DIRECT",
"provider": {
"id": "prv_63a6087272921ef075a8fd3e",
"display_name": "Octopus Energy",
"logo_url": "https://s.flatpeak.com/83b06a60e38c2.png"
},
"tariff": {
"id": "trf_6728b0e6b6e6106dd5a88f8d",
"display_name": "Network Fee",
"structure_type": "FIXED",
"contract_end_date": "2024-01-01T00:00:00Z"
}
},
"non_commodity_export": {
"status": "NOT_SUPPORTED"
},
"local": {
"status": "NOT_SUPPORTED"
}
},
"time_created": "2023-11-07T05:31:56Z",
"account_id": "acc_661677911f2197045e6cf1b1"
}Authorizations
Path Parameters
FlatPeak location_id
Response
FlatPeak unique location Id
"loc_641b90b758fb8e6293716e40"
Represents the object’s type. I.e. location_status.
"location_status"
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Indicates time when this location was created.
"2023-11-07T05:31:56Z"
FlatPeak account ID.
"acc_661677911f2197045e6cf1b1"
Tariff status object.
Status of commodity import tariff.
Status of tariff element. Possible values are CONNECTED, NOT_CONNECTED or ERROR.
"CONNECTED"
Represents tariff connection type. Set automatically by FlatPeak depending on how tariff was created.
"DIRECT"
Information about the provider of the tariff element.
FlatPeak ID of the provider this tariff belongs to.
"prv_63a6087272921ef075a8fd3e"
Provider display name.
"Octopus Energy"
Image URL for the logo of the provider.
"https://s.flatpeak.com/83b06a60e38c2.png"
Information about the the tariff element.
Unique tariff element ID.
"trf_66ba584eb6923d7c3b942ef6"
Tariff display name.
"Flexible Go 2023"
FIXED - a flat rate tariff; TIME_OF_DAY - a tariff that varies based on specific times of day or other cyclical factors (e.g., day of the week, month, or season); MARKET - a tariff based on the market rate; DYNAMIC - a continuously changing tariff that is not directly tied to the market rate.
"FIXED"
Indicates end date of the energy supply contract between customer and provider.
"2024-01-01T00:00:00Z"
Status of commodity export tariff.
Status of tariff element. Possible values are CONNECTED, NOT_CONNECTED or ERROR.
"CONNECTED "
Represents tariff connection type. Set automatically by FlatPeak depending on how tariff was created.
"MANUAL"
Information about the provider of the tariff element.
FlatPeak ID of the provider this tariff belongs to.
"prv_63374fb151ea87296cd39ced"
Provider display name.
"Eon Next"
Image URL for the logo of the provider.
"https://s.flatpeak.com/83b06a60e38c2.png"
Information about the the tariff element.
Unique tariff element ID.
"trf_66ba584eb6923d7c3b942ef6"
Tariff display name.
"Export 2023"
FIXED - a flat rate tariff; TIME_OF_DAY - a tariff that varies based on specific times of day or other cyclical factors (e.g., day of the week, month, or season); MARKET - a tariff based on the market rate; DYNAMIC - a continuously changing tariff that is not directly tied to the market rate.
"TIME_OF_DAY"
Indicates end date of the energy supply contract between customer and provider.
"2024-01-01T00:00:00Z"
Status of non commodity import tariff.
Status of tariff element. Possible values are CONNECTED, NOT_CONNECTED or ERROR.
"ERROR"
Represents tariff connection type. Set automatically by FlatPeak depending on how tariff was created.
"DIRECT"
Information about the provider of the tariff element.
FlatPeak ID of the provider this tariff belongs to.
"prv_63a6087272921ef075a8fd3e"
Provider display name.
"Octopus Energy"
Image URL for the logo of the provider.
"https://s.flatpeak.com/83b06a60e38c2.png"
Information about the the tariff element.
Unique tariff element ID.
"trf_6728b0e6b6e6106dd5a88f8d"
Tariff display name.
"Network Fee"
FIXED - a flat rate tariff; TIME_OF_DAY - a tariff that varies based on specific times of day or other cyclical factors (e.g., day of the week, month, or season); MARKET - a tariff based on the market rate; DYNAMIC - a continuously changing tariff that is not directly tied to the market rate.
"FIXED"
Indicates end date of the energy supply contract between customer and provider.
"2024-01-01T00:00:00Z"
Status of non commodity export tariff which is disabled as there are no known cases of this tariff type.
Status of tariff element which is currently NOT_SUPPORTED.
"NOT_SUPPORTED"
Was this page helpful?
curl --request GET \
--url https://api.flatpeak.com/locations/{id}/status \
--header 'Authorization: Bearer <token>'{
"id": "loc_641b90b758fb8e6293716e40",
"object": "location_status",
"live_mode": true,
"tariff_status": {
"commodity_import": {
"status": "CONNECTED",
"connection_type": "DIRECT",
"provider": {
"id": "prv_63a6087272921ef075a8fd3e",
"display_name": "Octopus Energy",
"logo_url": "https://s.flatpeak.com/83b06a60e38c2.png"
},
"tariff": {
"id": "trf_66ba584eb6923d7c3b942ef6",
"display_name": "Flexible Go 2023",
"structure_type": "FIXED",
"contract_end_date": "2024-01-01T00:00:00Z"
}
},
"commodity_export": {
"status": "CONNECTED ",
"connection_type": "MANUAL",
"provider": {
"id": "prv_63374fb151ea87296cd39ced",
"display_name": "Eon Next",
"logo_url": "https://s.flatpeak.com/83b06a60e38c2.png"
},
"tariff": {
"id": "trf_66ba584eb6923d7c3b942ef6",
"display_name": "Export 2023",
"structure_type": "TIME_OF_DAY",
"contract_end_date": "2024-01-01T00:00:00Z"
}
},
"non_commodity_import": {
"status": "ERROR",
"connection_type": "DIRECT",
"provider": {
"id": "prv_63a6087272921ef075a8fd3e",
"display_name": "Octopus Energy",
"logo_url": "https://s.flatpeak.com/83b06a60e38c2.png"
},
"tariff": {
"id": "trf_6728b0e6b6e6106dd5a88f8d",
"display_name": "Network Fee",
"structure_type": "FIXED",
"contract_end_date": "2024-01-01T00:00:00Z"
}
},
"non_commodity_export": {
"status": "NOT_SUPPORTED"
},
"local": {
"status": "NOT_SUPPORTED"
}
},
"time_created": "2023-11-07T05:31:56Z",
"account_id": "acc_661677911f2197045e6cf1b1"
}