Search tariff data by region

GET

tariff

region

{region}

curl --request GET \
  --url https://to-be-hosted-by-each-service-provider/tariff/region/{region}

[
  {
    "object": "tariff",
    "object_version": "1.0",
    "provider_id": "prv_63a6087272921ef075a8fd3e",
    "supplier_label": "ACME Retail Energy Ltd",
    "tariff_reference": "gb-acme",
    "tariff_label": "Online Fixed",
    "location_id": "loc_641b90b758fb8e6293716e40",
    "region": "UKPN",
    "live_mode": true,
    "tariff_date": "2023-04-16T00:00:00+01:00",
    "tariff_version": "22",
    "tariff_expiry": "2026-04-16T00:00:00+01:00",
    "contract_start_date": "2024-09-14T00:00:00+01:00",
    "contract_end_date": "2025-09-13T00:00:00+01:00",
    "mpxn": "1012345678901",
    "is_linked": false,
    "direction": "IMPORT",
    "tariff_type": "COMMODITY",
    "timezone": "Europe/London",
    "tariff_schedule": [
      {
        "time_of_use": "DYNAMIC",
        "standing_charge": 0.321,
        "months": [
          "All"
        ],
        "days_and_hours": [
          {
            "days": [
              "All"
            ],
            "hours": [
              {
                "valid_from": "00:00:00",
                "valid_to": "00:00:00",
                "rate": [
                  {
                    "to_kwh": 30.5,
                    "value": 0.12
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "time_created": "2023-05-15T05:37+01:00"
  }
]

Path Parameters

region

string

required

Region to filter the data by

Response

A filtered list of data entries

object

string

Example:

"tariff"

object_version

string

Example:

"1.0"

provider_id

string

Internal ID of the provider the tariff belongs to.

Example:

"prv_63a6087272921ef075a8fd3e"

supplier_label

string

Example:

"ACME Retail Energy Ltd"

tariff_reference

string

Example:

"gb-acme"

tariff_label

string

Example:

"Online Fixed"

location_id

string

Internal Location ID the tariff element is associated with.

Example:

"loc_641b90b758fb8e6293716e40"

region

string

Example:

"UKPN"

live_mode

boolean

Value true if the object exists in live mode or false if it exists in test mode.

Example:

true

tariff_date

string<date-time>

Date format in ISO 8601.

Example:

"2023-04-16T00:00:00+01:00"

tariff_version

string

Example:

"22"

tariff_expiry

string<date-time>

Date format in ISO 8601.

Example:

"2026-04-16T00:00:00+01:00"

contract_start_date

string<date-time>

Indicates start date (ISO 8601 format) of the energy supply contract between customer and provider.

Example:

"2024-09-14T00:00:00+01:00"

contract_end_date

string<date-time>

Indicates end date (ISO 8601 format) of the energy supply contract between customer and provider.

Example:

"2025-09-13T00:00:00+01:00"

mpxn

string

Example:

"1012345678901"

is_linked

boolean

Indicates that the tariff is linked to an external data source and is automatically updated.

Example:

false

direction

enum<string>

Indicates direction of energy transfer this tariff applies to.

Available options:

IMPORT,

EXPORT

Example:

"IMPORT"

tariff_type

enum<string>

Indicates tariff type.

Available options:

COMMODITY,

NON_COMMODITY

Example:

"COMMODITY"

timezone

string

The timezone at the location, in 'tz database format'.

Example:

"Europe/London"

tariff_schedule

object[]

Tariff schedule object.

Show child attributes

tariff_schedule.time_of_use

enum<string>

Type of time-of-use (TOU) tariff.

Available options:

STATIC,

DYNAMIC

Example:

"DYNAMIC"

tariff_schedule.standing_charge

number

Charge per day.

Example:

0.321

tariff_schedule.months

string[]

Array of 3-letter month abbreviations when the tariff is valid (Jan...Dec). "All" specifies all months.

Example:

["All"]

tariff_schedule.days_and_hours

object[]

Show child attributes

tariff_schedule.days_and_hours.days

string[]

Days when schedule is valid.

Example:

["All"]

tariff_schedule.days_and_hours.hours

object[]

Show child attributes

tariff_schedule.days_and_hours.hours.valid_from

string

Hours from when the schedule is valid. Format HH:MM:SS.

Example:

"00:00:00"

tariff_schedule.days_and_hours.hours.valid_to

string

Hours to when the schedule is valid. Format HH:MM:SS.

Example:

"00:00:00"

tariff_schedule.days_and_hours.hours.rate

object[]

Show child attributes

tariff_schedule.days_and_hours.hours.rate.to_kwh

number | null

Specifies up to what kWh tariff applies. Used for tier-based tariffs. If no tiers, leave null.

Example:

30.5

tariff_schedule.days_and_hours.hours.rate.value

number | null

Non-null value means £ per kWh.

Example:

0.12

time_created

string<date-time>

Indicates time (ISO 8601 format) when this tariff object was created.

Example:

"2023-05-15T05:37+01:00"

Machine-to-Machine AuthenticationAuthenticates a machine using OpenID Connect (OIDC) for M2M communication.

⌘I

Search tariff data by region

curl --request GET \
  --url https://to-be-hosted-by-each-service-provider/tariff/region/{region}

[
  {
    "object": "tariff",
    "object_version": "1.0",
    "provider_id": "prv_63a6087272921ef075a8fd3e",
    "supplier_label": "ACME Retail Energy Ltd",
    "tariff_reference": "gb-acme",
    "tariff_label": "Online Fixed",
    "location_id": "loc_641b90b758fb8e6293716e40",
    "region": "UKPN",
    "live_mode": true,
    "tariff_date": "2023-04-16T00:00:00+01:00",
    "tariff_version": "22",
    "tariff_expiry": "2026-04-16T00:00:00+01:00",
    "contract_start_date": "2024-09-14T00:00:00+01:00",
    "contract_end_date": "2025-09-13T00:00:00+01:00",
    "mpxn": "1012345678901",
    "is_linked": false,
    "direction": "IMPORT",
    "tariff_type": "COMMODITY",
    "timezone": "Europe/London",
    "tariff_schedule": [
      {
        "time_of_use": "DYNAMIC",
        "standing_charge": 0.321,
        "months": [
          "All"
        ],
        "days_and_hours": [
          {
            "days": [
              "All"
            ],
            "hours": [
              {
                "valid_from": "00:00:00",
                "valid_to": "00:00:00",
                "rate": [
                  {
                    "to_kwh": 30.5,
                    "value": 0.12
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "time_created": "2023-05-15T05:37+01:00"
  }
]