README

此包提供了对 WazirX API 的 Laravel 包装器，并允许您轻松与其通信。

重要说明

此包处于早期开发阶段。建议在 v1.0 发布之前不要在生产应用程序中使用。请随时通过 PR 贡献于此项目，并帮助我实现一个生产就绪的构建。

安装

您可以通过 composer 安装此包

composer require techtailor/laravel-wazirx-api

您可以使用以下命令发布配置文件

php artisan vendor:publish --tag="wazirx-api-config"

打开您的 .env 文件，并添加以下内容（将 YOUR_API_KEY 和 YOUR_SECRET 替换为您从 Wazirx 收到的 API 密钥和密钥） -

WAZIRX_KEY=YOUR_API_KEY
WAZIRX_SECRET=YOUR_SECRET

或者

打开位于 config/wazirx-api.php 的已发布配置文件，并添加您的 API 和密钥密钥

return [
    'auth' => [
        'key'        => env('WAZIRX_KEY', 'YOUR_API_KEY'),
        'secret'     => env('WAZIRX_SECRET', 'YOUR_SECRET')
    ],
];

用法

使用此包非常简单。只需初始化 Api 并调用其中一种可用方法

use TechTailor\Wazirx\WazirxAPI;

$wazirx = new WazirxApi();

$time = $wazirx->getTime();

您还可以在初始化后设置用户的 API 和密钥（当您需要为单个用户隔离 API 密钥时很有用）

$wazirx = new WazirxApi();

$wazirx->setApi($apiKey, $secretKey);

$accountInfo = $wazirx->getAccountInfo();

可用方法

可用公共方法（安全类型：NONE） [无需 API 密钥]

- getTime()
- getServerStatus()
- getExchangeInfo()
- getTickers()
- getTicker($symbol)

可用私有方法（安全类型：USER_DATA） [需要 API 密钥]

- getAccountInfo()
- getFunds()
- getAllOrders($symbol)
- getOpenOrders()
- getOrderStatus($orderId)

待办事项

我们正在努力实现的功能或附加功能列表（不分先后） -

- Improve exception handling.
- Add rate limiting to API Calls.
- Add response for API ban/blacklisting response.
- Improve ReadMe.

变更日志

请参阅 CHANGELOG 了解最近更改的更多信息。

贡献

请参阅 CONTRIBUTING 了解详细信息。

安全漏洞

请查看我们的安全策略了解如何报告安全漏洞。

鸣谢

许可证

MIT 许可证 (MIT)。请参阅许可证文件了解更多信息。

techtailor / laravel-wazirx-api

维护者

详细信息