📚 RateScout API Documentation
Complete guide to accessing Canadian mortgage rates from 17+ lenders
🚀 Quick Start
2
Get API Key
Generate your key from the dashboard
3
Make Requests
Call endpoints with ?key=YOUR_KEY
🔐 Authentication
All API requests require authentication via API key or session cookie.
Method 1: Query Parameter (Recommended)
GET /api/rates/bmo?key=YOUR_API_KEY
Method 2: Authorization Header
Authorization: Bearer YOUR_API_KEY
📡 API Endpoints
GET
/api/rates/aggregated
⭐ Most Popular
Get normalized mortgage rates from all lenders in a unified format.
Example:
curl "https://api.ratescout.ca/api/rates/aggregated?key=YOUR_KEY"
GET
/api/rates/:lender
Get raw scraped data for a specific lender.
Available Lenders:
bmo
td
rbc
scotiabank
cibc
desjardins
manulife
firstnational
equitable
laurentian
hometrust
alterna
coastcapital
firstontario
marathon
strive
⏱️ Rate Limits
| Plan | Requests/15min | Daily Limit |
|---|---|---|
| Free Tier | 100 | 10,000 |
| Logged-in Users | Unlimited | Unlimited |
❌ Error Codes
| Code | Error | Description |
|---|---|---|
400 |
Bad Request | Invalid lender ID or malformed request |
401 |
Unauthorized | Missing or invalid API key |
429 |
Too Many Requests | Rate limit exceeded |
500 |
Server Error | Internal server error |
💻 Code Examples
🟨 JavaScript
const response = await fetch( '/api/rates/aggregated?key=YOUR_KEY' ); const data = await response.json();
🐍 Python
import requests
response = requests.get(
'/api/rates/aggregated',
params={'key': 'YOUR_KEY'}
)