OKX API SDK for Rust

这是一个用于与OKX交易所API进行交互的Rust SDK，提供了对OKX V5 API的全面支持。

特性

• 支持 REST API 和 WebSocket API
• 完整的类型定义和错误处理
• 模块化和结构化的代码设计
• 提供公共和私有API的访问
• 支持所有主要的API端点：账户、交易、行情数据、资产等
• 自动处理认证和签名
• 内置的重连和心跳机制（WebSocket）
• 支持同步和异步调用

安装

在你的Cargo.toml文件中添加:

[dependencies]
okx = "0.1.3"

或者直接从GitHub克隆:

cargo add --git https://github.com/fairwic/okx_rs

快速开始

设置API密钥

设置环境变量或创建.env文件：

OKX_API_KEY=your_api_key
OKX_API_SECRET=your_api_secret
OKX_PASSPHRASE=your_passphrase
OKX_SIMULATED_TRADING=0  # 设置为1使用模拟交易

REST API 示例

use okx::{create_client, Error};
use okx::api::market::MarketApi;

#[tokio::main]
async fn main() -> Result<(), Error> {
    env_logger::init();
    let credentials = Credentials::from_env().unwrap();

    let client: OkxClient = OkxClient::new(credentials).unwrap();

    let market = OkxMarket::new(client.clone());
    // 获取BTC-USDT的产品行情
    let ticker = market.get_ticker("BTC-USDT-SWAP").await?;
    println!("BTC-USDT 行情: {:?}", ticker);
    Ok(())
}


#[tokio::main]
async fn main() -> Result<(), Error> {
    env_logger::init();
    let credentials = Credentials::new(
    "your_api_key",
    "your_api_secret",
    "your_passphrase"
    "is_simulated_trading",//是否模拟交易
    ); // 初始化客户端
    let client: OkxClient = OkxClient::new(credentials).unwrap();
    //获取asset账户余额
    let balances = OkxAsset::new(client).get_balances(None).await?;
    println!("账户余额: {:?}", balances);

    Ok(())
}

WebSocket API 示例

#[tokio::main]
async fn main() -> Result<(), Error> {
    env_logger::init();
    let args = Args::new().with_inst_id("BTC-USDT".to_string());
    let mut client = OkxWebsocketClient::new_public();
    let mut rx = client.connect().await.unwrap();
    client.subscribe(ChannelType::Tickers, args).await.unwrap();
    tokio::spawn(async move {
        while let Some(msg) = rx.recv().await {
            println!("收到公共频道消息: {:?}", msg);
        }
    });
    sleep(Duration::from_secs(100)).await;
    Ok(())
}

项目结构

src/
├── api/                    # API 实现
│   ├── account/           # 账户相关 API
│   ├── asset/             # 资产相关 API
│   ├── big_data/          # 大数据相关 API
│   ├── market/            # 市场数据 API
│   ├── public_data/       # 公共数据 API
│   ├── trade/             # 交易相关 API
│   └── websocket/         # WebSocket API
├── models/                # 数据模型
│   ├── account/          # 账户相关模型
│   ├── asset/            # 资产相关模型
│   ├── market/           # 市场数据模型
│   └── trade/           # 交易相关模型
├── client.rs             # HTTP 客户端实现
├── config.rs             # 配置管理
├── error.rs              # 错误处理
├── lib.rs               # 库入口
└── utils.rs             # 工具函数

配置

SDK支持通过环境变量或代码配置：

use okx::config::{Config, Credentials};

// 通过环境变量配置
let config = Config::default();

// 或者手动配置
let config = Config::default()
    .with_api_url("https://www.okx.com")
    .with_simulated_trading(true);

// 手动设置凭证
let credentials = Credentials::new(
    "your_api_key",
    "your_api_secret",
    "your_passphrase",
    "0"//is_simulated_trading 0 || 1
);

开发

# 克隆仓库
git clone https://github.com/fairwic/okx_rs.git
cd okx_rs

# 运行测试
cargo test

# 运行示例
cargo run --example market
cargo run --example websocket

许可证

MIT