New Feature

Date Filtering for Property Details

We’ve added optional date filtering to the GET /property/{id} endpoint, allowing you to filter units, history, availability periods, and concessions based on a date range.

New Query Parameters:

  • from (optional): Filter results to include only data that overlaps with dates on or after this date (ISO 8601 format, e.g., “2024-01-01”)
  • to (optional): Filter results to include only data that overlaps with dates on or before this date (ISO 8601 format, e.g., “2024-12-31”)

What Gets Filtered:

  • Units: Filtered based on enter_market and exit_market dates
  • History: Filtered based on from_date and to_date of each history entry
  • Availability Periods: Filtered based on enter_market and exit_market dates
  • Concessions: Filtered based on from_date and to_date of each concession

Usage: You can provide either date, both dates, or neither. When dates are provided, only data that overlaps with the specified date range will be included in the response.

Example Requests:

$# Filter to data from January 2024 onwards
>GET /property/{id}?from=2024-01-01
>
># Filter to data up to December 2024
>GET /property/{id}?to=2024-12-31
>
># Filter to data within a specific date range
>GET /property/{id}?from=2024-01-01&to=2024-12-31
>
># No filtering (returns all data)
>GET /property/{id}

This feature is particularly useful when you need to analyze property data for a specific time period or when generating reports for a particular date range.