DEX API

设置分佣#

OKX DEX API 支持为代币兑换,配置分佣费用和费用接收地址。

您可以将分佣相关参数包含在兑换报价中,来设置并收取分佣,每笔兑换最多收取 3% 的分佣费用。

OKX DEX API 计划从您向用户收取的分佣费中抽取一定比例。目前,OKX DEX API 不收取任何费用。

注意
Ton 链暂不支持分佣
// 使用 quoteParams 来设置分佣
const quoteParams = {
    chainId: SOLANA_CHAIN_ID,
    amount: rawAmount,
    fromTokenAddress,
    toTokenAddress,
    slippage: "0.5",
    userWalletAddress: userAddress,
    // 分佣相关的参数
    fromTokenReferrerWalletAddress: "Your_REFERRER_WALLET_ADDRESS", // 可选:基于询价币种接收分佣的地址
    toTokenReferrerWalletAddress: "REFERRER_WALLET", // 可选:基于目标币种接收分佣的地址
    feePercent: "1.5",  // 可选:分佣比例 (0-3%, 最多 2 位小数)

} as Record<string, string>;

分佣参数配置说明:

  • 参数feePercent分佣比例,须介于 0 和 3% 之间。
  • 参数feePercent最多支持2个小数点,例如传入 1.326%,但最终计算使用 1.32% 作为分佣比例。
  • 对于 Solana,收取分佣的地址必须提前存入一些 SOL 以进行激活。
  • 每笔交易只能从 fromToken 或 toToken 中选择一个作为分佣的来源。

分佣配置详细示例:

// 获取兑换报价
   const quoteParams = {
       chainId: SOLANA_CHAIN_ID,
       amount: rawAmount,
       fromTokenAddress,
       toTokenAddress,
       slippage: "0.5",
       userWalletAddress: userAddress,

       // Additional Fee params
       fromTokenReferrerWalletAddress: "fee-recipient-wallet-address",
       feePercent: "1",

       // The wallet addresses to receive the commission fee (Each transaction can only choose commission from either the fromToken or the toToken)
       // toTokenReferrerWalletAddress: "fee-recipient-wallet-address",
       // fromTokenReferrerWalletAddress: "fee-recipient-wallet-address",

   } as Record<string, string>;
const timestamp = new Date().toISOString();
    const requestPath = "/api/v5/dex/aggregator/swap";
    const queryString = "?" + new URLSearchParams(quoteParams).toString();
    const headers = getHeaders(timestamp, "GET", requestPath, queryString);

    const response = await fetch(
        `https://www.okx.com${requestPath}${queryString}`,
        { method: "GET", headers }
    );

    const data = await response.json();

    // .. Continue code implementation

分佣配置的命令行:

# Example: Swap .01 SOL to USDC with 1.5% fee to referrer
npx ts-node swap.ts .01 11111111111111111111111111111111 EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v --referrer YOUR_REFERRER_ADDRESS --fee 1.5

计算示例的分佣费用说明:

以 1.5% 的分佣比例,向 100 USDC 的交易收取分佣,设置toTokenReferrerWalletAddress作为分佣接收地址参数:

  • 分佣金额:1.5 USDC(100 USDC 的1.5%)
  • 实际用户兑换成功金额:98.5 USDC
  • 分佣(1.5 USDC)将发送到分佣接收地址