Home API Documentation Property Statistics

Property Statistics

Last updated on Dec 06, 2025

Property Statistics API

Get aggregated property counts by status for your organization. Useful for dashboards, analytics, and overview displays.

Endpoint

GET /properties/stats/counts

Authentication

Required. All API requests must be authenticated using your API key. See the Authentication section in the API Overview documentation.

Query Parameters

None. This endpoint automatically filters to your organization's properties based on your API key.

Response

Success Response (200 OK)

Returns an object with property counts for each status:

Response Fields

Field Type Description active number Number of active (live) listings pending number Number of listings awaiting approval inactive number Number of inactive listings (expired or deactivated) sold number Number of properties marked as sold rented number Number of properties marked as rented

Note: The deleted status is not included in the counts as deleted properties are excluded from statistics.

All status counts default to 0 if no properties exist for that status.

Error Responses

401 Unauthorized

Example Requests

Basic Request

Code Examples

JavaScript/TypeScript

Python

PHP

Use Cases

1. Dashboard Overview Widget

Display key metrics on your dashboard:

2. Portfolio Performance Chart

Track your portfolio over time:

3. Status Filter Navigation

Create navigation menu with counts:

4. Portfolio Health Indicator

Display warnings based on statistics:

5. Performance Report Email

Send weekly performance summaries:

6. Real-Time Status Badge

Show live status in your application header:

Tips and Best Practices

  1. Caching: Cache statistics for a few minutes to reduce API calls:

  2. Real-Time Updates: Poll this endpoint periodically for dashboard displays

  3. Combine with Search: Use stats to show counts, then fetch actual properties:

  4. Performance Metrics: Calculate derived metrics:

  5. Historical Tracking: Store stats over time to:

    • Track growth trends

    • Identify seasonal patterns

    • Measure marketing effectiveness

    • Generate performance reports

  6. Automated Alerts: Set up notifications:

  7. Organization Comparison: If you manage multiple API keys/organizations:

Response Time

This endpoint is optimized with database indexes and typically responds in under 100ms. It's safe to call frequently for real-time dashboards.

Limitations

  • Only returns counts for your organization (based on API key)

  • Excludes deleted properties from all counts

  • Returns 0 for any status with no properties

  • No date range filtering (returns current counts only)

For historical data or date-based analytics, you'll need to:

  1. Poll this endpoint periodically and store results

  2. Or use the search endpoint with date filters to calculate historical counts