Skip to main content
GET
/
locations
/
{id}
/
status
Retrieve a location 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,
  "time_created": "2023-11-07T05:31:56Z",
  "account_id": "acc_661677911f2197045e6cf1b1",
  "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": "E.ON 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": "Grid Fee",
        "structure_type": "FIXED",
        "contract_end_date": "2024-01-01T00:00:00Z"
      }
    },
    "non_commodity_export": {
      "status": "NOT_SUPPORTED"
    },
    "local": {
      "status": "NOT_SUPPORTED"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.flatpeak.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Authenticate with bearer you obtained from authentication endpoint.

Path Parameters

​
id
string
required

Flatpeak location_id

Response

Response example

​
id
string
required

Flatpeak unique location ID

Example:

"loc_641b90b758fb8e6293716e40"

​
object
string
required

Represents the object’s type. I.e. location_status.

Example:

"location_status"

​
live_mode
boolean
default:true
required

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

​
time_created
string<date-time>
required

Indicates time when this location was created.

Example:

"2023-11-07T05:31:56Z"

​
account_id
string
required

Flatpeak account ID.

Example:

"acc_661677911f2197045e6cf1b1"

​
tariff_status
object

Tariff status object.