Changelog

Deprecation: Quality Score

The /qualityscore/* computer vision endpoints are now deprecated. These models have been outdated for some time, and usage has been minimal. We’re focusing our efforts on more impactful and widely used features. Quality score insights will continue to be available in the property details payload.

These endpoints will continue to function for now, but we plan to remove them on Jan 1st 2026. If you rely on them, we recommend transitioning to the quality analysis available on property details payload as soon as possible.

New Feature

Async Dataset Export with Webhook Notifications

• Introduced /dataset/export endpoint for asynchronous dataset exports with webhook delivery
• Perfect for large datasets that would timeout with synchronous requests
• Supports both CSV and JSONL output formats with gzip compression
• HMAC signature verification ensures webhook authenticity using your API key
• Download URLs are valid for 30 days from export completion
• Requires Query Builder subscription for full access

Key Benefits:

• Process large datasets without timeout constraints
• Integrate with automated data pipelines and workflows
• Receive results asynchronously via secure webhook notifications
• Track exports using unique query UUIDs for request/response matching

Example Request:

1
{
2
  "dataset": {
3
    "scopes": [
4
      {"column": "street_address"},
5
      {"column": "asking_rent", "aggregate": "Avg"}
6
    ],
7
    "filters": [
8
      {"column": "msa", "filter": {"equals": "Seattle, WA"}},
9
      {"column": "bed", "filter": {"in": [1, 2, 3]}}
10
    ],
11
    "limit": 10000
12
  },
13
  "webhookURL": "https://yourapp.com/webhook/dataset-export",
14
  "name": "Seattle Rental Data Export",
15
  "format": "csv"
16
}

Webhook Response:

1
{
2
  "queryUUID": "123e4567-e89b-12d3-a456-426614174000",
3
  "name": "Seattle Rental Data Export",
4
  "format": "csv",
5
  "gcsBlob": {
6
    "url": "https://storage.googleapis.com/...",
7
    "expires": "2024-07-26T10:30:00Z",
8
    "timeTakenMs": 45000,
9
    "numberRows": 12847
10
  },
11
  "hmacSignature": "a1b2c3d4...",
12
  "requestedOn": "2024-06-26T10:00:00Z",
13
  "completedOn": "2024-06-26T10:00:45Z"
14
}

See our Dataset Webhook Export Guide for complete implementation details and webhook handler examples.

Improvement

Added id_alias to search

Use the property id in the query of /property/search?q=. See all alias ids that map to the primary id to help dedupe when primary IDs change

Improvement

Enhanced Regional Report Filters

• Added comprehensive unit mix filtering capabilities to regional reports
• Filter by unit count, square footage, rent, and rent per square foot for:
  • Overall property metrics
  • Individual unit types (studio, 1BR, 2BR, 3BR, 4BR)
• Each filter supports:
  • Minimum and maximum values
  • Optional inclusion of properties with null values
• Example: Filter for properties where 2BR units average between 800-1000 sqft and rent for $2000-2500 per month

Example Payloads:

1
{
2
  "filters": {
3
    "unit_mix": {
4
      "overall": {
5
        "rent_per_sqft": {
6
          "min": 2.5,
7
          "max": 3.5,
8
        }
9
      },
10
    }
11
  }
12
}

You can also filter by specific unit types:

1
{
2
  "filters": {
3
    "unit_mix": {
4
      "studio": {
5
        "number_units": {
6
            "min": 10
7
        },
8
        "rent": {
9
          "max": 1500
10
        }
11
      },
12
      "one_bedroom": {
13
        "number_units": {
14
            "min": 10
15
        },
16
        "sqft": {
17
          "min": 600
18
        }
19
      }
20
    }
21
  }
22
}

Improvement

Visual banner concession detection

• We’ve enhanced our system to detect concessions that are advertised in images and visual banners
• No data schema changes required - newly detected concessions will appear in the existing data structure
• This improvement increases concession coverage by capturing previously missed promotional content

Improvement

Lesser Quality

• The renovations field on the comparables endpoint now accepts negative values, to let you look for properties with lesser quality.
• The full range of the slider is now -1.0 to 1.0.
• For example, a renovations value of -0.3 will maximize the quality similarity between the subject and the comps for comps that are 30% worse than the subject.

New Feature

Google Reviews

• The review_analysis field on the PropertyDetailsResponse object is now factoring in Google Reviews.

New Feature

Market Search

• Added allow_null to the year_built, number_units and number_stories filters in the /market/search endpoint.
• Added is_student, is_senior, is_affordable as three additional filters to the /market/search endpoint

New Feature

Lease Up

Added is_lease_up to the property responses. This indicates that the building was recently built, and it is assumed that the developers are only showing a small number of their available units because they are still trying to fill their spaces. See is_lease_up on the Property Response for more information on how a building meets this condition.

Deprecations

• Deprecated tier parameter from the /property/comparables endpoint. Use renovations instead. This offers more flexibility by allowing you to specify a renovation score between 0 and 1 to boost the quality score of the subject property.

New Feature

New Comparables Filters

• Added filters to the /property/comparables endpoint to allow you to filter by is_affordable, is_senior, and is_student. You can set them to true, false or undefined to include, exclude or be indifferent to properties that match these criteria.