mackensiealvarezz / tdameritrade-laravel
TD Ameritrade API 包用于 Laravel
2.0.1
2020-07-11 19:27 UTC
Requires
- guzzlehttp/guzzle: ^6.5
Requires (Dev)
- orchestra/testbench: ^5.3
- phpunit/phpunit: ^9.2
This package is auto-updated.
Last update: 2024-09-30 01:02:43 UTC
README
TD Ameritrade API for Laravel
此包是 TD Ameritrade API 的封装。您需要开发者账户才能使用此 API。
安装
1. 使用 composer 安装包
composer require mackensiealvarezz/tdameritrade-laravel
2. 发布配置
php artisan vendor:publish
3. 设置环境变量
在 .env 文件中包含这两个变量
// .env
TD_KEY="YOUR_KEY"
TD_CALLBACK="CALLBACK"
4. 包含包
使用包时,不要忘记将其放在文件顶部
use Mackensiealvarezz\Tdameritrade\Tdameritrade;
OAuth
要使用 API,必须有一个 access_token。您可以使用重定向功能轻松创建 access_token。
创建 OAuth URL
要创建 OAuth URL,您需要使用
Tdameritrade::redirectOAuth(); // will return string (url)
重要的是,您需要在 .env 中设置的 URL 内创建一个回调路由
刷新令牌
要刷新令牌并创建另一个 access_token。
//Create client
$client = new Tdameritrade('access_token', 'refresh_token');
//Refresh token
$response = $client->refreshToken();
用法
此包编写为使用 /src/api 目录中的每个类作为函数。
账户
列出账户
这将返回所有账户的列表
//Create client
$client = new Tdameritrade('access_token', 'refresh_token');
$accounts = $client->accounts()->list();
获取账户
这将返回一个账户的所有信息。 需要 account_id
//Create client
$client = new Tdameritrade('access_token', 'refresh_token');
$accounts = $client->accounts()->get('account_id');
工具
搜索
这将返回基于输入符号的股票代码列表
//Create client
$client = new Tdameritrade('access_token', 'refresh_token');
//Response
$response = $client->instruments()->search('TESLA');
获取
这将返回一个股票代码的信息
//Create client
$client = new Tdameritrade('access_token', 'refresh_token');
//Response
$accounts = $client->instruments()->get('TSLA');
交易时段
列出
这将返回所有不同市场交易时段的列表
//Create client
$client = new Tdameritrade('access_token', 'refresh_token');
//Response
$response = $client->market()->list();
获取
这将返回一个市场信息
//Create client
$client = new Tdameritrade('access_token', 'refresh_token');
//Response
$response = $client->market()->get('SPY.X');
变动
获取
这将返回正在变动的符号列表
//Create client
$client = new Tdameritrade('access_token', 'refresh_token');
//Response
$response = $client->movers()->get('SPY.X', 'up', 'percent');
价格
历史
这将返回股票代码的报价列表
//Create client
$client = new Tdameritrade('access_token', 'refresh_token');
//Response
$response = $client->price()->history('TSLA', Carbon::now(), Carbon::now());
获取报价
这将返回一个股票代码的报价
//Create client
$client = new Tdameritrade('access_token', 'refresh_token');
//Response
$response = $client->price()->quote('TSLA');
获取报价
这将返回多个股票代码的报价
//Create client
$client = new Tdameritrade('access_token', 'refresh_token');
//Response
$response = $client->price()->quotes(['AAPL', 'FB']);
许可证
MIT 许可证 (MIT)。有关更多信息,请参阅 MIT 许可证。