YieldSphere SDK & API Docs

Embed GCC RWA yield distribution compliance strategies directly in your DeFi app.

← Return to Dashboard
POST/api/v1/route

Compile Cross-Chain CCTP payloads and register referral rebate IDs.

Request Body Parameters

FieldTypeRequiredDescription
sourceChainstringYesChain of origin (e.g., Ethereum, Arbitrum, Optimism).
targetVaultIdintegerYesWhitelisted Vault ID to receive funds (0 = Balanced, 1 = Conservative).
amountstringYesUSDC deposit volume in 6-decimal format (e.g. "100000000" for 100 USDC).
investorAddressstringYesThe depositor's destination address for compliance checks.
referrerstringNoAddress of the partner integrator to allocate the 0.05% rebate.

Javascript Request

// Example Request for Cross-Chain Liquidity Router API
const response = await fetch('https://yieldsphere.finance/api/v1/route', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    sourceChain: 'arbitrum',
    targetVaultId: 0,
    amount: 100000000, // 100 USDC (6 decimals)
    investorAddress: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e',
    referrer: '0x0000000000000000000000000000000000000000'
  })
});

const data = await response.json();
console.log(data.bridgeParams.cctpPayload);

API JSON Response

{
  "success": true,
  "investor": {
    "address": "0x742d35Cc6634C0532925a3b844Bc454e4438f44e",
    "isCompliant": true,
    "tier": 2
  },
  "bridgeParams": {
    "bridgeType": "Circle_CCTP",
    "sourceChain": "arbitrum",
    "destinationChain": "Arc_Testnet",
    "amount": "100000000",
    "cctpPayload": {
      "tokenMessenger": "0xd0c3da19fcfcb16d6494a862660dbfae3831885f",
      "usdcToken": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
      "amount": "100000000",
      "destinationDomain": 4,
      "mintRecipient": "0x87e8c7c387B62b8E6E630DE1819ef4CFfdb13e20",
      "burnToken": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"
    }
  },
  "callStructure": {
    "target": "0x87e8c7c387B62b8E6E630DE1819ef4CFfdb13e20",
    "abi": [...],
    "args": [0, "100000000", true]
  },
  "referral": {
    "referrerAddress": "0x0000000000000000000000000000000000000000",
    "rebateBps": 5,
    "estimatedRebateUSDC": 50000
  }
}