API Reference

🔐 Authentication

All API requests require an API key passed in the x-api-key header.

// Every request must include:
x-api-key: clvr_live_xxxxxxxxxxxxx

Your API key is sent via encrypted email during onboarding. Demo keys are available for testing with rate limits.

POST /api/quote

Get real-time quotes from all connected providers. Returns the best price, all competing quotes, and execution data.

Request Body

Example Request — BUY

const res = await fetch('https://api.clvrbridge.com/api/quote', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': 'clvr_live_xxxxxxxxxxxxx'
  },
  body: JSON.stringify({
    type: 'BUY',
    fiatCurrency: 'USD',
    fiatAmount: 500,
    cryptoCurrency: 'BTC',
    country: 'US'
  })
});

const data = await res.json();

Example Request — SWAP

const res = await fetch('https://api.clvrbridge.com/api/quote', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': 'clvr_live_xxxxxxxxxxxxx'
  },
  body: JSON.stringify({
    type: 'SWAP',
    fromAsset: 'ETH',
    toAsset: 'USDC',
    fromAmount: 0.1,
    network: 'ethereum'
  })
});

const data = await res.json();

Response

Example Response

{
  "requestId": "req_1784658454873_9bt9wy",
  "timestamp": 1784658458409,
  "responseTimeMs": 3536,
  "type": "SWAP",
  "status": "SUCCESS",
  "totalQuotes": 4,
  "providersResponded": ["0x", "kyberswap", "velora", "1inch"],
  "quotes": [
    {
      "provider": "kyberswap:ethereum",
      "fromAmount": 0.1,
      "fromCurrency": "ETH",
      "toAmount": 193.867287,
      "toCurrency": "USDC",
      "fee": 0,
      "effectiveRate": "1938.6729",
      "estimatedTimeMs": 30000,
      "successRate": 0.92
    }
  ],
  "bestQuote": {
    "provider": "kyberswap:ethereum",
    "toAmount": 193.867287,
    "toCurrency": "USDC",
    "fee": 0,
    "executionData": { ... }
  },
  "message": "Best from kyberswap:ethereum: 193.86728700 USDC"
}

Status Codes

POST /api/execute

Execute a trade using the bestQuote.executionData from a quote response.

Request Body

Example Request

const res = await fetch('https://api.clvrbridge.com/api/execute', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': 'clvr_live_xxxxxxxxxxxxx'
  },
  body: JSON.stringify({
    provider: 'kyberswap:ethereum',
    quote: quoteData.bestQuote,
    walletAddress: '0xUserWalletAddress'
  })
});

const result = await res.json();
// { success: true, provider: "kyberswap:ethereum", executionType: "CALLDATA", transaction: { ... } }

Execution Types

GET /api/providers

Returns all connected providers with their capabilities, coverage, and current pricing tiers.

Example Response

{
  "providers": {
    "ccxt": { "capabilities": ["BUY", "SELL"], "coverage": "18 exchanges" },
    "0x": { "capabilities": ["SWAP"], "coverage": "Ethereum, L2s, 70+ sources" },
    "poloniex": { "capabilities": ["BUY", "SELL"], "coverage": "Established global exchange, 350+ pairs" }
  },
  "tiers": {
    "pilot": { "baseFee": "0%", "uplift": "100%", "commitment": "10%" },
    "tier1": { "baseFee": "2%", "uplift": "80%", "commitment": "10%" },
    "tier2": { "baseFee": "1.5%", "uplift": "85%", "commitment": "25%" },
    "tier3": { "baseFee": "1%", "uplift": "90%", "commitment": "50%+" }
  }
}

GET /api/dashboard

Returns your account metrics including trade volume, revenue earned, and provider performance.

GET /health

Health check endpoint. Returns service status.

// Response:
{ "status": "healthy", "timestamp": 1784658458409 }

GET /api/balance

Returns your current revenue balance and earnings breakdown.

📊 Rate Limits