Quickstart Guide

Step 1: Get Your API Key

Your API key is sent via encrypted email as part of your onboarding kit. Add it to your environment:

CLVRBRIDGE_API_KEY=clvr_pilot_xxxxxxxxxxxxx

Verify it loads:

echo $CLVRBRIDGE_API_KEY

Requires Node.js 18+. Works with any HTTP client.

Step 2: Route Your First Trade

BUY — Fiat → Crypto

const BASE_URL = 'https://clvrbridge.onrender.com';

const quote = await fetch(`${BASE_URL}/api/quote`, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': process.env.CLVRBRIDGE_API_KEY
  },
  body: JSON.stringify({
    type: 'BUY',
    fiatCurrency: 'USD',
    fiatAmount: 500,
    cryptoCurrency: 'BTC',
    walletAddress: '0xUserWalletAddress'
  })
}).then(r => r.json());

console.log(quote.bestQuote);
// { provider: 'kraken:buy', toAmount: 0.01512, ... }

// Execute
const order = await fetch(`${BASE_URL}/api/execute`, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': process.env.CLVRBRIDGE_API_KEY
  },
  body: JSON.stringify({
    provider: quote.bestQuote.provider,
    quote: quote.bestQuote,
    walletAddress: '0xUserWalletAddress'
  })
}).then(r => r.json());

SELL — Crypto → Fiat

const quote = await fetch(`${BASE_URL}/api/quote`, {
  method: 'POST',
  headers: { 'Content-Type': 'application/json', 'x-api-key': process.env.CLVRBRIDGE_API_KEY },
  body: JSON.stringify({ type: 'SELL', cryptoCurrency: 'ETH', cryptoAmount: 2.5, fiatCurrency: 'USD', walletAddress: '0xUserWalletAddress' })
}).then(r => r.json());

SWAP — Crypto → Crypto

const quote = await fetch(`${BASE_URL}/api/quote`, {
  method: 'POST',
  headers: { 'Content-Type': 'application/json', 'x-api-key': process.env.CLVRBRIDGE_API_KEY },
  body: JSON.stringify({ type: 'SWAP', fromAsset: 'ETH', toAsset: 'USDC', fromAmount: 1.0, network: 'ethereum', walletAddress: '0xUserWalletAddress' })
}).then(r => r.json());

// Execute — returns calldata, user signs and submits
const tx = await fetch(`${BASE_URL}/api/execute`, {
  method: 'POST',
  headers: { 'Content-Type': 'application/json', 'x-api-key': process.env.CLVRBRIDGE_API_KEY },
  body: JSON.stringify({ provider: quote.bestQuote.provider, quote: quote.bestQuote, walletAddress: '0xUserWalletAddress' })
}).then(r => r.json());

Step 3: Verify Everything Works

• Check your revenue dashboard — confirm your first quote appears
• Verify multiple providers are returning quotes
• Test a BUY, a SELL, and a SWAP — all three should return results
• Confirm the 5% minimum uplift is being tracked

Step 4: Go Live

• Remove old single-provider code
• Deploy to staging and run 10 test trades
• Verify revenue tracking shows all test data
• Deploy to production
• Watch your revenue dashboard

Integration Checklist

Setup

• API key received via encrypted onboarding email
• Environment variables configured

Test Trades

• BUY flow tested ($10 minimum)
• SELL flow tested
• SWAP flow tested
• Quote data validated across multiple providers

Go Live

• Old provider code removed
• Application serving live user requests
• Revenue dashboard active

Engine Infrastructure

🔄 Swap (DEX & Aggregators)

💰 On/Off-Ramp (Buy & Sell)

🌉 Cross-Chain Swaps

Troubleshooting

Empty quote responses: Verify your API key. P2P providers may return empty when no offers exist — the engine falls back to instant providers.

Provider timeout: The engine retries and routes to the next best provider automatically.

Swap quote failures: Some providers are chain-specific. The engine queries all compatible providers and skips incompatible ones.

Cross-chain swaps: Ensure ChangeNOW and FixedFloat API keys are configured. SimpleSwap works without keys.

Next Steps

1. Explore the API reference — full endpoint docs
2. Check your client portal — watch earnings grow