scheb/yahoo-finance-api

PHP library for accessing Yahoo Finance data

Thursday, April 5, 2018
by Scheb
Repository
25 Watchers
110 Stars
16,311 Installations

PHP
3 Dependents
0 Suggesters
30 Forks
0 Open issues
14 Versions
7 % Grown

The README.md

scheb/yahoo-finance-api

This is a PHP client for Yahoo Finance API., _(*1)

, _(*2)

, _(*3)

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

⚠️ 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., _(*5)

Installation

Download via Composer:, _(*6)

composer require scheb/yahoo-finance-api

Alternatively you can also add the package directly to composer.json:, _(*7)

{
    "require": {
        "scheb/yahoo-finance-api": "^4.0"
    }
}

and then tell Composer to install the package:, _(*8)

composer update scheb/yahoo-finance-api

Usage

use Scheb\YahooFinanceApi\ApiClient;
use Scheb\YahooFinanceApi\ApiClientFactory;
use GuzzleHttp\Client;

// Create a new client from the factory
$client = ApiClientFactory::createApiClient();

// Or use your own Guzzle client and pass it in
$options = [/* ... */];
$guzzleClient = new Client($options);
$client = ApiClientFactory::createApiClient($guzzleClient);

// Returns an array of Scheb\YahooFinanceApi\Results\SearchResult
$searchResult = $client->search("Apple");

// Returns an array of Scheb\YahooFinanceApi\Results\HistoricalData
$historicalData = $client->getHistoricalQuoteData(
    "AAPL",
    ApiClient::INTERVAL_1_DAY,
    new \DateTime("-14 days"),
    new \DateTime("today")
);

// Retrieve dividends history, returns an array of Scheb\YahooFinanceApi\Results\DividendData
$dividendData = $client->getHistoricalDividendData(
    "AAPL",
    new \DateTime("-5 years"),
    new \DateTime("today")
);

// Retrieve stock split history, returns an array of Scheb\YahooFinanceApi\Results\SplitData
$splitData = $client->getHistoricalSplitData(
    "AAPL",
    new \DateTime("-5 years"),
    new \DateTime("today")
);

// Returns Scheb\YahooFinanceApi\Results\Quote
$exchangeRate = $client->getExchangeRate("USD", "EUR");

// Returns an array of Scheb\YahooFinanceApi\Results\Quote
$exchangeRates = $client->getExchangeRates([
    ["USD", "EUR"],
    ["EUR", "USD"],
]);

// Returns Scheb\YahooFinanceApi\Results\Quote
$quote = $client->getQuote("AAPL");

// Returns an array of Scheb\YahooFinanceApi\Results\Quote
$quotes = $client->getQuotes(["AAPL", "GOOG"]);

// Returns an array of Scheb\YahooFinanceApi\Results\OptionChain
$optionChain = $client->getOptionChain("AAPL");
$optionChain = $client->getOptionChain("AAPL", new \DateTime("2021-01-01"));

Version Guidance

Version	Status	PHP Version
1.x	EOL	>= 5.3.0
2.x	EOL	>= 5.6.0
3.x	EOL	>= 5.6.0
4.x	Maintained	>= 7.1.3

License

This library is available under the MIT license., _(*9)

Contributing

Want to contribute to this project? See CONTRIBUTING.md., _(*10)

Support Me

I'm developing this library since 2014. I love to hear from people using it, giving me the motivation to keep working on my open source projects., _(*11)

If you want to let me know you're finding it useful, please consider giving it a star ⭐ on GitHub., _(*12)

If you love my work and want to say thank you, you can help me out for a beer 🍻️ via PayPal., _(*13)

The Versions

05/04 2018

dev-master

9999999-dev https://github.com/scheb/yahoo-finance-api

PHP library for accessing Yahoo Finance data

Sources Download

MIT

The Requires

guzzlehttp/guzzle ^6.0
php >=5.6.0

The Development Requires

by Christian Scheb

api finance yahoo stock

05/04 2018

v3.1.0

3.1.0.0 https://github.com/scheb/yahoo-finance-api

PHP library for accessing Yahoo Finance data

Sources Download

MIT

The Requires

php >=5.6.0
guzzlehttp/guzzle ^6.0

The Development Requires

by Christian Scheb

api finance yahoo stock

15/11 2017

2.x-dev

2.9999999.9999999.9999999-dev https://github.com/scheb/yahoo-finance-api

PHP library for accessing Yahoo Finance data

Sources Download

MIT

The Requires

php >=5.6.0
guzzlehttp/guzzle ^6.0

The Development Requires

by Christian Scheb

api finance yahoo stock

15/11 2017

v3.0.0

3.0.0.0 https://github.com/scheb/yahoo-finance-api

PHP library for accessing Yahoo Finance data

Sources Download

MIT

The Requires

php >=5.6.0
guzzlehttp/guzzle ^6.0

The Development Requires

by Christian Scheb

api finance yahoo stock

31/08 2017

v2.1.0

2.1.0.0 https://github.com/scheb/yahoo-finance-api

PHP library for accessing Yahoo Finance data

Sources Download

MIT

The Requires

php >=5.6.0
guzzlehttp/guzzle ^6.0

The Development Requires

by Christian Scheb

api finance yahoo stock

29/08 2017

dev-serializable

dev-serializable https://github.com/scheb/yahoo-finance-api

PHP library for accessing Yahoo Finance data

Sources Download

MIT

The Requires

php >=5.6.0
guzzlehttp/guzzle ^6.0

The Development Requires

by Christian Scheb

api finance yahoo stock

27/08 2017

v2.0.1

2.0.1.0 https://github.com/scheb/yahoo-finance-api

PHP library for accessing Yahoo Finance data

Sources Download

MIT

The Requires

php >=5.6.0
guzzlehttp/guzzle ^6.0

The Development Requires

by Christian Scheb

api finance yahoo stock

10/08 2017

v2.0.0

2.0.0.0 https://github.com/scheb/yahoo-finance-api

PHP library for accessing Yahoo Finance data

Sources Download

MIT

The Requires

php >=5.6.0
guzzlehttp/guzzle ^6.0

php >=5.3.0

by Christian Scheb

api finance yahoo stock

library yahoo-finance-api

PHP library for accessing Yahoo Finance data