hsioe/quant-okx-api

Webman plugin hsioe/quant-okx-api

Maintainers

Details

github.com/dhsioe/hsioe-okx-engine

Source

Issues

Installs: 18

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

1.0.5 2025-03-25 09:01 UTC

Requires

Requires (Dev)

MIT 409fd178aa7bf0ded39c361d90f6227880258017

This package is auto-updated.

Last update: 2025-03-25 09:04:04 UTC

README

概述

基于 Workman 重新把之前量化系统的欧易的API做成SDK方便后续扩展

目前已经完成

  • RestApi V5版本接口
  • Websocket 长链接

安装

  1. 通过 composer安装
composre require hsioe/quant-okx-api

快速开始

  • RestApi
use Hsioe\QuantOkxApi\OkxApi;
use Hsioe\QuantOkxApi\Rest\OkxApiRequest;

//初始化链接

$apiRequest = new OkxApiRequest([
    'apiKey' => 'You Okx ApiKey',
    'apiSecret' => 'You Okx ApiSecret',
    'passphrase' => 'You Okx Passphrase'
]);

$accountApi = OkxApi::account($apiRequest);
// 获取账户余额
$accountApi->getBalance();
// 获取账户配置
$accountApi->getAccountConfig();
...
  • Websocket

主要用到 Hsioe\QuantOkxApi\OkxWebsocket 类代理访问

  • PrivateWebsocket
  • PublicWebsocket

并通过 WebsocketFactory实现socket的链接管理

use Hsioe\QuantOkxApi\OkxWebsocket;
// 公共频道链接
$publicClient = OkxWebsocket::public('test01','public',[
    'wss_url' => 'ws://ws.okx.com/v5/public',
    'ping_interval' => 20
]);
// 启动websocket
$publicClient->start();

// 私有频道
$privateClient = OkxWebsocket::private('test02','private',[
    'wss_url' => 'ws://ws.okx.com/v5/private',
    'ping_interval' => 20
]);
$privateClient->start();

更新日志

  • 08/14 完善API接口和单元测试