swar8080/fast-stock-quotes

Fast, free, global stock quote API wrapper and caching solution for Alpha Vantage and IEX Trading.

FastStockQuotes Overview

This library provides efficient access to two free stock quote APIs: Alpha Vantage and IEX. IEX is fast but limited to US stocks only. Alpha Vantage supports most stocks in the world but requires a separate request for each quote and is limited to ~1 request per second. To make Alpha Vantage usable for a moderate number of stocks, caching using redis can optionally be enabled to limit API requests., _(*1)

Installation

Install with the composer command: composer require swar8080/fast-stock-quotes, _(*2)

Prerequisites

• PHP Version 5.6+
• Claim your free Alpha Vantage API key for access to non-US quotes
• Optionally download and run a redis server to enable caching of stock quotes. Review the Predis library for options when connecting to your redis server from PHP.

Stock Exchange Support

The APIs used by this library support most stock exchanges in this world, however, stock exchanges must be configured before use., _(*3)

Currently Configured Stock Exchanges: * Australia * Amsterdam * Canada * Germany * Hong Kong * Tokyo * London * New Zealand * Norway * France * Shanghai (China) * Shenzhen (China) * Stockholm * United States, _(*4)

Configuring support for a stock exchange is easy: add its exchange code to ExchangeCodes.php and an entry to the Exchanges array in StockExchange.php. If you run into problems, feel free to open an issue on github., _(*5)

Benefits of Using Caching

• If the quote is cached, a network call to the API can be avoided
• You can configure the number of seconds before the cached quote expires and is removed
• If the stock exchange is closed, the quote will be cached until it re-opens

The following table shows time spent making requests (in seconds) from different sources. The biggest time savings can come from caching non-US Alpha Vantage quotes., _(*6)

Demo

require "vendor/autoload.php";

use FastStockQuotes\FastQuoteServiceBuilder;
use FastStockQuotes\StockSymbol;
use FastStockQuotes\markets\ExchangeCodes;
use FastStockQuotes\quoteAPIs\USQuote;

$quoteService = FastQuoteServiceBuilder::builder()
    ->withAlphaVantageGlobalQuoteAPI("your API key")
    ->withRedisCaching(new \Predis\Client(), $minCachingLengthSeconds=300)
    ->build();

//For US stocks, just pass the symbol
$usSymbol = new StockSymbol("MSFT");

//For non-us stocks, an exchange code must be added to the stock symbol to identify the stock exchange it belongs to.
//If you're unsure of the exchange code, use the built-in ExchangeCodes constant or check Yahoo Finance
$canadianSymbol = new StockSymbol("SHOP", $exchangeCode=ExchangeCodes::CANADA); 
$australianSymbol = new StockSymbol("WBC.AX"); //equivalent to: new StockSymbol("WBC", ExchangeCodes::AUSTRALIA)

//request the quotes from the appropriate APIs
$quotes = $quoteService->quotes(array($usSymbol, $canadianSymbol, $australianSymbol));

//this is equivalent
$quotes = $quoteService->quotes(StockSymbol::Symbols("MSFT", "SHOP.TO", "WBC.AX"));

foreach ($quotes as $symbol => $quote){
    echo "--" . $quote->symbol() . "--" . PHP_EOL;
    echo $quote->price() . PHP_EOL;
    echo $quote->open() . PHP_EOL;
    echo $quote->previousDayClose() . PHP_EOL;
    echo $quote->high() . PHP_EOL;
    echo $quote->low() . PHP_EOL;
    echo $quote->volume() . PHP_EOL;
    echo $quote->lastUpdated() . PHP_EOL;

    if ($quote instanceof USQuote){
        echo $quote->marketCap . PHP_EOL;
        echo $quote->week52High . PHP_EOL;
        echo $quote->peRatio . PHP_EOL;
        //full list of fields available for US quotes: https://iextrading.com/developer/docs/#quote
    }
    echo PHP_EOL;
}