README

Cobinhood 客户端 API

参考 Cobinhood 公共 API https://cobinhood.github.io/api-public

Composer 命令

composer create-project dalvin1991/cobinhood_client_api

初始化

客户端 $client = new CobinhoodClientAPI("API-KEY");

系统部分

获取系统时间

$client->getTime();

获取系统信息

$client->getInfo();

市场部分

获取货币

$client->getCurrencies();

获取交易对

$client->getTradingPairs();

获取订单簿

$client->getOrderBooks($tradingPairID,$limit);
$tradingPairID (string) : 你可以使用 获取交易对 返回的值
$limit (int) : 返回的记录数（可选参数）

获取交易统计数据

$client->getStats();

获取行情

$client->getTickers($tradingPairID);
$tradingPairID (string) : 你可以使用 获取交易对 返回的值

获取最近成交

$client->getRecentTrades($tradingPairID,$limit);
$tradingPairID (string) : 你可以使用 获取交易对 返回的值
$limit (int) : 返回的记录数（可选参数）

图表部分

获取蜡烛图

$client->getCandles($tradingPairID,$timeframe,$startTime,$endTime);
$tradingPairID (string) : 你可以使用 获取交易对 返回的值
$timeframe (string) : 蜡烛图时间框架 ("1m", "5m", "15m", "30m", "1h", "3h", "6h", "12h", "1D", "7D", "14D", "1M")
$startTime (int) : 第一根蜡烛的 Unix 时间戳（可选参数）
$endTime (int) : 最后一根蜡烛的 Unix 时间戳（可选参数）

交易部分

获取订单

$client->getOrder($orderID);
$orderID (string) : 订单 ID

获取订单的交易

$client->getOrderTrades($orderID);
$orderID (string) : 订单 ID

获取所有订单

$client->getOrders($tradingPairID,$limit);
$tradingPairID (string) : 你可以使用 获取交易对 返回的值（可选参数）
$limit (int) : 返回的记录数（可选参数）

放置订单

$client->placeOrder($tradingPairID, $side, $type, $price, $size);
$tradingPairID (string) : 你可以使用 获取交易对 返回的值
$side (string) : 订单方向 ("bid", "ask")
$type (string) : 订单类型 ("market", "limit", "stop", "stop_limit")
$price (string) : 订单价格
$size (string) : 订单大小

修改订单

$client->modifyOrder($orderID,$price,$size);
$orderID (string) : 订单 ID
$price (string) : 订单价格
$size (string) : 订单大小

取消订单

$client->cancelOrder($orderID);
$orderID (string) : 订单 ID

获取订单历史

$client->getOrderHistory($tradingPairID, $limit);
$tradingPairID (string) : 你可以使用 获取交易对 返回的值（可选参数）
$limit (int) : 返回的记录数（可选参数）

获取交易

$client->getTrade($tradeID);
$tradeID (string) : 交易 ID

获取交易历史

$client->getTrades($tradingPairID, $limit);
$tradingPairID (string) : 你可以使用 获取交易对 返回的值（可选参数）
$limit (int) : 返回的记录数（可选参数）

钱包部分

获取账本条目

$client->getLedger($currency,$limit);
$currency (string) : 你可以使用 获取货币 返回的值（可选参数）
$limit (int) : 返回的记录数（可选参数）

获取存款地址

$client->getDepositAddresses($currency);
$currency (string) : 你可以使用 获取货币 返回的值（可选参数）

获取提款地址

$client->getWithdrawalAddresses($currency);
$currency (string) : 你可以使用 获取货币 返回的值（可选参数）

获取提款

$client->getWithdrawal($withdrawalID);
$withdrawalID (string) : 提款 ID

获取所有提款

$client->getWithdrawals();

获取存款

$client->getDeposit($depositID);
$depositID (string) : 存款 ID

获取所有存款

$client->getDeposits();

WebSocket 部分的内容

在 WebSocket 中，我已实现每 5 秒发送一次 ping 消息以保持 socket 在每次调用 socket 函数后保持打开状态。

你可以参考我的 index.php 示例，对于每个 WebSocket 函数，你可以在你的回调函数中放置，当收到任何消息时。$class 将是你的类，然后 $functionName 是要调用的类函数名称。

订单

$client->startOrderWS($keepAlive,$timeout,$class,$functionName);

$keepAlive (bool) : 在超时前保持 socket 保持活跃（可选参数）
$timeout (int) : 秒为单位的时间超时（可选参数）
$class (class) : 回调类（可选参数）
函数名（string）: 回调类函数（可选参数）

交易

$client->startTradesWS($tradingPairID,$keepAlive,$timeout,$class,$functionName);

$tradingPairID（string或array）: 可以是单个交易对的字符串，或多个交易对订阅的数组
$keepAlive (bool) : 在超时前保持 socket 保持活跃（可选参数）
$timeout (int) : 秒为单位的时间超时（可选参数）
$class (class) : 回调类（可选参数）
函数名（string）: 回调类函数（可选参数）

订单簿

$client->startOrderBookWS($tradingPairsForOrderBookWS,$keepAlive,$timeout,$class,$functionName);

$tradingPairsForOrderBookWS（array）: 可以参考以下结构

$tradingPairsForOrderBookWS=[
    ["tradingPairID"=>"BAT-BTC","precision"=>"1E-8"],
    ["tradingPairID"=>"COB-BTC","precision"=>"1E-8"],
    ["tradingPairID"=>"ETH-BTC","precision"=>"1E-8"]
];

微调器

$client->startTinkerWS($tradingPairID,$keepAlive,$timeout,$class,$functionName);

蜡烛图

$client->startCandlesWS($tradingPairsForCandlesWS,$keepAlive,$timeout,$class,$functionName);