Partner API Documentation

Complete guide for integrating with ReserveBTC Yield Scales protocol

Authentication

All API requests require an API key passed in the header:

x-api-key: your-api-key-here

Security: Never expose your API key in client-side code. Always make API calls from your backend.

API Endpoints

Get Yield Data

Retrieve current yield metrics, liquidity, and revenue projections

GET

/api/partners/yield-data

View Response Example

{
  "protocol": "ReserveBTC Yield Scales",
  "timestamp": "2025-01-14T12:00:00Z",
  "partner": {
    "id": "partner_id",
    "name": "Partner Name",
    "tier": "premium"
  },
  "metrics": {
    "totalRBTCSupply": 238967,
    "rbtcScalePercentage": 23.9,
    "recommendedYieldRate": 1.19,
    "totalParticipants": "encrypted"
  },
  "trading": {
    "availableLiquidity": 3456789,
    "averageDailyVolume": 234567,
    "priceFeeds": {
      "BTC_USD": 45000,
      "ETH_USD": 2500,
      "RBTC_SYNTH_USD": 44950,
      "last_update": "2025-01-14T12:00:00Z"
    }
  },
  "revenue": {
    "feeStructure": {
      "tradingFee": "0.3%",
      "protocolShare": "30%",
      "partnerShare": "70%"
    },
    "projectedMonthlyRevenue": {
      "daily": 493,
      "weekly": 3456,
      "monthly": 14796,
      "currency": "USD"
    }
  },
  "limits": {
    "rate_limit": 100,
    "rate_limit_window": "hour",
    "calls_remaining": 97
  }
}

Code Examples

javascript

// Fetch yield data
const response = await fetch('https://app.reservebtc.io/api/partners/yield-data', {
  headers: {
    'x-api-key': 'your-api-key-here'
  }
});
const data = await response.json();
console.log('Current yield rate:', data.metrics.recommendedYieldRate);

python

# Fetch yield data
import requests

headers = {'x-api-key': 'your-api-key-here'}
response = requests.get('https://app.reservebtc.io/api/partners/yield-data', headers=headers)
data = response.json()
print(f"Current yield rate: {data['metrics']['recommendedYieldRate']}")

curl

curl -H "x-api-key: your-api-key-here" \
  https://app.reservebtc.io/api/partners/yield-data

Rate Limits

Basic Tier

100 req/hour

Premium Tier

1000 req/hour

Enterprise

Unlimited

Security Best Practices

• Store API keys in environment variables, never in code
• Make API calls from your backend, not frontend
• Implement request signing for additional security
• Monitor API usage for unusual patterns
• Rotate API keys regularly