tschucki/alphavantage-laravel

Laravel Wrapper for Alphavantage API

0.0.2 2024-09-01 11:41 UTC

This package is auto-updated.

Last update: 2024-10-31 12:04:03 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

Alpha Vantage Logo

This Laravel package provides an easy way to access the Alphavantage API. With it, you can i.e. fetch historical financial data, including stock prices, forex, and cryptocurrency information. It integrates smoothly with your Laravel application, making it simple to use Alphavantage's services.

I created this package for a project I was working on. So it currently only supports the categories I needed. If you need more categories, feel free to open an issue or a pull request. I'd love to hear your feedback and suggestions.

use Tschucki\Alphavantage\Facades\Alphavantage;

Alphavantage::timeSeries()->daily('IBM');

Installation

You can install the package via composer:

composer require tschucki/alphavantage-laravel

You can publish the config file with:

php artisan vendor:publish --tag="alphavantage-laravel-config"

This is the contents of the published config file:

return [
    'key' => env('ALPHAVANTAGE_API_KEY'),
];

Pay Alphavantage and get your API key here.

Usage

I tried to make the package as easy to use as possible. I tried to follow the Alphavantage API documentation as closely as possible. So if you are familiar with the API, you should feel right at home. You have access to the following categories:

  • Core
  • Fundamentals
  • Indicators
  • Intelligence

You can either use the facade access these categories or use the Alphavantage class directly.

use Tschucki\Alphavantage;

Alphavantage::timeSeries()->daily('IBM');

Documentation

You can find the documentation here.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.