goapi-io/php-sdk

GOAPI.IO PHP SDK

1.0.2 2023-11-01 03:05 UTC

This package is auto-updated.

Last update: 2024-09-22 14:45:46 UTC


README

Test

这是GOAPI.IO官方为PHP提供的SDK。它提供了一组函数和类,用于与Goapi API交互。

要求

  • PHP 8.1或更高版本
  • GuzzleHttp库

安装

您可以使用Composer安装SDK。在您的项目目录中运行以下命令

composer require goapi-io/php-sdk

股票市场数据(IDX)

创建实例

要使用SDK,您需要包含自动加载器并创建主类的实例。以下是一个示例

require 'vendor/autoload.php';

$client = new GOAPI\IO\Client(['api_key' => 'your_api_key']);

$marketDataIDX = $client->createStockIDX();

获取所有上市公司的信息

$companies = $marketDataIDX->getCompanies();

$companies响应是一个包含Collection的响应,其中包含GOAPI\IO\Resources\Stock\Company项数据。

获取公司详细信息

$profile = $marketDataIDX->getProfile('BBCA');

通过符号获取价格

$prices = $marketDataIDX->getStockPrices(['AALI','BBCA']);

$prices是一个包含Collection的响应,其中包含StockPrice项数据。

通过符号获取历史价格

// maximum date range (from-to) is 1 year.
$historicalPrice = $marketDataIDX->getHistoricalData('BBCA', '2023-10-01', '2023-10-20');

$historicalPrice是一个包含Collection的响应,其中包含StockPrice项数据。

获取热门、跌幅最大、涨幅最大的股票

$trending = $marketDataIDX->getTrendingStocks();
$gainer = $marketDataIDX->getTopGainerStocks();
$loser = $marketDataIDX->getTopLoserStocks();

$trending$gainer$loser是一个包含Collection的响应,其中包含StockPriceChange项数据。

获取经纪商摘要

$brokerSum = $marketDataIDX->getBrokerSummary('BBCA', '2023-10-30');

$brokerSum是一个包含Collection的响应,其中包含BrokerSummary项数据。

获取股票指标

$indicators = $marketDataIDX->getStockIndicators(page: 1, date: '2023-10-30');

$indicators是一个包含Collection的响应,其中包含StockIndicator项数据。

贡献

如果您发现任何问题或对改进有建议,请打开GitHub上的一个问题或提交一个拉取请求。