Home API Documentation API Overview

API Overview

Last updated on Dec 06, 2025

LeadHQL Properties API Documentation

Welcome to the LeadHQL Properties API! This API allows you to integrate property listings from LeadHQL into your own applications, websites, and services.

Base URL

https://api.leadhql.com

Getting Started

1. Generate Your API Key

  1. Navigate to https://www.leadhql.com/dashboard/property-listings/settings

  2. Click the blue "Create new key" button

  3. Give your API key a descriptive name (only visible to you)

  4. Copy the generated API key immediately - it will only be shown once

Important Notes:

  • Store your API key securely

  • If you lose your API key, you can always generate a new one

  • You can manage and delete unused API keys from the settings page

  • Each API key is scoped to your organization's properties

2. Authentication

All API requests must be authenticated using your API key. You can provide your API key in one of three ways:

Option 1: Authorization Header (Recommended)

Option 2: X-API-Key Header

Option 3: Query Parameter

Available Endpoints

Read Operations (Publicly Accessible)

Endpoint Method Description /properties/search POST Search and filter properties /properties/:id GET Get details of a specific property /properties/:id/similar GET Find properties similar to a specific property /properties/stats/counts GET Get property counts by status /properties/:id/ad-creatives GET Get ad creatives for a property

Write Operations (Organization-Scoped)

Endpoint Method Description /properties POST Create a new property listing /properties/:id PUT Update an existing property /properties/:id DELETE Delete a property listing /properties/:id/renew PUT Renew a property listing (extends expiration by 2 months) /properties/expiring/soon GET Get properties expiring within a specified number of days

Query Parameters

Many endpoints support optional query parameters to customize the response:

Parameter Type Description Default filterByOrganization boolean Filter results to only your organization's properties false includeBranding boolean Include organization branding information in response false includeAdCount boolean Include count of active ads for each property false includeAdCreatives boolean Include ad creative details (up to 3 most recent) false

Example Usage

Response Format

All responses are returned in JSON format with the following structure:

Success Response

Error Response

Rate Limiting

The API implements rate limiting to ensure fair usage:

  • Short-term: 20 requests per minute

  • Medium-term: 100 requests per 10 minutes

  • Long-term: 500 requests per hour

If you exceed these limits, you'll receive a 429 Too Many Requests response.

Data Types and Enums

Listing Status

  • active - Property is live and available

  • inactive - Property is not currently active

  • pending - Property is awaiting approval

  • sold - Property has been sold

  • rented - Property has been rented

  • deleted - Property has been deleted

Listing Type

  • sale - Property for sale

  • rent - Property for rent

  • sale_or_rent - Property available for either

Property Category

  • residential - Residential properties

  • commercial - Commercial properties

  • industrial - Industrial properties

  • land - Land plots

Property Type

Residential:

  • apartment, condominium, house_detached, house_semi_detached, house_terraced, townhouse, multi_family_home, penthouse, studio

Land:

  • land_residential, land_commercial, land_agricultural, land_other

Commercial:

  • office, retail, commercial_other

Industrial:

  • industrial_warehouse, industrial_other

Other:

  • hospitality, other

Example Integration Scenarios

1. Display Your Properties on Your Website

Filter by your organization and include branding to show only your listings with your company information.

2. Property Search Widget

Implement a search interface that allows visitors to find properties based on location, price, bedrooms, etc.

3. Property Comparison Tool

Fetch similar properties and allow users to compare features, prices, and amenities.

4. Automated Property Syndication

Automatically sync your properties to multiple listing platforms.

Need Help?

For detailed endpoint documentation, explore:

  • Search Properties API - Search and filter properties

  • Get Property Details API - Get detailed property information

  • Similar Properties API - Find similar property recommendations

  • Property Statistics API - Get property counts and statistics

For support, contact our support team through the LeadHQL dashboard.