dirkolbrich/stockfighter

stockfighter api的包装器

dev-master 2016-01-29 23:16 UTC

This package is not auto-updated.

Last update: 2024-09-14 18:04:24 UTC


README

我对stockfighter.io API包装器的看法

它利用了两个基本类

StockfighterApi.php,这是对stockfighter.io REST API的最小封装。它返回原始json响应。请参阅stockfighter API文档。您可以使用这个基类来实现自己的功能。

Stockfighter.php是实际的API游戏包装器。它依赖于StockfighterApi.php。系统通过交易列表、库存和余额来跟踪您的订单和账户。

安装

通过composer安装

"require": {
        "dirkolbrich/stockfighter": "*"
}

使用方法

API类

仅使用基API类。在实例化时提供您的API密钥

use DirkOlbrich\Stockfighter\StockfighterApi;

$apiKey = "your API key provided by stockfighter.io";
$api = new StockfighterApi($apiKey);

以下函数可用

  • heartbeat() - 检查REST API是否运行
  • venueHeartbeat($venue) - 检查特定场所是否运行
  • venues() - 获取所有可用场所
  • stocks($venue) - 获取特定场所上的所有可用股票
  • orders($account, $venue) - 获取特定场所上的所有订单
  • stockOrders($account, $venue, $stock) - 获取特定场所特定股票的所有订单
  • orderbook($venue, $stock) - 获取特定场所特定股票的订单簿
  • quote($venue, $stock) - 获取特定场所特定股票的最新报价
  • order($venue, $stock, $order) - 下订单,$order参数必须是REST API指定的字符串
  • cancel($venue, $stock, $orderId) - 取消订单
  • orderStatus($venue, $stock, $orderId) - 获取订单状态

游戏大师的请求也是可用的(不言自明)

  • levels() - REST API尚未实现
  • start($level)
  • restart($instanceId)
  • stop($instanceId)
  • resume($instanceId)
  • levelStatus($instanceId) - 获取等级状态

Stockfighter系统

或者使用Stockfighter系统

use DirkOlbrich\Stockfighter\Stockfighter;

$apiKey = "your API key provided by stockfighter.io";
$sf = new Stockfighter($apiKey);

依赖项

到目前为止,它使用以下依赖项。

"require": {
        "guzzlehttp/guzzle": "~6.0",
}

待办事项

  • 集成WebSocket客户端
  • 测试,测试,测试