leijman/fmp-api-sdk

财务建模准备API SDK。

v0.2 2021-03-05 15:31 UTC

This package is auto-updated.

Last update: 2024-09-05 23:07:46 UTC


README

Version CI Total Downloads License

(非官方) 支持Laravel 8的PHP财务建模准备API SDK。
本项目处于开发中状态,可能不稳定。未来将添加各种端点,欢迎对此包做出贡献。不幸的是,我无法对此SDK提供任何保修或责任。如有任何疑问,请随时联系我!

要求

  • PHP ^7.3 或 ^8.0
  • FMP获取的有效(免费)API密钥

安装

此SDK已在Packagist上发布,可以通过composer获取。

composer require leijman/fmp-api-sdk

使用方法

此SDK使用Guzzle作为与HTTP层交互的依赖项。

$guzzle = new Client([
    'base_uri' => $baseUrl,
    'headers' => [
        'Accept' => 'application/json',
        'Content-Type' => 'application/json'
    ],
    'query' => ['apikey' => $apiKey]
]);

您现在可以使用Guzzle客户端作为依赖项。

$client = new \Leijman\FmpApiSdk\Client($guzzle);

要通信到各种端点,您可以使用客户端如下

use \Leijman\FmpApiSdk\CompanyValuation\Quote;

$endpoint = new Quote($client);
$response = $endpoint->setSymbol('AAPL')->get();

print_r($response);

Laravel使用

目前我们仅支持Laravel 8。如果有对先前版本的需求,我们可能会考虑添加这些。
可以使用以下命令将包发布到您的Laravel项目中

php artisan vendor:publish --provider="Leijman\FmpApiSdk\FmpServiceProvider"

配置文件可在 config/fmp.php 中访问。
最后,更新您的 .env 文件,使用给定的API密钥。


一切设置妥当后,您可以通过以下结构访问FMP API

use Leijman\FmpApiSdk\Facades\CompanyValuation\StockScreener;

StockScreener::setIsActivelyTrading(true)
    ->setExchange('NYSE,NASDAQ,EURONEXT')
    ->get();