OKX API公共端点

什么是OKX API？

OKX API是一套预先定义的接口，它允许你的程序（如交易机器人、数据分析脚本）直接向OKX服务器发送请求，以获取市场数据、账户信息、执行交易操作等，无需人工干预，它就是你与OKX交易所进行“对话”的桥梁。

为什么使用OKX API？

• 自动化交易：制定交易策略，让程序7x24小时自动执行买卖操作，克服人性弱点。
• 量化分析：获取实时和历史市场数据，进行回测和策略优化。
• 高效操作：批量处理订单，快速响应市场变化，提升交易效率。
• 定制化开发：根据个人需求开发独特的交易工具或管理系统。

准备工作：开启API之旅

在开始调用API之前,你需要完成以下准备：

• 注册并验证OKX账户：确保你已经完成了身份认证（KYC），这是开通API的前提。
• 创建API Key：
  • 登录OKX账户,进入“API管理”页面。
  • 创建新的API Key，设置IP访问白名单（强烈建议，以增强安全性），选择权限（仅读取、交易提现等，根据需求最小化权限）。
  • 妥善保管你的API Key（Secret Key）和Passphrase（口令），切勿泄露给他人，这相当于你的账户密码。
• 选择开发工具与环境：
  • 编程语言：Python是最常用的选择，拥有丰富的库支持（如requests, python-okx等），你也可以根据熟悉程度选择Node.js、Java、C++等。
  • 代码编辑器：VS Code、PyCharm等。
  • 网络环境：确保你的网络能够稳定访问OKX API服务器。

第一个API请求：获取市场数据（以Python为例）

最简单的API调用是获取公开的市场数据,无需认证，获取现货ticker信息：

import requests
import json
url = "https://www.okx.com/api/v5/market/ticker?instId=BTC-USDT"
try:
    response = requests.get(url)
    data = response.json()
    if data["code"] == "0":
        ticker = data["data"][0]
        print(f"币种: {ticker['instId']}")
        print(f"最新价: {ticker['last']}")
        print(f"买一价: {ticker['bidPx']}")
        print(f"卖一价: {ticker['askPx']}")
        print(f"24H成交量: {ticker['vol24h']}")
    else:
        print(f"API请求错误: {data['msg']}")
except Exception as e:
    print(f"发生异常: {e}")

这段代码展示了如何使用Python的requests库发送一个GET请求，获取BTC-USDT的交易对信息，并解析返回的JSON数据。

认证机制：私有序列号调用

当你需要进行需要认证的操作（如查询账户信息、下单）时，就需要在请求头中包含认证信息，OKX API使用API Key、Secret Key和Passphrase进行签名认证。

认证过程大致如下：

1. 构建请求字符串：包括时间戳、请求方法、请求路径、请求体（如果有）。
2. 生成签名：使用HMAC-SHA256算法，以Secret Key为密钥，对请求字符串进行加密签名。
3. 添加请求头：将API Key、Passphrase、签名和时间戳等信息添加到请求头中。

大多数官方或第三方SDK已经封装了这些复杂的认证过程,开发者只需提供必要的参数即可，使用官方Python SDK：

# 需要先安装: pip install python-okx
from okx import TradeAPI
# 替换为你的API信息
api_key = "YOUR_API_KEY"
secret_key = "YOUR_SECRET_KEY"
passphrase = "YOUR_PASSPHRASE"
flag = "0" # 0:生产环境, 1:沙盒环境
trade_api = TradeAPI(api_key, secret_key, passphrase, False, flag)
try:
    # 获取账户资产
    result = trade_api.get_account_balance()
    print(result)
except Exception as e:
    print(f"发生异常: {e}")

进阶篇：深入核心功能，构建交易策略

入门之后,我们需要更深入地了解OKX API的核心功能，以构建更复杂的交易系统。

贴近市场：行情数据接口详解

OKX提供了丰富的行情数据接口,满足不同层次的需求：

• K线数据：获取指定时间周期（如1分钟、1小时、1天）的K线数据，用于技术分析。
  • 接口：GET /api/v5/market/candles
• 深度数据：获取买卖盘口信息，了解市场流动性。
  • 接口：GET /api/v5/market/books
• 交易明细：获取最近的成交记录。
  • 接口：GET /api/v5/market/trades
• 标记价格与资金费率：对于合约交易尤为重要。
  • 接口：GET /api/v5/market/mark-price, GET /api/v5/market/funding-rate

账户管理：资产与订单查询

• 查询账户资产：获取各类币种的余额、冻结数量等。
  • 接口：GET /api/v5/account/balance
• 查询持仓信息：对于合约交易，查询当前持仓情况。
  • 接口：GET /api/v5/account/positions
• 查询订单历史：查看过去一段时间内的订单记录。
  • 接口：GET /api/v5/trade/orders-history
• 查询成交历史：查看订单成交明细。
  • 接口：GET /api/v5/trade/fills

交易执行：下单、改单与撤单

这是API的核心功能之一：

• 下单：支持限价单、市价单等多种订单类型。
  • 接口：POST /api/v5/trade/order
  • 参数包括：币对（instId）、交易方向（side）、订单类型（ordType）、数量（sz）、价格（px）等。
• 修改订单：对未完全成交的订单进行修改（如修改价格或数量）。
  • 接口：POST /api/v5/trade/amend-order
  • 参数：订单ID（ordId）、原订单ID（origClOrdId）、修改后的价格（newPx）、数量（newSz）等。
• 撤销订单：取消未完全成交的订单。
  • 接口：POST /api/v5/trade/cancel-order
  • 参数：订单ID（ordId）或原订单ID（origClOrdId）。

示例：限价买单

# 使用trade_api实例（同上）
try:
    # 下一个BTC-USDT限价买单，价格30000 USDT，数量0.1 BTC
    order_result = trade_api.place_order(
        instId="BTC-USDT",
        tdMode="cash",  # 交易模式：cash现货，cross全仓保证金，isolated逐仓保证金
        side="buy",
        ordType="limit",
        px="30000",
        sz="0.1"
    )
    print("下单结果:", order_result)
    if order_result["code"] == "0":
        ord_id = order_result["data"][0]["ordId"]
        print("订单ID:", ord_id)
except Exception as e:
    print(f"下单异常: {e}")

风险控制：持仓管理与止盈止损

• 设置止盈止损单：OKX支持通过条件单（如止盈止损单、跟踪止损单）来实现自动化风险管理。
  • 接口：POST /api/v5/trade/order-algo
• 查询和管理条件单。
• 实时监控持仓盈亏，根据预设条件调整策略或手动干预。

精通篇：高阶技巧与最佳实践

当你能够熟练运用API进行基本交易