Home API Documentation Getting Started with the API

Getting Started with the API

Last updated on Dec 06, 2025

Welcome to the LeadHQL API documentation! This guide will help you integrate LeadHQL's property listing services into your applications.

Quick Start

  1. Get Your API Key: Visit https://www.leadhql.com/dashboard/property-listings/settings

  2. Read the Overview: Start with the API Overview documentation

  3. Explore Endpoints: Check out the endpoint documentation below

  4. Start Building: Use our code examples to get started quickly

Documentation Structure

Core Documentation

  • API Overview - Start here! Authentication, rate limits, and general information

  • Authentication Guide - How to authenticate your requests

  • Data Types & Enums - Reference for all property types and statuses

API Endpoints

Read Operations

POST /properties/search Search and filter properties with natural language queries, structured filters, and geospatial search

GET /properties/:id Get detailed information about a specific property

GET /properties/:id/similar Find properties similar to a specific property

GET /properties/stats/counts Get property statistics and counts by status

Write Operations

Write operations are available for managing your organization's properties. Contact support for full documentation on creating, updating, and deleting properties.

Common Use Cases

1. Display Properties on Your Website

2. Build a Property Search Tool

3. Property Detail Pages with Recommendations

4. Portfolio Dashboard

API Features

🔍 Powerful Search

  • Natural language queries

  • Structured filters (price, bedrooms, features)

  • Geospatial search (location radius or bounding box)

  • Full-text search across all property fields

🏷️ Rich Property Data

  • Comprehensive property details

  • Multiple images with thumbnails

  • Agent information

  • Organization branding

  • Ad creative data

  • Multilingual descriptions

📊 Analytics & Statistics

  • Property counts by status

  • Price distribution histograms

  • Portfolio overview metrics

🎯 Smart Recommendations

  • Similar property suggestions

  • Automatic matching based on type, location, and price

  • Configurable result limits

🔐 Secure & Scalable

  • API key authentication

  • Rate limiting for fair usage

  • Organization-scoped access control

  • High availability infrastructure

Base URL

Authentication

All requests require an API key. You can provide it in three ways:

Option 1: Authorization header (recommended)

Option 2: X-API-Key header

Option 3: Query parameter

Rate Limits

  • 20 requests per minute

  • 100 requests per 10 minutes

  • 500 requests per hour

Response Format

All responses are in JSON format:

Errors include:

Code Examples

We provide code examples in multiple languages:

  • JavaScript/TypeScript - For web applications and Node.js

  • Python - For backend services and data processing

  • PHP - For WordPress and traditional web applications

All examples are included in the endpoint documentation.

Support & Resources

Getting Help

  • Documentation: You're reading it! Explore the links above

  • Support: Contact [email protected]

What's Next?

  1. ✅ Generate your API key

  2. 📖 Read the API Overview documentation

  3. 🔨 Try the Search Properties endpoint

  4. 🚀 Build your integration!

Feedback

We're always improving our API. If you have suggestions or found an issue, please let us know:

Happy Building! 🏗️

If you build something cool with our API, we'd love to hear about it!