codenix-sv / bitfinex-api
Bitfinex API 的 PHP 客户端
Requires
- php: ^7.2
- ext-json: *
- guzzlehttp/guzzle: ~6.0
Requires (Dev)
- phpunit/phpunit: ^8.0
This package is auto-updated.
Last update: 2024-08-29 04:59:26 UTC
README
一个简单的 PHP 包装器,用于 Bitfinex API。 Bitfinex 全球最大、最先进的加密货币交易平台
注意 Bitfinex API 的 PHP WebSocket 客户端
要求
- PHP >= 7.2
- ext-json
- Bitfinex,API 密钥和 API 秘密
安装
安装此扩展的首选方式是通过 composer。
运行以下命令:
$ composer require codenix-sv/bitfinex-api
或添加以下内容到您的应用程序的 composer.json
文件的 require 部分:
"codenix-sv/bitfinex-api" : "^1.0"
基本用法
示例
use Codenixsv\BitfinexApi\BitfinexClient; $client = new BitfinexClient(); $data = $client->public()->getPlatformStatus();
可用方法
公共 API
getPlatformStatus
获取平台当前状态,"Operative" 或 "Maintenance"(1=运行中,0=维护)。维护期通常持续几分钟到几个小时,在基础设施升级时可能需要不时进行。
$data = $client->public()->getPlatformStatus();
getTickers
tickers 端点提供了对市场状态的概述。它显示了当前最佳买入价和卖出价,最后交易价格,以及过去一天的每日交易量和价格变动信息。该端点可以一次性查询多个 tickers。
$data = $client->public()->getTickers('tBTCUSD,tLTCUSD,fUSD');
getTicker
对于指定的对,tickers 端点提供了对市场状态的概述。它显示了当前最佳买入价和卖出价,最后交易价格,以及过去一天的每日交易量和价格变动信息。
$data = $client->public()->getTicker('tBTCUSD');
getTrades
trades 端点允许检索过去的公共交易,包括价格、大小和时间等详细信息。可以使用可选参数限制结果数量;可以指定开始和结束时间戳、限制数量和排序方法。
$data = $client->public()->getTrades('tBTCUSD', ['limit' => 100]);
getBook
公共 Books 端点允许您以价格聚合的方式跟踪 Bitfinex 订单簿的状态,具有可定制的精度。可以通过使用精度 R0
获取原始订单簿。
$data = $client->public()->getBook('tBTCUSD', 'P0');
getStats
Stats 端点提供有关指定交易对或资金货币的各种统计数据。使用可用的键指定要检索的统计信息。
仅对非资金查询使用 side
参数。
$data = $client->public()->getStats('pos.size', '1m', 'tBTCUSD', 'hist', 'long'); $data = $client->public()->getStats('funding.size', '1m', 'fUSD', 'hist');
getCandles
Candles 端点为指定的资金货币或交易对提供 OCHL(开盘价、收盘价、最高价、最低价)和成交量数据。对于资金蜡烛,需要资金周期。
$data = $client->public()->getCandles('1m', 'tBTCUSD', 'hist'); $data = $client->public()->getCandles('1m', 'fUSD', 'hist', 'p30');
getConfigs
获取货币和符号站点配置数据。可以通过构建一个路径来获取各种类型的配置数据,包括操作、对象和可选的详细信息值。
$data = $client->public()->getConfigs('list', 'pair', 'exchange');
getStatus
用于接收不同类型平台信息的端点 - 当前仅支持衍生品对状态。
$data = $client->public()->getStatus('deriv', ['keys' => 'tBTCF0:USTF0']); $data = $client->public()->getStatus('deriv/tBTCF0:USTF0/hist', ['start' => 157057800000, 'end' => 1573566992000]);
getLiquidationFeed
检索清算的端点。默认情况下,将检索最近的清算,但可以使用时间戳检索特定时间的数据。
$data = $client->public()->getLiquidationFeed();
getLeaderboards
Leaderboards 端点允许您检索未实现利润(期间差额)、未实现利润(起始)、交易量以及已实现利润的排行榜。
$data = $client->public()->getLeaderboards('vol', '3h', 'tBTCUSD', 'hist');
更多信息
请查阅Bitfinex网站的文档,获取有关API的更多信息。
许可证
codenix-sv/bitfinex-api
是在MIT许可证下发布的。有关详细信息,请参阅附带LICENSE。