DEPLOYED Jun 15, 2020 at 10.10AM AEST

Proposed changes

Current state

All IDS APIs accept and/or return the IDS property_id as a string, with the exception of the following which expect integral values:

properties/search: returns integer IDS property_id
properties/<id>/estimates
properties/<id>/estimates/detail

Future state

All IDS APIs accept and/or return the IDS property_id as a string, including the existing exceptions which will use the string versions of their existing, integer values (now uniformly throughout the IDS API).

See Examples below.

NOTE the intention is to thereafter replace all IDS ids with new, alpha-numeric identities. Please contact IDS if you are currently persisting IDS identifiers so that we can coordinate these future changes with you.

Rationale

IDS is in the process of developing a new ETL system to improve our data matching, speed of algorithmic development, and data delivery to customers.

As part of preparing to switch over to the new ETL system, it is desired that some inconsistencies in the existing IDS API be resolved; specifically, the inconsistent type returned for property_id.

Who is impacted?

This change will impact clients who:

use validators or other specifications on the types returned from the specific APIs that type the property id as an integral value; or
store or persist the IDS property ID as an integral value.

Timeline

Development: week of Mon May 25
Deploy to SANDBOX and access given to clients by request: week of Mon June 1
- Deployed Mon June 1 10am AEST
Deploy to PROD: 10am Mon June 15 AEST

Examples

Example properties/search:

{
    "addresses": [
        [
            "5996049",    <- Changed to string
            "107 TURNER STREET ABBOTSFORD VIC 3067"
        ],
        [...

Example properties/<id>/estimates

{
  "address": "107 TURNER STREET ABBOTSFORD VIC 3067",
  "confidence": "Medium",
  "estimate_date": "2017-07-31",
  "estimate": 1049025,
  "percent_fsd": 12.4,
  "property_id": "5996049"  <- Changed to string
}

Example properties/<id>/estimates/detail

Note the change from int to string in the property_id of the requested property, as well as in the three comparable sections that follow:

{
    "property_id": "1883204",   <- Changed to string
    "address": "3 / 9 WILLIAM STREET NORTH PARRAMATTA NSW 2151",
    "location": {
        "lat": -33.7984,
        "long": 151.0065
    },
    "estimate_date": "2020-05-19",
    "confidence": "High",
    "percent_fsd": 5.7,
    "estimate": 440092,
    "estimate_high": 465316,
    "estimate_low": 414868,
    "coverage_probability_percent": 68.3,
    "property_type": "Unit",
    "landarea": 1137,
    "bedrooms": 2,
    "bathrooms": 1,
    "carparks": 2,
    "last_sale_price": 430000,
    "last_sale_date": "2019-10-19",
    "is_on_market": false,
    "list_price": 420000,
    "list_date": "2019-10-08",
    "weekly_rent": 390,
    "rent_date": "2015-10-31",
    "weekly_rent_estimate": 385,
    "percent_rent_yield_estimate": 4.56,
    "last_12_mnths_locality_data_similar_properties": {
        "sales": 72,
        "median_price": 475000,
        "high_price": 575000,
        "low_price": 417500,
        "number_similar_properties": 2914,
        "mean_percent_return": -1.5,
        "mean_percent_rental_yield": 4.3,
        "mean_days_on_market": 40,
        "percent_vendor_expectation_error": -1.8
    },
    "comparable_sales": [
        {
            "sale_id": "b3e726b459c4ece49f7e932df6b8987312ca357e",
            "address": "3 / 9 WILLIAM STREET NORTH PARRAMATTA NSW 2151",
            "location": {
                "lat": -33.7984,
                "long": 151.0065
            },
            "state": "NSW",
            "property_id": "1883204", <- Changed to string
            "sale_date": "2019-10-19",
            "sale_price": 430000,
            "landarea": 1137,
            "bedrooms": 2,
            "bathrooms": 1,
            "carparks": 2,
            "metres_from_target": 0,
            "days_on_market": 11,
            "percent_vendor_expectation_error": 2.4,
            "list_price": 420000
        }, ...
        
    ],
    "comparable_sale_listings": [
        {
            "listing_id": "f940e4e74366c62c5645ea0f6248f6a107629f59",
            "address": "2 / 13 FACTORY STREET NORTH PARRAMATTA NSW 2151",
            "state": "NSW",
            "property_id": "1103697", <- Changed to string
            "location": {
                "lat": -33.8003,
                "long": 151.0051
            },
            "list_date": "2020-04-17",
            "list_price": "$495,000 - $535,000",
            "is_auction": "0",
            "landarea": 0,
            "bedrooms": 2,
            "bathrooms": 1,
            "carparks": 1,
            "metres_from_target": 244
        }, ...
    ],
    "comparable_rental_listings": [
        {
            "listing_id": "fcdd059faefa6c6572c72b72900a019b03c29c82",
            "address": "2 / 3 WILLIAM STREET NORTH PARRAMATTA NSW 2151",
            "state": "NSW",
            "property_id": "2553702",   <- Changed to string
            "location": {
                "lat": -33.7984,
                "long": 151.0061
            },
            "list_date": "2019-12-09",
            "rental_price": 420,
            "rental_period": "WEEK",
            "landarea": 0,
            "bedrooms": 2,
            "bathrooms": 1,
            "carparks": 1,
            "metres_from_target": 40
        }, ...
    ]
}

IDS reference:https://insightdatasolutions.atlassian.net/browse/PAPI-130

Customer Support

2020-06 API v2 changes