To install this package via the composer require
command:
$ composer require radicalloop/eodhistoricaldata
Or add it to composer.json
manually:
"require": {
"radicalloop/eodhistoricaldata": "~1.0"
}
No configuration required for Laravel >= 5.5+, It will use the auto-discovery function.
In Laravel <= 5.4 (or if you are not using auto-discovery) register the service provider by adding it to the providers
key in config/app.php
. Also register the facade by adding it to the aliases
key in config/app.php
.
'providers' => [
...
RadicalLoop\Eod\EodServiceProvider::class,
],
'aliases' => [
...
'Eod' => RadicalLoop\Eod\Facades\Eod::class,
]
To get started, you'll need to publish all vendor assets:
$ php artisan vendor:publish --provider="RadicalLoop\Eod\EodServiceProvider"
This will create a config/eod.php
file in your app that you can modify to set your configuration.
Set your Eod historical data API token in the file:
return [
'api_token' => 'put your token here'
];
Here you can see an example of just how simple this package is to use.
use Eod;
$stock = Eod::stock();
// JSON
$stock->realTime('AAPL.US')->json();
$stock->eod('AAPL.US')->json();
// Download CSV
$stock->realTime('AAPL.US' ['s' => ['VTI','EUR','FX']])->download();
$stock->eod('AAPL.US')->download();
// Save CSV to specific path
$stock->realTime('AAPL.US')->save('path/to/save/csv/stock.csv');
// For other parameters, for ex. dividend api with other params
$stock->dividend('AAPL.US', ['from' => '2017-01-01'])->json();
To check other Stock API usages, refer Test Cases here.
use Eod;
$exchange = Eod::exchange();
// JSON
$exchange->symbol('US')->json();
$exchange->multipleTicker('US')->json();
// Download CSV
$exchange->symbol('US')->download();
$exchange->multipleTicker('US')->download();
// Save CSV to specific path
$exchange->symbol('US')->save('path/to/save/csv/stock.csv');
To check other Exchanges API usages, refer Test Cases here.
For PHP you can create an object like below.
use RadicalLoop\Eod\Config;
use RadicalLoop\Eod\Eod;
$stock = (new Eod(new Config($apiToken)))->stock();
$exchange = (new Eod(new Config($apiToken)))->exchange();
Contact: www.radicalloop.com — [email protected]