Skip to content

RealEstateApi/docs

Repository files navigation

RealEstateAPI Documentation

Welcome to the official documentation repository for RealEstateAPI.com, the comprehensive real estate data API platform.

Overview

RealEstateAPI provides developers with access to extensive real estate data including:

  • Property search and details
  • MLS listings
  • Property valuations (AVM)
  • Demographics and mapping
  • Skip tracing
  • Address verification
  • And much more

This repository contains comprehensive documentation, code examples, and integration guides to help you build powerful real estate applications.

Quick Start

  1. Sign up for an API key at RealEstateAPI.com
  2. Review the Getting Started Guide
  3. Review the Authentication Guide
  4. Connect to our MCP Server MCP Connection Guide
  5. Check out Code Examples
  6. Explore our API Reference

Documentation Structure

This documentation site is organized into three main sections:

📚 API Reference (reference/)

Complete API documentation organized by service category:

  • AI APIs - PropGPT natural language search and feedback
  • Address Standardization APIs - Address verification and autocomplete
  • MLS APIs - Multiple listing service search and property details
  • Mapping APIs - Property boundaries and mapping pins
  • Property APIs - Property search, details, and CSV generation
  • Property Portfolio APIs - Saved searches and portfolio management
  • Skiptrace APIs - Contact information and bulk skip tracing
  • Utility APIs - Usage tracking and account management
  • Valuation APIs - Property valuations and comparable analysis
  • Docs - Platform documentation including integrations and changelog
  • ODATA - How to use and access our ODATA endpoint for property search
  • Response Schemas - Response schema modles and types for each API

🍳 Code Examples (recipes/)

Practical code examples and tutorials:

  • Property search and detail examples
  • Skip tracing implementations
  • Bulk processing examples
  • Polygon search tutorials
  • Server-side integration examples

🚀 Getting Started (docs/Documentation/)

Essential documentation for new developers:

  • API specifications and standards
  • Authentication setup
  • Cross-origin resource sharing (CORS)
  • API key management
  • Introduction and overview

Key Features

🤖 AI-Powered Search

  • PropGPT - Natural language property search using GPT/LLM technology
  • Plain English queries: "Find 3-bedroom homes in Austin under $500k with pools"
  • AI-powered property insights and market analysis
  • Multiple LLM model support (GPT-4, GPT-3.5, Claude-3)

🏠 Comprehensive Property Data

  • Access to millions of property records nationwide
  • Real-time MLS listings with agent information
  • Complete property details with ownership and tax history
  • Historical sales data and mortgage information

🔍 Advanced Search Capabilities

  • Compound Queries - Complex Boolean logic with nested conditions
  • Specialized Modes - ids_only, count, summary_stats for optimization
  • Absentee owner, foreclosure, and equity-based searches
  • Multi-polygon and radius searches with exclusions
  • Investment-focused filters (cap rates, cash flow, ROI)

💼 Portfolio Management

  • Saved Searches - Create and manage property search criteria
  • Real-time alerts and monitoring
  • Search analytics and performance tracking
  • Team collaboration and sharing

🗺️ Mapping & Geographic Data

  • Property Boundaries - Detailed parcel boundaries in GeoJSON
  • Mapping Pins API - Unlimited pin locations for map applications
  • Area analysis with demographics and market insights
  • Zoning information and flood zone data

📍 Address Intelligence

  • AutoComplete API - Free unlimited ML-powered address suggestions
  • Address verification and standardization
  • Geocoding with confidence scoring
  • Multiple completion types (city, county, neighborhood, ZIP, APN)

🕵️ Skip Trace & Research

  • Property owner contact information
  • Bulk skip tracing with webhook processing
  • Reverse phone, email, and name searches
  • Compliance tools for FCRA/TCPA requirements

📊 Valuations & Analytics

  • Lender-Grade AVM - Professional property valuations
  • Comparable property analysis with custom parameters
  • Rental estimates with investment metrics
  • Market demographics and trend analysis
  • New construction forecast valuations (ARV)

🔌 Integrations & Automation

  • Zapier - 100+ pre-built integrations
  • CRM connectors (Salesforce, HubSpot, Zoho, Podio)
  • Webhook support for real-time updates
  • CSV exports and bulk data processing

Support

License

This documentation is provided to support developers using RealEstateAPI. The API itself is subject to the terms of service at realestateapi.com/terms.

About

No description, website, or topics provided.

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages