2个版本

0.1.1 2024年5月3日
0.1.0 2023年1月4日

#305 in 值格式化

MIT/Apache

220KB
4.5K SLoC

okx-rs

OKX V5 API的非官方Rust库。

使用方法

[dependencies]
okx-rs = { git = "https://github.com/roytang121/okx-rs" }

示例

获取融资余额

获取融资账户的余额。

use okx_rs::api::v5::funding_account::GetFundingBalances;
use okx_rs::api::v5::testkit::with_env_private_client;

/// Rest API - get funding balances
#[tokio::main]
async fn main() {
    with_env_private_client(|client| async move {
        let response = client
            .request(GetFundingBalances {
                ..Default::default()
            })
            .await
            .unwrap();
        println!("{}", serde_json::to_string_pretty(&response).unwrap());
    })
    .await;
}

V5 API特性

以下是目前库支持的特性的列表。该列表将随着库的更新而更新。如果您发现任何问题,请提交问题或拉取请求。

交易账户

REST
  • REST / 获取余额
  • REST / 获取仓位
  • REST / 获取仓位历史
  • REST / 获取账户和仓位风险
  • REST / 获取账单详情(最近7天)
  • REST / 获取账单详情(最近3个月)
  • REST / 获取账户配置
  • REST / 设置仓位模式
  • REST / 设置杠杆
  • REST / 获取最大买入/卖出金额或开仓金额
  • REST / 获取最大可交易金额
  • REST / 增加或减少保证金
  • REST / 获取杠杆
  • REST / 获取杠杆估算信息
  • REST / 获取工具的最大贷款
  • REST / 获取费率
  • REST / 获取利息累计数据
  • REST / 获取利率
  • REST / 设置希腊字母(PA/BS)
  • REST / 隔离保证金交易设置
  • REST / 获取最大提取金额
  • REST / 获取账户风险状态
  • REST / 在快速保证金模式下手动借入和偿还
  • REST / 在快速保证金模式下获取借入和偿还历史
  • REST / VIP贷款借入和偿还
  • REST / 获取VIP贷款借入和偿还历史
  • REST / 获取VIP利息累计数据
  • REST / 获取VIP利息扣除数据
  • REST / 获取VIP贷款订单列表
  • REST / 获取VIP贷款订单详情
  • REST / 获取借入利息和限制
  • REST / 仓位构建器
  • REST / 获取希腊字母
  • REST / 获取PM仓位限制
  • REST / 设置风险对冲类型
  • REST / 激活期权
  • REST / 设置自动贷款
  • REST / 设置账户模式
  • REST / 重置MMP状态
  • REST / 设置MMP
  • REST / 获取MMP配置
WebSocket
  • WS / 账户通道
  • WS / 仓位通道
  • WS / 资金余额和仓位通道
  • WS / 仓位风险警告
  • WS / 账户希腊字母通道

订单簿交易

端点
  • POST / 下单
  • POST / 下多单
  • POST / 取消订单
  • POST / 取消多单
  • POST / 修改订单
  • POST / 修改多单
  • POST / 平仓
  • GET / 订单详情
  • GET / 订单列表
  • GET / 订单历史(最近7天)
  • GET / 订单历史(最近3个月)
  • GET / 交易详情(最近3天)
  • GET / 交易详情(最近3个月)
  • GET / 简易转换货币列表
  • POST / 下简易转换
  • GET / 简易转换历史
  • GET / 一键还款货币列表
  • POST / 交易一键还款
  • GET / 一键还款历史
  • POST / 批量取消订单
  • POST / 取消所有后续订单
  • WS / 订单通道
  • WS / 下单
  • WS / 下多单
  • WS / 取消订单
  • WS / 取消多单
  • WS / 修改订单
  • WS / 修改多单
  • WS / 批量取消订单
  • POST / 下算法订单
  • POST / 取消算法订单
  • POST / 修改算法订单
  • POST / 取消高级算法订单
  • GET / 算法订单详情
  • GET / 算法订单列表
  • GET / 算法订单历史
  • WS / 算法订单通道
  • WS / 高级算法订单通道
  • POST / 下网格算法订单
  • POST / 修改网格算法订单
  • POST / 停止网格算法订单
  • POST / 合约网格平仓
  • POST / 取消合约网格平仓订单
  • POST / 立即触发网格算法订单
  • GET / 网格算法订单列表
  • GET / 网格算法订单历史
  • GET / 网格算法订单详情
  • GET / 网格算法子订单
  • GET / 网格算法订单仓位
  • POST / 现货/月亮网格提现收入
  • POST / 计算保证金余额
  • POST / 调整保证金余额
  • GET / 网格AI参数(公开)
  • POST / 计算最小投资(公开)
  • GET / RSI回测(公开)
  • WS / 现货网格算法订单通道
  • WS / 合约网格算法订单通道
  • WS / 月亮网格算法订单通道
  • WS / 网格仓位通道
  • WS / 网格子订单通道
  • POST / 下重复购买订单
  • POST / 修改重复购买订单
  • POST / 停止重复购买订单
  • GET / 重复购买订单列表
  • GET / 重复购买订单历史
  • GET / 重复购买订单详情
  • GET / 重复购买子订单
  • WS / 重复购买订单通道
  • GET / 现有领先仓位
  • GET / 领先仓位历史
  • POST / 下领先止损订单
  • POST / 关闭领先仓位
  • GET / 领先工具
  • POST / 修改领先工具
  • GET / 利润分成详情
  • GET / 总利润分成
  • GET / 未实现利润分成详情
  • GET / 指数
  • GET / 指数详情
  • GET / 订单簿
  • GET / 订单轻簿
  • GET / K线图
  • GET / K线图历史
  • GET / 成交
  • GET / 成交历史
  • GET / 工具家族期权交易
  • GET / 期权交易
  • GET / 24小时总成交量
  • WS / 指数通道
  • WS / K线图通道
  • WS / 成交通道
  • WS / 所有成交通道
  • WS / 订单簿通道
  • WS / 期权交易通道

资金账户

REST
  • REST / 获取货币
  • REST / 获取余额
  • REST / 获取不可交易资产
  • REST / 获取账户资产估值
  • REST / 资金转账
  • REST / 获取资金转账状态
  • REST / 资产账单详情
  • REST / Lightning存款
  • REST / 获取存款地址
  • REST / 获取存款历史
  • REST / 提款
  • REST / Lightning提款
  • REST / 取消提款
  • REST / 获取提款历史
  • REST / 获取存款提款状态
  • REST / 小额资产转换
  • REST / 获取交易所列表(公开)
  • REST / 获取转换货币
  • REST / 获取转换货币对
  • REST / 估算报价
  • REST / 转换交易
  • REST / 获取转换历史
WebSocket
  • WS / 存款信息频道
  • WS / 提款信息频道

公开数据

REST
  • REST / 获取工具
  • REST / 获取履约/行权历史
  • REST / 获取持仓量
  • REST / 获取资金利率
  • REST / 获取资金利率历史
  • REST / 获取限价
  • REST / 获取期权市场数据
  • REST / 获取预计履约/行权价格
  • REST / 获取贴现率和免息额度
  • REST / 获取系统时间
  • REST / 获取标记价格
  • REST / 获取持仓层级
  • REST / 获取利率和贷款额度
  • REST / 获取VIP贷款的利率和贷款额度
  • REST / 获取标的资产
  • REST / 获取保险基金
  • REST / 单位转换
  • REST / 获取期权跳动区间
  • REST / 获取指数交易代码
  • REST / 获取指数K线图
  • REST / 获取指数K线图历史
  • REST / 获取标记价格K线图
  • REST / 获取标记价格K线图历史
  • REST / 获取预言机
  • REST / 获取汇率
  • REST / 获取指数成分
WebSocket
  • WS / 工具频道
  • WS / 持仓量频道
  • WS / 资金利率频道
  • WS / 价格限制频道
  • WS / 期权摘要频道
  • WS / 预计履约/行权价格频道
  • WS / 标记价格频道
  • WS / 指数交易代码频道
  • WS / 标记价格K线图频道
  • WS / 指数K线图频道
  • WS / 强平订单频道

金融产品

收益
  • GET / 出价
  • POST / 购买
  • POST / 兑换
  • POST / 取消购买/兑换
  • GET / 活跃订单
  • GET / 订单历史
储蓄
  • GET / 储蓄余额
  • POST / 储蓄购买/兑换
  • POST / 设置贷款利率
  • GET / 贷款历史
  • GET / 公开借款信息(公开)
  • GET / 公开借款历史(公开)

交易统计

REST
  • REST / 获取支持币种
  • REST / 获取成交额
  • REST / 获取杠杆借贷比率
  • REST / 获取多空比例
  • REST / 获取合约持仓量和成交额
  • REST / 获取期权持仓量和成交额
  • REST / 获取看涨/看跌比例
  • REST / 获取到期持仓量和成交额
  • REST / 获取行权价持仓量和成交额
  • REST / 获取成交流向

子账户

REST
  • REST / 获取子账户列表
  • REST / 重置子账户API密钥
  • REST / 获取子账户交易余额
  • REST / 获取子账户资金余额
  • REST / 获取子账户最大提款额
  • REST / 获取子账户转账历史
  • REST / 获取受托子账户转账历史
  • REST / 主账户管理子账户间转账
  • REST / 设置提款权限
  • REST / 获取托管交易子账户列表
  • REST / 获取用户的代理返佣信息
  • REST / 设置子账户VIP贷款分配
  • REST / 获取子账户借款利息和额度

状态

REST
  • REST / 状态
WebSocket
  • WS / 状态通道

依赖关系

~8-25MB
~420K SLoC