List tariffs

GET

tariffs

elements

curl --request GET \
  --url https://api.flatpeak.com/tariffs/elements \
  --header 'Authorization: Bearer <token>'

{
  "object": "list",
  "url": "/tariffs",
  "has_more": false,
  "data": [
    {
      "id": "trf_66ba584eb6923d7c3b942ef6",
      "object": "tariff",
      "location_id": "loc_641b90b758fb8e6293716e40",
      "live_mode": true,
      "is_linked": false,
      "connection_type": "MANUAL",
      "direction": "IMPORT",
      "type": "COMMODITY",
      "status": "CONNECTED",
      "timezone": "Europe/London",
      "display_name": "Flexible Go 2023",
      "provider_id": "prv_63a6087272921ef075a8fd3e",
      "market_rates": false,
      "contract_start_date": "2023-01-24T00:00:00Z",
      "contract_end_date": "2024-01-24T00:00:00Z",
      "schedule": [
        {
          "months": [
            "All"
          ],
          "days_and_hours": [
            {
              "days": [
                "All"
              ],
              "hours": [
                {
                  "valid_from": "05:00:00",
                  "valid_to": "23:30:00",
                  "rate": [
                    {
                      "fixed": 23.431,
                      "to_kwh": 30.5,
                      "surcharge_fixed": 0.12,
                      "surcharge_percentage": 0.05
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "time_created": "2023-05-05T05:37:27Z",
      "account_id": "acc_661677911f2197045e6cf1b1"
    }
  ]
}

Authorizations

Authorization

string

header

required

Authenticate with bearer_token you obtained from /login endpoint.

Query Parameters

direction

any

Filter by tariff direction, supported values are IMPORT and EXPORT.

type

string

Filter by tariff type, supported values are COMMODITY and NON_COMMODITY.

Example:

"COMMODITY"

location_id

string

required

Filter by FlatPeak Location ID.

Example:

"loc_641b90b758fb8e6293716e40"

starting_after

string

Specifies a cursor for pagination use; provider_id defines the place in the list. To retrieve the next page in the list include starting_after where ID is the last ID in the currently retrieved list.

ending_before

string

Specifies a cursor for pagination use; provider_id defines the place in the list. To retrieve the previous page in the list include ending_before where is the first ID in the currently retrieved list.

limit

integer

A limit on the number of objects to be returned. Can range between 1 and 100, and the default is 30.

Response

200

application/json

Example response

object

string

required

Represents the object’s type. i.e. list.

Example:

"list"

url

string

required

Represents url slug for the object.

Example:

"/tariffs"

has_more

boolean

default:false

required

Is set to true if more objects are available.

data

object[]

data.id

string

required

Unique tariff element ID.

Example:

"trf_66ba584eb6923d7c3b942ef6"

data.object

string

required

FlatPeak object type. I.e. tariff_element.

Example:

"tariff"

data.location_id

string

required

FlatPeak Location ID this tariff element is associated with.

Example:

"loc_641b90b758fb8e6293716e40"

data.live_mode

boolean

required

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

data.is_linked

boolean

default:false

required

This indicates that the tariff is linked to an external data source and is automatically updated from this source. Such as when it's linked to your customer's provider account or to a tariff in the FlatPeak tariffs library. This value is set automatically by FlatPeak and cannot be changed.

data.connection_type

string

required

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

Example:

"MANUAL"

data.direction

string

required

Indicates direction of energy transfer this tariff applies to. Supported options are IMPORT, EXPORT or LOCAL. LOCAL direction is in beta. Contact support to enable.

Example:

"IMPORT"

data.type

string

required

Indicates tariff type you want to work with. Set to COMMODITY or NON_COMMODITY.

Example:

"COMMODITY"

data.status

string

required

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

Example:

"CONNECTED"

data.timezone

string

required

The timezone at the location, in 'tz database format'. I.e. 'Europe/Berlin'.

Example:

"Europe/London"

data.market_rates

boolean

default:false

required

Indicates if this tariff is based on a market rate.

data.contract_start_date

string

required

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

Example:

"2023-01-24T00:00:00Z"

data.contract_end_date

string

required

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

Example:

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

data.time_created

string

required

Indicates time when this tariff object was created.

Example:

"2023-05-05T05:37:27Z"

data.account_id

string

required

FlatPeak account ID.

Example:

"acc_661677911f2197045e6cf1b1"

data.display_name

string

Tariff display name.

Example:

"Flexible Go 2023"

data.provider_id

string

FlatPeak ID of the provider this tariff belongs to.

Example:

"prv_63a6087272921ef075a8fd3e"

data.schedule

object[]

Tariff schedule object.

Was this page helpful?

Suggest edits Raise issue

Delete a location Create a tariff

curl --request GET \
  --url https://api.flatpeak.com/tariffs/elements \
  --header 'Authorization: Bearer <token>'

{
  "object": "list",
  "url": "/tariffs",
  "has_more": false,
  "data": [
    {
      "id": "trf_66ba584eb6923d7c3b942ef6",
      "object": "tariff",
      "location_id": "loc_641b90b758fb8e6293716e40",
      "live_mode": true,
      "is_linked": false,
      "connection_type": "MANUAL",
      "direction": "IMPORT",
      "type": "COMMODITY",
      "status": "CONNECTED",
      "timezone": "Europe/London",
      "display_name": "Flexible Go 2023",
      "provider_id": "prv_63a6087272921ef075a8fd3e",
      "market_rates": false,
      "contract_start_date": "2023-01-24T00:00:00Z",
      "contract_end_date": "2024-01-24T00:00:00Z",
      "schedule": [
        {
          "months": [
            "All"
          ],
          "days_and_hours": [
            {
              "days": [
                "All"
              ],
              "hours": [
                {
                  "valid_from": "05:00:00",
                  "valid_to": "23:30:00",
                  "rate": [
                    {
                      "fixed": 23.431,
                      "to_kwh": 30.5,
                      "surcharge_fixed": 0.12,
                      "surcharge_percentage": 0.05
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "time_created": "2023-05-05T05:37:27Z",
      "account_id": "acc_661677911f2197045e6cf1b1"
    }
  ]
}

Service objects

Reporting

Planning

Authorizations

Query Parameters

Response