elminson/yahoo-finance-api

用于访问雅虎财经数据的PHP库

v4.8.3 2024-02-24 21:57 UTC

README

这是一个雅虎财经API的PHP客户端。

Build Status Scrutinizer Code Quality Code Coverage Latest Stable Version Total Downloads License

Logo

由于YQL API已于2017年11月停止使用,此客户端使用非官方API端点进行报价、搜索和历史数据。

⚠️ 警告: 这些非官方API可能不稳定,随时可能中断。此外,您可能会违反雅虎的服务条款。因此,请自行承担风险。

安装

通过Composer下载

composer require elminson/yahoo-finance-api

或者您也可以直接在composer.json中添加此包

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

然后告诉Composer安装该包

composer update elminson/yahoo-finance-api

使用

use Elminson\YahooFinanceApi\ApiClient;
use Elminson\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 Elminson\YahooFinanceApi\Results\SearchResult
$searchResult = $client->search("Apple");

// Returns an array of Elminson\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 Elminson\YahooFinanceApi\Results\DividendData
$dividendData = $client->getHistoricalDividendData(
    "AAPL",
    new \DateTime("-5 years"),
    new \DateTime("today")
);

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

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

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

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

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

版本指南

许可证

此库可在MIT许可证下获得。

贡献

想要为此项目贡献力量?请参阅CONTRIBUTING.md

支持我

我从2014年开始开发这个库。我喜欢听到人们使用它,这给了我继续在开源项目上工作的动力。

如果您想让我知道您觉得它很有用,请在GitHub上给它一个星标 ⭐。

如果您喜欢我的工作并想表示感谢,您可以帮我买一杯啤酒 🍻️ 通过PayPal