Requirements
- Target platform
- OpenClaw
- Install method
- Manual import
- Extraction
- Extract archive
- Prerequisites
- OpenClaw
- Primary doc
- SKILL.md
Fetch optimal swap quotes from OKX DEX Aggregator API (v6). Use this skill when a user wants to: 1. Get the best price for swapping tokens on any supported E...
Fetch optimal swap quotes from OKX DEX Aggregator API (v6). Use this skill when a user wants to: 1. Get the best price for swapping tokens on any supported E...
Hand the extracted package to your coding agent with a concrete install brief instead of figuring it out manually.
I downloaded a skill package from Yavira. Read SKILL.md from the extracted folder and install it by following the included instructions. Tell me what you changed and call out any manual steps you could not complete.
I downloaded an updated skill package from Yavira. Read SKILL.md from the extracted folder, compare it with my current installation, and upgrade it while preserving any custom configuration unless the package docs explicitly say otherwise. Summarize what changed and any follow-up checks I should run.
This skill generates production-ready code for fetching optimal swap quotes from the OKX DEX Aggregator API v6. The API finds the best price across multiple DEX protocols (Uniswap, SushiSwap, Curve, etc.) and returns detailed routing information including price impact, gas estimates, and token safety flags. Key capabilities: Authenticated API requests with HMAC-SHA256 signing Correct handling of token decimals and amount formatting Support for exactIn (fixed input) and exactOut (fixed output) swap modes Multi-chain support (Ethereum, BSC, Arbitrum, Base, Solana, and 20+ chains) Price impact protection and honeypot detection Fee/commission splitting configuration
Users must have an OKX Web3 API key set. The skill needs three values: OKX_ACCESS_KEY โ API key OKX_SECRET_KEY โ Secret key for HMAC signing OKX_PASSPHRASE โ Account passphrase
Python: requests, hmac, hashlib, base64, datetime (all stdlib except requests) Node.js: axios or node-fetch, built-in crypto No additional blockchain dependencies required (this is a read-only quote endpoint)
GET https://web3.okx.com/api/v6/dex/aggregator/quote
Before constructing the API call, validate: Chain ID (chainIndex) โ Must be a supported chain. Common values: 1 = Ethereum 56 = BSC 137 = Polygon 42161 = Arbitrum 8453 = Base 130 = Unichain 501 = Solana Token addresses โ Must be valid contract addresses or the native token placeholder: Native tokens (ETH, BNB, etc.): 0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee Contract tokens: Full 42-character hex address (EVM) or base58 (Solana) Amount โ MUST include token decimals. This is the #1 source of errors: 1 ETH (18 decimals) โ "1000000000000000000" 1 USDT (6 decimals) โ "1000000" 1 WBTC (8 decimals) โ "100000000" Formula: amount_raw = human_amount * (10 ** token_decimals) Swap mode โ exactIn (default) or exactOut exactOut only supported on: Ethereum, Base, BSC, Arbitrum exactOut only works with Uniswap V2/V3 pools
OKX API requires HMAC-SHA256 signed requests with 4 headers: OK-ACCESS-KEY: <api_key> OK-ACCESS-SIGN: <hmac_signature> OK-ACCESS-PASSPHRASE: <passphrase> OK-ACCESS-TIMESTAMP: <iso8601_timestamp> Signing algorithm: timestamp = ISO 8601 UTC time (e.g., "2025-01-15T12:00:00.000Z") prehash = timestamp + "GET" + request_path_with_query signature = Base64(HMAC-SHA256(secret_key, prehash)) CRITICAL: The request_path_with_query must include the full path starting from /api/... plus the query string. Example: /api/v6/dex/aggregator/quote?chainIndex=1&amount=1000000000000000000&fromTokenAddress=0xeee...&toTokenAddress=0xa0b...
Success response structure: { "code": "0", "data": [{ "chainIndex": "1", "fromToken": { "tokenSymbol": "ETH", "decimal": "18", ... }, "toToken": { "tokenSymbol": "USDC", "decimal": "6", ... }, "fromTokenAmount": "1000000000000000000", "toTokenAmount": "3521432100", "dexRouterList": [...], "tradeFee": "2.45", "estimateGasFee": "150000", "priceImpactPercent": "-0.12" }], "msg": "" } Key fields to extract: toTokenAmount โ The amount you'll receive (in raw units with decimals) tradeFee โ Estimated network fee in USD priceImpactPercent โ Negative = losing value; large negative = danger dexRouterList โ Routing path through various DEX protocols fromToken.isHoneyPot / toToken.isHoneyPot โ Scam token flag fromToken.taxRate / toToken.taxRate โ Token buy/sell tax
Convert raw amounts back to human-readable: human_amount = raw_amount / (10 ** decimal) Always display: Exchange rate (e.g., "1 ETH = 3,521.43 USDC") Price impact percentage with warning if > 3% Estimated gas fee in USD Routing summary (which DEXes are used) Honeypot warnings if detected Token tax rates if > 0
NEVER hardcode API credentials in generated code. Always use environment variables or config files. NEVER log the secret key or signature in debug output. Validate all token addresses against expected format before sending. Check isHoneyPot flag on both tokens and warn the user prominently.
Always use string type for amounts to avoid floating-point precision loss. Python: Use int() for amount calculations, never float(). JavaScript: Use BigInt or string math for amounts > 2^53. When user provides a human-readable amount like "1.5 ETH", convert: str(int(1.5 * 10**18)).
Check response["code"] == "0" before accessing data. Common error codes: Non-zero code with msg = API error (e.g., insufficient liquidity, invalid params) HTTP 401 = Authentication failure (check signature algorithm) HTTP 429 = Rate limited If priceImpactPercent is null, warn that price impact couldn't be calculated.
Respect OKX rate limits. For production use, implement exponential backoff. Cache quotes if polling repeatedly (quotes are valid for ~15-30 seconds).
dexIds โ Use when you want to restrict to specific DEXes (e.g., only Uniswap). directRoute=true โ Only for Solana; forces single-pool routing. priceImpactProtectionPercent โ Set to a sensible default like 10 for safety. Set to 100 to disable. feePercent โ For integrators taking commission. Max 3% (EVM) or 10% (Solana). Up to 9 decimal places.
import os, hmac, hashlib, base64, requests from datetime import datetime, timezone from urllib.parse import urlencode API_KEY = os.environ["OKX_ACCESS_KEY"] SECRET_KEY = os.environ["OKX_SECRET_KEY"] PASSPHRASE = os.environ["OKX_PASSPHRASE"] def get_okx_quote(chain_index, from_token, to_token, amount, swap_mode="exactIn"): base_url = "https://web3.okx.com" path = "/api/v6/dex/aggregator/quote" params = { "chainIndex": chain_index, "fromTokenAddress": from_token, "toTokenAddress": to_token, "amount": amount, "swapMode": swap_mode, } query_string = urlencode(params) request_path = f"{path}?{query_string}" # Generate timestamp and signature timestamp = datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%S.%f")[:-3] + "Z" prehash = timestamp + "GET" + request_path signature = base64.b64encode( hmac.new(SECRET_KEY.encode(), prehash.encode(), hashlib.sha256).digest() ).decode() headers = { "OK-ACCESS-KEY": API_KEY, "OK-ACCESS-SIGN": signature, "OK-ACCESS-PASSPHRASE": PASSPHRASE, "OK-ACCESS-TIMESTAMP": timestamp, } resp = requests.get(base_url + request_path, headers=headers) resp.raise_for_status() data = resp.json() if data["code"] != "0": raise Exception(f"OKX API error: {data['msg']}") return data["data"][0] # Swap 1 ETH -> USDC on Ethereum ETH = "0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee" USDC = "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48" amount = str(1 * 10**18) # 1 ETH in wei quote = get_okx_quote("1", ETH, USDC, amount) to_decimals = int(quote["toToken"]["decimal"]) received = int(quote["toTokenAmount"]) / (10 ** to_decimals) print(f"You will receive: {received:,.2f} {quote['toToken']['tokenSymbol']}") print(f"Price impact: {quote['priceImpactPercent']}%") print(f"Gas fee (USD): ${quote['tradeFee']}") print(f"Honeypot check: {'WARNING' if quote['toToken']['isHoneyPot'] else 'Safe'}")
const crypto = require("crypto"); const https = require("https"); const API_KEY = process.env.OKX_ACCESS_KEY; const SECRET_KEY = process.env.OKX_SECRET_KEY; const PASSPHRASE = process.env.OKX_PASSPHRASE; function getQuote(chainIndex, fromToken, toToken, amount, options = {}) { const params = new URLSearchParams({ chainIndex, fromTokenAddress: fromToken, toTokenAddress: toToken, amount, swapMode: options.swapMode || "exactIn", ...(options.feePercent && { feePercent: options.feePercent }), ...(options.priceImpactProtectionPercent && { priceImpactProtectionPercent: options.priceImpactProtectionPercent, }), }); const path = `/api/v6/dex/aggregator/quote?${params}`; const timestamp = new Date().toISOString(); const prehash = timestamp + "GET" + path; const signature = crypto .createHmac("sha256", SECRET_KEY) .update(prehash) .digest("base64"); return new Promise((resolve, reject) => { const req = https.get( `https://web3.okx.com${path}`, { headers: { "OK-ACCESS-KEY": API_KEY, "OK-ACCESS-SIGN": signature, "OK-ACCESS-PASSPHRASE": PASSPHRASE, "OK-ACCESS-TIMESTAMP": timestamp, }, }, (res) => { let body = ""; res.on("data", (chunk) => (body += chunk)); res.on("end", () => { const data = JSON.parse(body); if (data.code !== "0") reject(new Error(`OKX: ${data.msg}`)); else resolve(data.data[0]); }); } ); req.on("error", reject); }); }
Router: ETH -> WBTC -> USDC dexRouterList shows: - 55% ETH -> WBTC via Uniswap V4 - 30% ETH -> USDC via Uniswap V4 (direct) - WBTC -> USDC via Euler (73%) + Uniswap V4 (27%) This means the aggregator splits the trade across multiple paths to minimize price impact and maximize output.
ProblemCauseSolution401 UnauthorizedSignature mismatchVerify prehash string is exactly timestamp + "GET" + full_path_with_query. Check secret key encoding.Amount too smallMissing decimal conversionMultiply human amount by 10 ** token_decimals. 1 USDT = 1000000, not 1.Invalid token addressWrong chain/address comboVerify the token exists on the specified chain. Use native token placeholder for ETH/BNB/etc.priceImpactPercent very negative (< -10%)Low liquidity or large tradeReduce trade size or split across multiple transactions.isHoneyPot: trueScam token detectedDo NOT proceed with the swap. Warn the user immediately.exactOut not workingUnsupported chain/protocolOnly works on Ethereum, Base, BSC, Arbitrum with Uniswap V2/V3.taxRate > 0Token has built-in taxFactor tax into expected output. E.g., 5% tax means receiving 5% less.Empty dexRouterListNo liquidity path foundTry a different token pair, smaller amount, or different chain.code is non-zeroGeneral API errorRead msg field for details. Common: rate limit, maintenance, invalid params.
ChainchainIndexEthereum1BSC56Polygon137Arbitrum42161Optimism10Avalanche43114Base8453Solana501Unichain130
TokenAddressDecimalsETH (native)0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee18USDT0xdac17f958d2ee523a2206206994597c13d831ec76USDC0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb486WETH0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc218WBTC0x2260fac5e5542a773aa44fbcfedf7c193bc2c5998DAI0x6b175474e89094c44da98b954eedeac495271d0f18
ParameterRequiredDescriptionchainIndexYesChain ID (e.g., 1 for Ethereum)amountYesAmount in raw units (with decimals)swapModeYesexactIn or exactOutfromTokenAddressYesSell token contract addresstoTokenAddressYesBuy token contract addressdexIdsNoComma-separated DEX IDs to restrict routingdirectRouteNotrue for single-pool only (Solana only)priceImpactProtectionPercentNoMax allowed price impact 0-100 (default 90)feePercentNoCommission fee percentage for integrators
Code helpers, APIs, CLIs, browser automation, testing, and developer operations.
Largest current source with strong distribution and engagement signals.