VanPlex Public API Documentation
Integrate proforma data into your website or application. Simply enter your API key and MLS number to see live examples.
Your API Credentials
Enter your API key and MLS number to see customized code examples
Embed Proforma Widget
Generate iframe code to embed the proforma widget directly on your website
⚠️ Enter your API key above to see the live preview
Direct iframe Embed
Copy and paste this HTML code into your website. The embed URL uses vanplex.ca (production).
<iframe
src="https://www.vanplex.ca/proforma-embed?mls=R3054427&api_key=your_api_key_here&theme=light&primaryColor=F61C3E"
width="100%"
height="800"
frameborder="0"
style="border: none; border-radius: 8px; box-shadow: 0 2px 8px rgba(0,0,0,0.1);"
title="VanPlex Proforma Analysis">
</iframe>Quick Start
Get Your API Key
Contact VanPlex to receive your unique API key (format: vpx_live_...)
Make API Requests
Include your API key in the X-API-Key header with every request
Integrate the Data
Display proforma data on your website or use it in your application
API Endpoints
Get complete proforma data for a property using MLS number
format: 'full' or 'minimal' (default: 'full')force: 'true' or 'false' - force recalculation (default: 'false')Shortcut for minimal format (same as ?format=minimal)
Health check endpoint (no authentication required)
Code Examples
Copy and paste these examples to get started quickly
Full Proforma Data
Get complete proforma analysis with all financial details
curl "https://app.realsaige.com/api/public/v1/proforma/R3054427" \
-H "X-API-Key: your_api_key_here"Response Format
Understanding the API response structure
Full Format Response
{
"proforma": {
"SA": "VVWKE",
"Area": "Vancouver West",
"city": "Vancouver",
"MLNum": "R3054427",
"address": "2027 W 44TH AVENUE",
"project_profit": 5503852,
"return_on_equity": "63%",
"land_value": 3368000,
"sales_value": 11238861,
"design_build_cost": -4918650,
"hard_cost": 4677581.25,
// ... more fields
},
"api_metadata": {
"endpoint": "public_proforma_v1",
"version": "1.0",
"api_user_org": "Your Organization",
"timestamp": "2026-01-01T12:00:00.000000",
"cached": true
}
}Minimal Format Response
{
"proforma": {
"address": "2027 W 44TH AVENUE",
"city": "Vancouver",
"project_profit": 5503852,
"return_on_equity": "63%",
"land_value": 3368000,
"sales_value": 11238861
},
"api_metadata": { ... }
}Need Help?
For questions about the API, rate limits, or to request an API key, please contact the VanPlex development team.
https://app.realsaige.com/api/public/v1