PHP client for Yahoo Finance API
This is a PHP client for Yahoo Finance API. Since YQL 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.
Download via Composer:
composer require scheb/yahoo-finance-apiAlternatively, you can also add the package directly to composer.json:
{
"require": {
"scheb/yahoo-finance-api": "^5"
}
}and then tell Composer to install the package:
composer update scheb/yahoo-finance-api…You can customize the User-Agent header by passing it in the Guzzle client options:
$guzzleClientOptions = ['headers' => ['User-Agent' => 'MyApp/1.0']];
$client = ApiClientFactory::createApiClient($guzzleClientOptions);This library supports curl-impersonate to mimic real browser behavior. When using curl-impersonate, the library automatically removes the default User-Agent header to let curl-impersonate handle it.
To use curl-impersonate:
libcurl-* package for the respective system architecture and extract itexport LD_PRELOAD=/path/to/curl-impersonate/libcurl-impersonate.so
export CURL_IMPERSONATE=chrome136 # or another browser version$client = ApiClientFactory::createApiClient();The library will automatically detect the CURL_IMPERSONATE environment variable and configure the HTTP client
accordingly.
The library includes a built-in retry mechanism that can automatically retry failed requests. Configure it when creating the client:
$client = ApiClientFactory::createApiClient(
retries: 3, // Number of retry attempts (default: 0)
retryDelay: 1000, // Delay between retries in milliseconds (default: 0)
);When a request fails, the library will:
The library supports caching session contexts (cookies and crumb value) to improve performance and reduce HTTP requests. This is especially useful in high-traffic applications or when making multiple requests.
To use caching, you need a PSR-6 cache implementation, e.g. you could use symfony/cache:
composer require symfony/cacheThen configure the cache. In this example, a simple file-based cache is used:
use Scheb\YahooFinanceApi\ApiClientFactory;
use Symfony\Component\Cache\Adapter\FilesystemAdapter;
// File-based cache from symfony/cache
$cache = new FilesystemAdapter();
// Create API client with caching
$client = ApiClientFactory::createApiClient(
cache: $cache, // PSR-6 cache implementation
cacheTtl: 3600, // Cache TTL in seconds (optional, default: 3600)
cacheKey: 'my_cache_key' // Custom cache key (optional)
);| Version | Status | PHP Version |
|---|---|---|
| 1.x | EOL | >= 5.3.0 |
| 2.x | EOL | >= 5.6.0 |
| 3.x | EOL | >= 5.6.0 |
| 4.x | EOL | >= 7.1.3 |
| 5.x | Maintained | >= 8.1.0 |
This library is available under the MIT license.
Want to contribute to this project? See CONTRIBUTING.md.
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.
If you want to let me know you're finding it useful, please consider giving it a star ⭐ on GitHub.
If you love my work and want to say thank you, you can help me out for a beer ️ via PayPal.
No open issues yet, or sync has not completed.