baspa/energyzero-php-api

EnergyZero的动态价格PHP客户端

v1.0.4 2024-08-26 17:31 UTC

This package is auto-updated.

Last update: 2024-09-27 06:39:38 UTC


README

Latest Version on Packagist Tests PHPStan Total Downloads

此PHP包提供了从EnergyZero API获取动态能源价格的客户端。它允许您检索指定日期范围内的能源价格,具有自定义间隔和增值税选项。

安装

您可以通过composer安装此包

composer require baspa/energyzero-php-api

用法

您可以使用特定的间隔和增值税选项检索指定日期范围内的能源价格。当未提供增值税选项时,它将默认为true。请确保您提供日期格式为Y-m-d

use Baspa\EnergyZero;

$prices = (new EnergyZero())->energyPrices(
    startDate: '2024-01-01',
    endDate: '2024-01-02',
    interval: 4,
    vat: true
);

响应将是一个指定日期范围内的价格数组,并包括该期间的平均价格。

获取某一段期间内的最低价格

$lowestPrice = (new EnergyZero())->getLowestPriceForPeriod(
    startDate: '2024-01-01',
    endDate: '2024-01-02',
    vat: true
);

获取某一段期间内的最高价格

$highestPrice = (new EnergyZero())->getHighestPriceForPeriod(
    startDate: '2024-01-01',
    endDate: '2024-01-02',
    vat: true
);

获取高于阈值的定价

$prices = (new EnergyZero())->getPricesAboveThreshold(
    startDate: '2024-01-01',
    endDate: '2024-01-02',
    threshold: 0.05,
    vat: true
);

获取低于阈值的定价

$prices = (new EnergyZero())->getPricesBelowThreshold(
    startDate: '2024-01-01',
    endDate: '2024-01-02',
    threshold: 0.05,
    vat: true
);

获取高峰时段

获取某一段期间内的前N个高峰时段。

$peakHours = (new EnergyZero())->getPeakHours(
    startDate: '2024-01-01',
    endDate: '2024-01-02',
    topN: 5,
    vat: true
);

获取低谷时段

获取某一段期间内的前N个低谷时段。

$valleyHours = (new EnergyZero())->getValleyHours(
    startDate: '2024-01-01',
    endDate: '2024-01-02',
    topN: 5,
    vat: true
);

测试

composer test

更新日志

请参阅更新日志了解最近的变化。

贡献

请参阅贡献指南获取详细信息。

安全漏洞

请查阅我们的安全策略了解如何报告安全漏洞。

鸣谢

许可协议

MIT许可协议(MIT)。请参阅许可文件获取更多信息。