Homesage.ai Developer Platform

API Documentation

Complete reference guide for integrating Homesage.ai's real estate APIs into your applications

API Documentation

Welcome to the Homesage.ai API documentation. Our comprehensive real estate APIs provide access to property data, investment analysis, and rental calculations for properties across the United States.

New to our APIs? Start with the Quick Start Guide to get up and running in minutes.

Quick Start

Get started with Homesage.ai APIs in just a few steps:

1. Get Your API Key

Sign up for a developer account and generate your JWT token through our Developer Portal.

2. Make Your First Request
JavaScript
const token = 'YOUR_JWT_TOKEN';

fetch('https://developers.homesage.ai/api/properties/info/?property_address=123+Main+St,Austin,TX+78701', {
method: 'GET',
headers: {
'Authorization': `Bearer ${token}`,
'Content-Type': 'application/json'
}
})
.then(response => response.json())
.then(data => console.log(data));
3. Explore the APIs

Use our interactive API playground below to test endpoints and see responses in real-time.

Authentication

Homesage.ai uses JWT (JSON Web Token) authentication for API access. All API requests must include a valid JWT token in the Authorization header.

JWT Token Structure

Algorithm: HS256 (HMAC with SHA-256)

Token Format: Bearer YOUR_JWT_TOKEN

Header Example:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Obtaining a Token
  1. Register for a developer account at our Developer Portal
  2. Navigate to the API Keys section
  3. Generate a new JWT token
  4. Store the token securely
Keep your JWT token secure and never expose it in client-side code or public repositories.
Token Expiration

JWT tokens are valid for 30 days by default. You can configure custom expiration times in the Developer Portal. When a token expires, you'll receive a 401 Unauthorized response.

Base URL

All API requests should be made to:

https://developers.homesage.ai

Property APIs

Investment Analysis APIs

Analysis APIs

Skip Tracing APIs

Interactive API Playground

Response

            

        


        

            
API Recipes

            
Ready-to-use code examples that combine multiple API endpoints to solve real-world real estate problems. These recipes demonstrate best practices and show how to build powerful applications with Homesage.ai APIs.

            
Each recipe includes complete, working code that you can copy and use immediately in your applications.

        


        

            

                
Complete Property Analyzer
Property Analysis

                
Get a comprehensive analysis of any property including details, comparables, and investment potential.

                

                    
APIs Used

                    

                        /api/properties/info/
                        /api/properties/comps/
                        /api/properties/investment_potential/
                    

                

                

                    

                        

                            
View Implementation Code

                            
JavaScript

                        

                        

                            
JavaScript
async function analyzeProperty(address, token) {
const baseUrl = 'https://developers.homesage.ai';
const headers = { 'Authorization': `Bearer ${token}` };
try {
const propertyInfo = await fetch(`${baseUrl}/api/properties/info/?property_address=${encodeURIComponent(address)}`, { headers }).then(res => res.json());
const comps = await fetch(`${baseUrl}/api/properties/comps/?property_address=${encodeURIComponent(address)}`, { headers }).then(res => res.json());
const investment = await fetch(`${baseUrl}/api/properties/investment_potential/?property_address=${encodeURIComponent(address)}`, { headers }).then(res => res.json());
return { property: propertyInfo, comparables: comps, investment: investment };
} catch (error) { console.error('Error analyzing property:', error); throw error; }
}
const analysis = await analyzeProperty('123 Main St, Austin, TX 78701', 'YOUR_JWT_TOKEN');
console.log(analysis);

                        

                    

                

            

        


        

            

                
Investment Calculator
Financial

                
Build a flexible investment calculator that allows users to input their own financial assumptions.

                

                    
APIs Used

                    

                        /api/properties/investment_potential/
                        /api/properties/rental/long_term/
                    

                

            

        


        

            

                
House Flip Analyzer
Investment

                
Create a tool to quickly assess the viability of a house flip by combining purchase price, renovation cost estimates, and after-repair value (ARV).

                

                    
APIs Used

                    

                        /api/properties/flip_return/
                        /api/properties/renovation/cost/
                        /api/properties/comps/
                    

                

            

        


        

            

                
Rental Income Optimizer
Rental

                
Compare the potential income from long-term vs. short-term (vacation) rental strategies for a given property.

                

                    
APIs Used

                    

                        /api/properties/rental/long_term/
                        /api/properties/rental/short_term/
                    

                

            

        


        

            
Error Codes

            
Homesage.ai uses standard HTTP status codes and provides detailed error messages to help you troubleshoot issues.

            

                
Status CodeError TypeDescription

                
                    
200SuccessRequest completed successfully

                    
400Bad RequestInvalid request parameters or missing required fields

                    
401UnauthorizedInvalid or expired JWT token

                    
402Payment RequiredInsufficient credits or no subscription plan

                    
404Not FoundProperty or resource not found

                    
429Too Many RequestsRate limit exceeded

                    
500Internal Server ErrorUnexpected server error

                
            

            
Error Response Format

            
{"error": "Property not found"}

        


        

            
Rate Limits

            
API rate limits vary by plan tier to ensure fair usage and system stability.

            

                
Rate Limit Tiers

                

                    
PlanRequests/HourRequests/DayConcurrent Requests

                    
                        
Free1001,0005

                        
Starter1,00010,00010

                        
Professional5,00050,00025

                        
EnterpriseCustomCustomCustom

                    
                

                
Rate limits are enforced per API key. Contact support for higher limits.

            

        

    






    
    

    

        

            
Ready to Build with Homesage.ai?

            
Join thousands of developers using our APIs to power innovative real estate applications