- Introduction
- Authorization
- Events
- Customers
- Locations
- Tariff (elements)
- Devices
Connect
- Token management
- Session management
- Main pages
- Service pages
Cost reporting
- Meter submissions
- Cost calculations
- Raw tariff rates
Locations
Retrieve a location status
This endpoint supports Locations with up to one each of
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@flatpeak.com for assistance.Retrieves current status of a location.
GET
/
locations
/
{id}
/
status
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
200
application/json
Example response
The response is of type object
.
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"
}
Assistant
Responses are generated using AI and may contain mistakes.