Download the PHP package kayrah87/agile-octopus-api without Composer

On this page you can find all versions of the php package kayrah87/agile-octopus-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package agile-octopus-api

AgileOctopusAPI

Welcome to the Agile Octopus API Wrapper.
This may be included in any PHP project and will soon be adapted for Laravel

You may access all of the information you require for this package at Octopus Energy


Basic Usage

installing Agile Octopus API is as simple as requiring it through composer

$ composer require kayrah87/agile-octopus-api

Once it is included in your project you can instantiate the API in your project thusly:

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

$account is your Octopus account number.
$api_key is your Octopus API key.
$tz is your Timezone, most usually 'Europe/London' but Octopus is available in other countries now, so might be worth checking.

Examples

⚡ Current Electricity Price

$api->getElectricityPrice($region)

$region is the DNO code from the region you wish to get the price for. For more information or if you are not sure, see energy-stats.uk

⚡ Half-Hourly Electricity Prices

The half hourly electricity prices can be called using

$api->getHalfHourlyRates($region)

where $region is the DNO for the desired region.

⚡ Electricity Meter Point Details

The meter point details (for electric only) can be called using

$api->getMeterPointDetails($electricity_mpan)

where $electricity_mpan is the mpan from your electricity meter found under your developer dashboard.

This will return an object with the following properties:
GSP
MPAN
Profile Class

⚡ Electricity Meter Point Consumption

The electricity meter point half-hourly consumption can be called using

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

$electricity_mpan is the mpan from your electricity meter found under your developer dashboard.
$electricity_serial is the serial number from your electricity meter found under your developer dashboard.
$date is the date you want to get the consumption for.

🔥 Gas Meter Point Consumption

The gas meter point half-hourly consumption can be called using

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

$gas_mprn is the MPRN from your gas meter found under your developer dashboard.
$electricity_serial is the serial number from your gas meter found under your developer dashboard. $date is the date you want to get the consumption for.


Queries

If you have any queries please raise a github issue. If you like this API then consider telling your friends about it and earn both them and me £50 in the process: Here


All versions of agile-octopus-api with dependencies

PHP Build Version
Package Version
Requires nesbot/carbon Version ^2.48
guzzlehttp/guzzle Version ^7.3
ext-json Version ^7.4
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package kayrah87/agile-octopus-api contains the following files

Loading the files please wait ....