README

欢迎使用 Agile Octopus API 包装器。
这可以包含在任何 PHP 项目中，并将很快适配 Laravel

您可以在 Octopus Energy 获取此包所需的所有信息

基本用法

安装 Agile Octopus API 简单到只需要通过 composer 引入

$ composer require kayrah87/agile-octopus-api

一旦将其包含到项目中，您就可以这样实例化 API

$api = new kayrah87\AgileOctopusAPI\API($account, $api_key, $tz);

$account 是您的 Octopus 账号。
$api_key 是您的 Octopus API 密钥。
$tz 是您的时区，通常是 'Europe/London'，但现在 Octopus 可在其他国家使用，因此可能值得检查。

$api->getElectricityPrice($region)

$region 是您希望获取电价的区域的 DNO 代码。更多信息或如果您不确定，请参阅 energy-stats.uk

可以使用以下方式调用半小时电价

$api->getHalfHourlyRates($region)

其中 $region 是您所需区域的 DNO。

可以通过以下方式调用电表点详情（仅限电）

$api->getMeterPointDetails($electricity_mpan)

其中 $electricity_mpan 是您在开发者仪表板下找到的电表 mpan。

这将返回一个具有以下属性的对象
GSP
MPAN
配置文件类别

可以使用以下方式调用电表点半小时消耗

$api->getMeterPointConsumption($electricity_mpan, $electricity_serial, $date)

$electricity_mpan 是您在开发者仪表板下找到的电表 mpan。
$electricity_serial 是您在开发者仪表板下找到的电表序列号。
$date 是您想要获取消耗的日期。

可以使用以下方式调用气表点半小时消耗

$api->getMeterPointConsumption($gas_mprn, $gas_serial, $date)

$gas_mprn 是您在开发者仪表板下找到的气表 MPRN。
$gas_serial 是您在开发者仪表板下找到的气表序列号。 $date 是您想要获取消耗的日期。

如果您有任何疑问，请创建一个 GitHub 问题。如果您喜欢此 API，请考虑告诉您的朋友并在这个过程中为他们和我各自赚取 50 英镑：这里