README

Since APIs have been discontinued in November 2017, this client is using non-official API endpoints for quotes, search and historical data.

WARNING: These non-official APIs cannot be assumed stable and might break any time. Also, you might violate Yahoo's terms of service. So use them at your own risk.

Installation

$ composer require "floda/yahoo_finance"

Usage

If your project has not an autoloder, just include once this line:

require_once __DIR__ . "/../vendor/autoload.php";

For Laravel 5, Symfony, just instance object and use functions

Historical Data

<?php

// Instance Object
$yf = new \floda\yahoo_finance\YF();

//Params
$symbol ="TRAN.BA";       //tickers with no .XX, API will return US stock market ticker  
                          //for example: $symbol="AAPL";
                          // For another countries, you can use for example:
                          // .BA -> Argentina -> Buenos Aires Stock Exchange (BYMA)

$time_ago = "3 months";   //you can use xx days, xx weeks, xx months, xx years, etc

$historical = $yf->getHistorical($symbol, $time_ago);
/*
Array
(
  [0] => Array
      (
          [date] => 2019-10-04
          [open] => 21.950001
          [high] => 22.9
          [low] => 21.950001
          [close] => 22.9
          [adjClose] => 22.9
          [volume] => 277948
      )

  ....
  ....

  [59] => Array
      (
          [date] => 2020-01-03
          [open] => 25.5
          [high] => 25.549999
          [low] => 24.5
          [close] => 24.950001
          [adjClose] => 24.950001
          [volume] => 229283
      )
)
*/

All Exchanges

_Sufix	_Country	_City	_Sufix	_Country	_City
_.BA	_Argentina	_{Buenos Aires (BYMA)}	_.NS	_India	_{National of India}
_.VI	_Austria	_Vienna	_.JK	_Indonesia	_{Indonesia (IDX)}
_.AX	_Australia	_{Australian (ASX)}	_.IR	_Ireland	_{Euronext Dublin}
_.BR	_Belgium	_{Euronext Brussels}	_.TA	_Israel	_{Tel Aviv}
_.SA	_Brazil	_{Sao Paolo (BOVESPA)}	_.TI	_Italy	_EuroTLX
_.CN	_Canada	_{Canadian Securities}	_.MI	_Italy	_Italian
_.NE	_Canada	_{NEO Exchange}	_.T	_Japan	_Tokyo
_.TO	_Canada	_{Toronto (TSX)}	_.RG	_Latvia	_{Nasdaq OMX Riga}
_.V	_Canada	_{TSX Venture Exchange (TSXV)}	_.VS	_Lithuania	_{Nasdaq OMX Vilnius}
_.SN	_Chile	_Santiago	_.KL	_Malaysia	_Malaysian
_.SS	_China	_Shanghai	_.MX	_Mexico	_{Mexico (BMV)}
_.SZ	_China	_Shenzhen	_.AS	_Netherlands	_{Euronext Amsterdam}
_.PR	_{Czech Republic}	_{Prague Index}	_.NZ	_{New Zealand}	_{New Zealand (NZX)}
_.CO	_Denmark	_{Nasdaq OMX Copenhagen}	_.OL	_Norway	_Oslo
_.CA	_Egypt	_{Egyptian Index (EGID)}	_.LS	_Portugal	_{Euronext Lisbon}
_.TL	_Estonia	_{Nasdaq OMX Tallinn}	_.QA	_Qatar	_Qatar
_.HE	_Finland	_{Nasdaq OMX Helsinki}	_.ME	_Russia	_{Moscow Exchange (MOEX)}
_.NX	_France	_Euronext	_.SI	_Singapore	_{Singapore (SGX)}
_.PA	_France	_{Euronext Paris}	_.JO	_{South Africa}	_Johannesburg
_.BE	_Germany	_Berlin	_.KS	_{South Korea}	_Korea
_.BM	_Germany	_Bremen	_.KQ	_{South Korea}	_KOSDAQ
_.DU	_Germany	_Dusseldorf	_.MC	_Spain	_{Madrid SE C.A.T.S.}
_.F	_Germany	_Frankfurt	_.SAU	_{Saudi Arabia}	_{Saudi (Tadawul)}
_.HM	_Germany	_Hamburg	_.ST	_Sweden	_{Nasdaq OMX Stockholm}
_.HA	_Germany	_Hanover	_.SW	_Switzerland	_{Swiss Exchange (SIX)}
_.MU	_Germany	_Munich	_.TWO	_Taiwan	_{Taiwan OTC Exchange}
_.SG	_Germany	_Stuttgart	_.TW	_Taiwan	_{Taiwan (TWSE)}
_.DE	_Germany	_{Deutsche Boerse XETRA}	_.BK	_{Thailand (SET)}
_.AT	_Greece	_{Athens (ATHEX)}	_.IS	_Turkey	_{Borsa İstanbul}
_.HK	_{Hong Kong}	_{Hong Kong (HKEX)}	_.L	_{United Kingdom}	_London
_.BD	_Hungary	_Budapest	_.IL	_{United Kingdom}	_London
_.IC	_Iceland	_{Nasdaq OMX Iceland}	_.CR	_Venezuela	_Caracas
_.BO	_India	_Bombay

FOREX PAIRS

<?php

// Instance Object
$yf = new \floda\yahoo_finance\YF();

//Params
$currency_1="USD";
$currency_2="ARS";

$fx = $yf->getFX($currency_1,$currency_2);

/*
Array
(
    [symbol] => USDARS=X
    [date] => 2020-01-04 5:55:51
    [bid] => 59.729
    [ask] => 59.734
    [high] => 59.73
    [low] => 59.729
    [open] => 59.73
    [previous] => 59.729
    [price] => 59.729
)
*/

Quote, Order Book, AfterMarket Prices, Financial & Stats

<?php

// Instance Object
$yf = new \floda\yahoo_finance\YF();

//Params
$symbol = "YPF";

$quote = $yf->getQuote($symbol);

/*
Array
(
    [symbol] => YPF
    [price] => 11.16
    [date] => 2020-01-03 21:02:00
    [book] => Array
        (
            [bidSize] => 31
            [bid] => 11.14
            [ask] => 11.57
            [askSize] => 9
        )

    [today] => Array
        (
            [high] => 11.49
            [low] => 10.86
            [open] => 11.24
            [previousDay] => 11.26
            [volume] => 2732642
            [change] => -0.10000038
            [changePercent] => -0.8881029
        )

    [AfterMarket] => Array
        (
            [price] => 11.0746
            [change] => -0.08539963
            [changePercent] => -0.76522964
            [lastTrade] => 2020-01-03 21:26:02
        )

    [financials] => Array
        (
            [name] => YPF Sociedad Anonima
            [mktCap] => 4389372928
            [sharesOutstanding] => 393312992
            [volumeAvg3Month] => 2095557
            [bookValue] => 33.975
            [eps12Month] => 3.125
            [dividendRate] => 0.089
            [dividendYield] => 0.007904085
        )

    [stats] => Array
        (
            [SMA50] => 10.16606
            [SMA200] => 11.737482
            [1yrHigh] => 18.73
            [1yrHighChangePercent] => -0.40416443
            [1yrLow] => 8.04
            [1yrLowChangePercent] => 0.38805968
        )

)
*/

Symbol - Expiration Dates

<?php

// Instance Object
$yf = new \floda\yahoo_finance\YF();

//Params
$symbol="YPF";

$expirations = $yf->getExpirations($symbol);
/*
Array
(
  [0] => Array
      (
          [unix] => 1578614400
          [days] => 6
          [expiration] => 2020-01-10
      )

  ...
  ...

  [9] => Array
      (
          [unix] => 1642723200
          [days] => 748
          [expiration] => 2022-01-21
      )
)
*/

Symbol - Expiration - Option Chain

<?php

// Instance Object
$yf = new \floda\yahoo_finance\YF();

//Params
$symbol="AAPL";

$expirations = $yf->getExpirations($symbol);
$contracts = $yf->getContracts($symbol,$expirations[0]['unix']);

/*
Array
(
    [0] => Array
        (
            [symbol] => AAPL
            [spot] => 297.43
            [expiration] => 2020-01-10
            [strike] => 230
            [otm_abs] => 22.67
            [call_contract] => AAPL200110C00230000
            [call_bid] => 67.85
            [call_ask] => 69.6
            [call_lastPrice] => 68.99
            [call_volume] => 18
            [call_openInterest] => 0
            [call_lastTradeDateUNIX] => 1578069878
            [call_lastTradeDate] => 2020-01-03
            [put_contract] => AAPL200110P00230000
            [put_bid] => 0.02
            [put_ask] => 0.03
            [put_lastPrice] => 0.03
            [put_volume] => 6
            [put_openInterest] => 0
            [put_lastTradeDateUNIX] => 1578061990
            [put_lastTradeDate] => 2020-01-03
            [IV] => 95.9
        )

    ...
    ...

    [37] => Array
        (
           [symbol] => AAPL
           [spot] => 297.43
           [expiration] => 2020-01-10
           [strike] => 350
           [otm_abs] => 17.67
           [call_contract] => AAPL200110C00350000
           [call_bid] => 0.02
           [call_ask] => 0.03
           [call_lastPrice] => 0.05
           [call_volume] => 405
           [call_openInterest] => 0
           [call_lastTradeDateUNIX] => 1578084931
           [call_lastTradeDate] => 2020-01-03
           [put_contract] => AAPL200110P00350000
           [put_bid] => 51
           [put_ask] => 51.85
           [put_lastPrice] => 51.7
           [put_volume] => 2
           [put_openInterest] => 0
           [put_lastTradeDateUNIX] => 1577983464
           [put_lastTradeDate] => 2020-01-02
           [IV] => 45.31
        )
)
*/

Configuration

It doesnt need any configuration line

Enjoy it! ❤️

Credits

scheb/yahoo-finance-api

License

MIT

floda / yahoo_finance

Maintainers

Details