Tariff.adoc

Admin - Lib - Tariff Configuration

Get or set the tariff settings.

Table of Contents

• Introduction
• Request
• Response
  • Root
  • Tariff Object
  • Tariff.Currency Object
  • Tariff.StorageSettings Object
  • Tariff.SingleRate Object
  • Schedule Object
• Examples
  • Get Tariff Configuration

Introduction

Enphase-API is an unofficial project providing an API wrapper and the documentation for Enphase®'s products and services.

More details on the project are available from the project’s homepage.

Request

A HTTP GET to the /admin/lib/tariff.json endpoint provides the following response data.

As of recent Gateway software versions this request requires user authentication and authorisation, see Authentication.

Response

Root

Name	Type	Values	Description
tariff	Object	Tariff object	Contains details about the electricity tariffs.
schedule	Object	Schedule object	Contains details about the different tariffs that apply at different times.

Tariff Object

Name	Type	Values	Description
currency	Object	Tariff.Currency object	The currency that any amounts are in
logger	String	String	???
storage_settings	Object	Tariff.StorageSettings object	Details about the storage settings.
single_rate	Object	Tariff.SingleRate object	A single rate tariff.
seasons	Array(Unknown)	Array of Unknown	Details about seasonal changes to electricity import rates.
seasons_sell	Array(Unknown)	Array of Unknown	Details about seasonal changes to electricity export rates.

Tariff.Currency Object

Name	Type	Values	Description
code	String	String	The code of the currency that any specified amounts are in (e.g. GBP = Great Britain Pound)

Tariff.StorageSettings Object

Name	Type	Values	Description
mode	String	StorageProfileMode	Storage profile mode. In the format StorageProfileMode.
operation_mode_sub_type	String	String	???
reserved_soc	Number	Number	What State of Charge (SoC) should be reserved for backup.
very_low_soc	Number	Number	???
charge_from_grid	Boolean	Boolean (e.g. true or false)	Whether charging from the grid is allowed.

Tariff.SingleRate Object

Name	Type	Values	Description
rate	Number	Number	The rate at which electricity is imported at.
sell	Number	Number	The rate at which electricity is sold at.

Schedule Object

Name	Type	Values	Description
source	String	String	???
date	String	String	???
version	String	String	???
reserved_soc	Number	Number	What State of Charge (SoC) should be reserved for backup.
operation_mode_sub_type	String	String	???
very_low_soc	Number	Number	What is deemed to be a very low State of Charge (SoC).
charge_from_grid	Boolean	Boolean (e.g. true or false)	Whether charging from the grid is allowed during this time.

Examples

Get Tariff Configuration

GET /admin/lib/tariff.json Response

{"tariff": {"currency": {"code": "GBP"}, "logger": "mylogger", "storage_settings": {"mode": "self-consumption", "operation_mode_sub_type": "", "reserved_soc": 0.0, "very_low_soc": 5, "charge_from_grid": false}, "single_rate": {"rate": 0.3279, "sell": 0.12}, "seasons": [], "seasons_sell": []}, "schedule": {"source": "Tariff", "date": "2023-04-11 10:14:21 UTC", "version": "00.00.02", "reserved_soc": 0.0, "operation_mode_sub_type": "", "very_low_soc": 5, "charge_from_grid": false}}