okx-dex-ws

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Onchain OS DEX WebSocket — Unified Skill

Onchain OS DEX WebSocket — 统一技能

Two ways to consume real-time DEX data:
  1. CLI (
    onchainos ws
    ) — start a background session, poll events incrementally. Best for monitoring and agent-driven workflows.
  2. Script — write a custom WebSocket client in Python/Node/Rust. Best for bots and custom logic.
有两种方式获取DEX实时数据:
  1. CLI (
    onchainos ws
    ) — 启动后台会话,增量拉取事件。最适合监控和Agent驱动的工作流。
  2. 脚本 — 用Python/Node/Rust编写自定义WebSocket客户端。最适合机器人和自定义逻辑场景。

Pre-flight Checks

前置检查

Read
../okx-agentic-wallet/_shared/preflight.md
. If that file does not exist, read
_shared/preflight.md
instead.
阅读
../okx-agentic-wallet/_shared/preflight.md
。如果该文件不存在,请改为阅读
_shared/preflight.md

Prerequisites

前提条件

This skill requires co-installation with
okx-dex-market
,
okx-dex-token
,
okx-dex-signal
, and
okx-dex-trenches
(all included in the onchainos-skills repository).
使用本技能需要同时安装
okx-dex-market
okx-dex-token
okx-dex-signal
okx-dex-trenches
(所有这些包都包含在onchainos-skills仓库中)。

Approach 1: CLI (
onchainos ws
)

方法1:CLI (
onchainos ws
)

Discover Channels

查看可用频道

onchainos ws channels                          # list all 9 supported channels
onchainos ws channel-info --channel <name>     # detailed info + example for a channel
onchainos ws channels                          # list all 9 supported channels
onchainos ws channel-info --channel <name>     # detailed info + example for a channel

Start / Poll / Stop

启动/拉取/停止

onchainos ws start --channel <channel> [params]   # start background session
onchainos ws poll --id <ID> [--channel <ch>]       # pull new events
onchainos ws list                                  # list sessions
onchainos ws stop [--id <ID>]                      # stop session(s)
onchainos ws start --channel <channel> [params]   # start background session
onchainos ws poll --id <ID> [--channel <ch>]       # pull new events
onchainos ws list                                  # list sessions
onchainos ws stop [--id <ID>]                      # stop session(s)

Channel Quick Reference

频道快速参考

ChannelGroupPatternRequired Params
kol_smartmoney-tracker-activity
signalglobal(none)
address-tracker-activity
signalper-wallet
--wallet-addresses
dex-market-new-signal-openapi
signalper-chain
--chain-index
price
marketper-token
--token-pair
dex-token-candle{period}
marketper-token
--token-pair
price-info
tokenper-token
--token-pair
trades
tokenper-token
--token-pair
dex-market-memepump-new-token-openapi
trenchesper-chain
--chain-index
dex-market-memepump-update-metrics-openapi
trenchesper-chain
--chain-index
频道分组模式必填参数
kol_smartmoney-tracker-activity
signalglobal(none)
address-tracker-activity
signalper-wallet
--wallet-addresses
dex-market-new-signal-openapi
signalper-chain
--chain-index
price
marketper-token
--token-pair
dex-token-candle{period}
marketper-token
--token-pair
price-info
tokenper-token
--token-pair
trades
tokenper-token
--token-pair
dex-market-memepump-new-token-openapi
trenchesper-chain
--chain-index
dex-market-memepump-update-metrics-openapi
trenchesper-chain
--chain-index

Parameter Formats

参数格式

  • --token-pair
    :
    chainIndex:tokenContractAddress
    (e.g.
    1:0xdac17f958d2ee523a2206206994597c13d831ec7
    )
  • --chain-index
    : comma-separated chain IDs (e.g.
    1,501,56
    )
  • --wallet-addresses
    : comma-separated addresses, max 200
  • --idle-timeout
    : auto-stop if no poll within this duration (default
    30m
    ;
    1h
    ,
    2h
    ,
    300s
    ,
    0
    to disable)
  • --token-pair
    :
    chainIndex:tokenContractAddress
    (例如
    1:0xdac17f958d2ee523a2206206994597c13d831ec7
  • --chain-index
    : 用逗号分隔的链ID(例如
    1,501,56
  • --wallet-addresses
    : 用逗号分隔的钱包地址,最多200个
  • --idle-timeout
    : 若在此时间段内没有拉取请求则自动停止会话(默认
    30m
    ;支持
    1h
    2h
    300s
    ,设为
    0
    可禁用该功能)

Examples

示例

bash
undefined
bash
undefined

Smart money trade feed

Smart money trade feed

onchainos ws start --channel kol_smartmoney-tracker-activity
onchainos ws start --channel kol_smartmoney-tracker-activity

Track specific wallets

Track specific wallets

onchainos ws start --channel address-tracker-activity --wallet-addresses 0xAAA,0xBBB
onchainos ws start --channel address-tracker-activity --wallet-addresses 0xAAA,0xBBB

Token price monitoring

Token price monitoring

onchainos ws start --channel price --token-pair 1:0xdac17f958d2ee523a2206206994597c13d831ec7
onchainos ws start --channel price --token-pair 1:0xdac17f958d2ee523a2206206994597c13d831ec7

Buy signal alerts on Ethereum + Solana

Buy signal alerts on Ethereum + Solana

onchainos ws start --channel dex-market-new-signal-openapi --chain-index 1,501
onchainos ws start --channel dex-market-new-signal-openapi --chain-index 1,501

New meme token launches on Solana

New meme token launches on Solana

onchainos ws start --channel dex-market-memepump-new-token-openapi --chain-index 501
onchainos ws start --channel dex-market-memepump-new-token-openapi --chain-index 501

K-line 1-minute candles

K-line 1-minute candles

onchainos ws start --channel dex-token-candle1m --token-pair 1:0xdac17f958d2ee523a2206206994597c13d831ec7
undefined
onchainos ws start --channel dex-token-candle1m --token-pair 1:0xdac17f958d2ee523a2206206994597c13d831ec7
undefined

Poll Filters (tracker channels only)

拉取过滤器(仅追踪类频道可用)

When polling
kol_smartmoney-tracker-activity
or
address-tracker-activity
, these filters are available:
  • --min-quote-amount
    ,
    --min-market-cap
    ,
    --min-pnl
  • --trader
    (wallet address prefix match)
  • --tag
    (smart_money or kol)
  • --trade-type
    (buy or sell)
  • --since
    (ms timestamp)
当拉取
kol_smartmoney-tracker-activity
address-tracker-activity
频道的数据时,可使用以下过滤器:
  • --min-quote-amount
    ,
    --min-market-cap
    ,
    --min-pnl
  • --trader
    (钱包地址前缀匹配)
  • --tag
    (smart_money或kol)
  • --trade-type
    (买或卖)
  • --since
    (毫秒级时间戳)

Approach 2: Custom Script

方法2:自定义脚本

When the user wants to build a custom WebSocket client with their own logic, read the corresponding protocol reference file:
当用户需要搭建带有自定义逻辑的WebSocket客户端时,请阅读对应的协议参考文件:

Market Data (price & candlestick streams)

市场数据(价格和K线流)

Read:
../okx-dex-market/references/ws-protocol.md
Channels:
price
,
dex-token-candle{period}
阅读:
../okx-dex-market/references/ws-protocol.md
频道:
price
,
dex-token-candle{period}

Token Data (detailed token streams)

代币数据(详细代币流)

Read:
../okx-dex-token/references/ws-protocol.md
Channels:
price-info
,
trades
阅读:
../okx-dex-token/references/ws-protocol.md
频道:
price-info
,
trades

Signal & Wallet Tracking

信号与钱包追踪

Read:
../okx-dex-signal/references/ws-protocol.md
Channels:
dex-market-new-signal-openapi
,
kol_smartmoney-tracker-activity
,
address-tracker-activity
阅读:
../okx-dex-signal/references/ws-protocol.md
频道:
dex-market-new-signal-openapi
,
kol_smartmoney-tracker-activity
,
address-tracker-activity

Meme/Trenches

Meme币/ trenches频道

Read:
../okx-dex-trenches/references/ws-protocol.md
Channels:
dex-market-memepump-new-token-openapi
,
dex-market-memepump-update-metrics-openapi
阅读:
../okx-dex-trenches/references/ws-protocol.md
频道:
dex-market-memepump-new-token-openapi
,
dex-market-memepump-update-metrics-openapi

Common Protocol (all channels share)

通用协议(所有频道通用)

  • Endpoint:
    wss://wsdex.okx.com/ws/v6/dex
  • Auth: HMAC-SHA256 login required before subscribing
  • Heartbeat: send
    "ping"
    every 25s, expect
    "pong"
  • Subscribe:
    {"op": "subscribe", "args": [...]}
  • Unsubscribe:
    {"op": "unsubscribe", "args": [...]}
  • 接入点:
    wss://wsdex.okx.com/ws/v6/dex
  • 鉴权: 订阅前需要使用HMAC-SHA256方式登录
  • 心跳: 每25秒发送
    "ping"
    ,预期收到
    "pong"
    响应
  • 订阅:
    {"op": "subscribe", "args": [...]}
  • 取消订阅:
    {"op": "unsubscribe", "args": [...]}