README

http://royopa.github.io/quandl-elephant-api

此项目是从php-quandl派生的，php-quandl是一个伟大的API，可以方便地使用PHP访问Quandl API。

更改此项目的名称是为了响应PHP许可协议。

安装

使用composer安装

composer require royopa/quandl-elephant-api

示例

这是一个基本的调用。它将返回一个包含AAPL价格数据的PHP对象

use Royopa\Quandl;

$api_key = "YOUR_KEY_HERE";
$quandl  = new Quandl($api_key);
$data    = $quandl->getSymbol("GOOG/NASDAQ_AAPL");

您可以通过传递Quandl文档中提到的任何参数

use Royopa\Quandl;

$quandl = new Quandl($api_key);
$data = $quandl->getSymbol($symbol, [
	"sort_order"      => "desc",
	"exclude_headers" => true,
	"rows"            => 10,
	"column"          => 4, 
]);

日期范围选项会受到特殊处理。您可以使用PHP的strtotime()理解的任何日期字符串

use Royopa\Quandl;

$quandl = new Quandl($api_key, "csv");
$data = $quandl->getSymbol($symbol, [
	"trim_start" => "today-30 days",
	"trim_end"   => "today",
]);

您还可以搜索整个Quandl数据库，并获取数据源中支持的符号列表

use Royopa\Quandl;

$quandl = new Quandl($api_key);
$data   = $quandl->getSearch("crude oil");
$data   = $quandl->getList("WIKI", 1, 10);

更多示例可以在examples.php文件中找到

缓存

您可以为quandl对象提供一个缓存处理函数。此函数应负责从您的缓存中读取并存储。

请参阅example_cache.php文件。

参考

构造函数和公共属性

构造函数接受两个可选参数：$api_key和$format

$quandl = new Quandl("YOUR KEY", "csv");

您也可以稍后设置这些属性

$quandl->api_key = "YOUR KEY";
$quandl->format  = "json";

$format可以是csv、xml、json或object（这将返回通过json_decode()获得的PHP对象）。

每次调用Quandl后，属性$last_url将被设置以供调试和其他目的。如果从Quandl获取数据时出现错误，则结果将为false，并且属性$error将包含错误消息。

getSymbol

mixed getSymbol( string $symbol [, array $params ] )

返回一个包含给定符号数据的对象。结果格式取决于$quandl->format的值。

可选参数数组是一个关联的key => value数组，包含Quandl支持的任何参数。

您不需要在数组中传递auth_token，它将自动附加。

getSearch

mixed getSearch( string $query [, int $page, int $per_page] )

返回一个搜索结果对象。每页的结果数量默认限制为300。

注意，目前Quandl不支持此节点的CSV响应，因此如果$quandl->format是"csv"，则此调用将返回一个JSON字符串。

getList

mixed getList( string $source [, int $page, int $per_page] )

返回给定源中的符号列表。每页的结果数量默认限制为300。

测试

从项目目录中，可以使用以下命令运行测试

./vendor/bin/phpunit