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": "Network Fee",
        "structure_type": "FIXED",
        "contract_end_date": "2024-01-01T00:00:00Z"
      }
    },
    "non_commodity_export": {
      "status": "NOT_SUPPORTED"
    },
    "local": {
      "status": "NOT_SUPPORTED"
    }
  }
}

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": "Network Fee",
        "structure_type": "FIXED",
        "contract_end_date": "2024-01-01T00:00:00Z"
      }
    },
    "non_commodity_export": {
      "status": "NOT_SUPPORTED"
    },
    "local": {
      "status": "NOT_SUPPORTED"
    }
  }
}

Authorizations

Authorization

string

header

required

Authenticate with bearer_token you obtained from /login endpoint.

Path Parameters

string

required

Flatpeak location_id

Response

Example response

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.

Show child attributes

tariff_status.commodity_import

object

Status of commodity import tariff.

Show child attributes

tariff_status.commodity_import.status

string

Status of tariff element. Possible values are CONNECTED, NOT_CONNECTED or ERROR.

Example:

"CONNECTED"

tariff_status.commodity_import.connection_type

string

Represents tariff connection type. Set automatically by Flatpeak depending on how the tariff was created.

Example:

"DIRECT"

tariff_status.commodity_import.provider

object

Information about the provider of the tariff element.

Show child attributes

tariff_status.commodity_import.provider.id

string

Flatpeak ID of the provider this tariff belongs to.

Example:

"prv_63a6087272921ef075a8fd3e"

tariff_status.commodity_import.provider.display_name

string

Provider display name.

Example:

"Octopus Energy"

tariff_status.commodity_import.provider.logo_url

string

Image URL for the logo of the provider.

Example:

"https://s.flatpeak.com/83b06a60e38c2.png"

tariff_status.commodity_import.tariff

object

Information about the tariff element.

Show child attributes

tariff_status.commodity_import.tariff.id

string

Unique tariff element ID.

Example:

"trf_66ba584eb6923d7c3b942ef6"

tariff_status.commodity_import.tariff.display_name

string

Tariff display name.

Example:

"Flexible Go 2023"

tariff_status.commodity_import.tariff.structure_type

string

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.

Example:

"FIXED"

tariff_status.commodity_import.tariff.contract_end_date

string<date-time>

Indicates end date of the energy supply contract between customer and provider.

Example:

"2024-01-01T00:00:00Z"

tariff_status.commodity_export

object

Status of commodity export tariff.

Show child attributes

tariff_status.commodity_export.status

string

Status of tariff element. Possible values are CONNECTED, NOT_CONNECTED or ERROR.

Example:

"CONNECTED "

tariff_status.commodity_export.connection_type

string

Represents tariff connection type. Set automatically by Flatpeak depending on how tariff was created.

Example:

"MANUAL"

tariff_status.commodity_export.provider

object

Information about the provider of the tariff element.

Show child attributes

tariff_status.commodity_export.provider.id

string

Flatpeak ID of the provider this tariff belongs to.

Example:

"prv_63374fb151ea87296cd39ced"

tariff_status.commodity_export.provider.display_name

string

Provider display name.

Example:

"E.ON Next"

tariff_status.commodity_export.provider.logo_url

string

Image URL for the logo of the provider.

Example:

"https://s.flatpeak.com/83b06a60e38c2.png"

tariff_status.commodity_export.tariff

object

Information about the tariff element.

Show child attributes

tariff_status.commodity_export.tariff.id

string

Unique tariff element ID.

Example:

"trf_66ba584eb6923d7c3b942ef6"

tariff_status.commodity_export.tariff.display_name

string

Tariff display name.

Example:

"Export 2023"

tariff_status.commodity_export.tariff.structure_type

string

Example:

"TIME_OF_DAY"

tariff_status.commodity_export.tariff.contract_end_date

string<date-time>

Indicates end date of the energy supply contract between customer and provider.

Example:

"2024-01-01T00:00:00Z"

tariff_status.non_commodity_import

object

Status of non-commodity import tariff.

Show child attributes

tariff_status.non_commodity_import.status

string

Status of tariff element. Possible values are CONNECTED, NOT_CONNECTED or ERROR.

Example:

"ERROR"

tariff_status.non_commodity_import.connection_type

string

Represents tariff connection type. Set automatically by Flatpeak depending on how the tariff was created.

Example:

"DIRECT"

tariff_status.non_commodity_import.provider

object

Information about the provider of the tariff element.

Show child attributes

tariff_status.non_commodity_import.provider.id

string

Flatpeak ID of the provider this tariff belongs to.

Example:

"prv_63a6087272921ef075a8fd3e"

tariff_status.non_commodity_import.provider.display_name

string

Provider display name.

Example:

"Octopus Energy"

tariff_status.non_commodity_import.provider.logo_url

string

Image URL for the logo of the provider.

Example:

"https://s.flatpeak.com/83b06a60e38c2.png"

tariff_status.non_commodity_import.tariff

object

Information about the tariff element.

Show child attributes

tariff_status.non_commodity_import.tariff.id

string

Unique tariff element ID.

Example:

"trf_6728b0e6b6e6106dd5a88f8d"

tariff_status.non_commodity_import.tariff.display_name

string

Tariff display name.

Example:

"Network Fee"

tariff_status.non_commodity_import.tariff.structure_type

string

Example:

"FIXED"

tariff_status.non_commodity_import.tariff.contract_end_date

string<date-time>

Indicates end date of the energy supply contract between customer and provider.

Example:

"2024-01-01T00:00:00Z"

tariff_status.non_commodity_export

object

Status of non-commodity export tariff which is disabled as there are no known cases of this tariff type.

Show child attributes

tariff_status.non_commodity_export.status

string

Status of tariff element which is currently NOT_SUPPORTED.

Example:

"NOT_SUPPORTED"

tariff_status.local

object

Status of local generation tariff which is in beta.

Show child attributes

tariff_status.local.status

string

Status of tariff element which is currently NOT_SUPPORTED.

Example:

"NOT_SUPPORTED"

Retrieve a location Create a location

Connect

Scheduling

Cost Reporting

Retrieve a location status

Authorizations

Path Parameters

Response