API Documentation

Integrate HomeFax property intelligence into your applications with our comprehensive RESTful API.

Quick Start

Get up and running with the HomeFax API in minutes

1

Get API Key

Sign up for a developer account and obtain your API key from the dashboard.

Request API Key
2

Make First Request

Test your integration with a simple property lookup request.

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.homefax.com/v1/properties/lookup
3

Build Integration

Use our comprehensive endpoints to build powerful property intelligence features.

View All Endpoints

Authentication

Secure your API requests with Bearer token authentication

API Key Authentication

All API requests must include your API key in the Authorization header:

// Example Header
Authorization: Bearer YOUR_API_KEY_HERE
Important

Keep your API key secure and never expose it in client-side code. All requests must be made from your server.

API Endpoints

Complete reference for all available endpoints

Property Information

GET /v1/properties/lookup

Search for properties by address and get basic property information.

Parameters

address (required) - Full property address
city (optional) - City name
state (optional) - State abbreviation
zip (optional) - ZIP code

Example Response

{
  "success": true,
  "data": {
    "propertyId": "prop_123456",
    "address": "123 Main St, Springfield, IL 62701",
    "propertyType": "Single Family",
    "yearBuilt": 1995,
    "squareFootage": 2100,
    "bedrooms": 4,
    "bathrooms": 2.5
  }
}
GET /v1/properties/{propertyId}/details

Get comprehensive property details including systems, features, and history.

Parameters

propertyId (required) - Property ID from lookup
include (optional) - Comma-separated list: systems,history,market

Reports

POST /v1/reports/generate

Generate a comprehensive property report.

Request Body

{
  "propertyId": "prop_123456",
  "reportType": "comprehensive",
  "customerInfo": {
    "name": "John Doe",
    "email": "john@example.com"
  }
}
GET /v1/reports/{reportId}

Retrieve a generated report by ID.

Webhooks

POST /v1/webhooks

Register a webhook endpoint to receive real-time notifications.

Available Events

• report.completed - Report generation finished
• report.failed - Report generation failed
• property.updated - Property data updated

Rate Limits & Pricing

Fair usage policies and pricing tiers for API access

Starter

Free
  • 1,000 requests/month
  • Basic property lookup
  • Community support
  • Rate limit: 10 req/min
Get Started
POPULAR

Professional

$99/month
  • 50,000 requests/month
  • Full property details
  • Report generation
  • Email support
  • Rate limit: 100 req/min
Get Started

Enterprise

Custom
  • Unlimited requests
  • Custom integrations
  • Priority support
  • SLA guarantees
  • Custom rate limits
Contact Sales

SDKs & Tools

Official libraries and tools to accelerate your integration

JavaScript SDK

Official Node.js and browser SDK with TypeScript support

View on GitHub

Python SDK

Pythonic wrapper with async support and data validation

View on PyPI

Ruby Gem

Clean Ruby interface following Rails conventions

View on RubyGems

Postman Collection

Complete API collection for testing and documentation

Import Collection

Developer Support

Get help integrating the HomeFax API into your application