IDS logo
Documentation Powered by ReDoc

IDS Industry API (2.0.0)

Download OpenAPI specification:Download

NOTE: The Public API is for Industry customer and partner access to IDS data and analytics. VM Online Government customers and partners wishing to connect to VM Online should email support at vmonline@insightdatasolutions.com.au for further information.

Authentication

api_key

Security Scheme Type API Key
Header parameter name: x-api-key

Property search

Search for a property using the provided address query string.

Authorizations:
api_key
query Parameters
state
string

Limit the results to one or more states

Valid values: ['ACT', ‘NSW’, ‘NT’, ..]. Multiple states allowed; search will default to all states when this parameter is not passed.

address_query
required
string

Full or partial address string to be searched for.

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "addresses": [
    ]
}

Advanced property search

Search for a property using individual address fields. Particularly useful when you have already obtained the address data from Google Places API, in which case note the mappings notes on each of the query parameters.

Authorizations:
api_key
query Parameters
state
required
string

The state of the address being searched. From Google Places API, short_name of the address_components with 'administrative_area_level_1' in types.

street_full
required
string

The long form full street name including street type and street suffix. From Google Places API, long_name of the address_components with 'route' in types.

unit_number
string

The unit number of the address being searched. From Google Places API, long_name of the address_components with 'subpremise' in types.

locality
required
string

The suburb/locality of the address being searched. From Google Places API< long_name of the address_components with 'locality' in types.

postcode
required
string

The postcode of the address being searched. From Google Places API, short_name of the address_components with 'postal_code' in types.

street_number
required
string

The street number of the address being searched. From Google Places API, long_name of the address_components with 'street_number' in types.

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "gnaf_address_details_pid": "GAVIC413037720",
  • "property_id": "1ec7b7749ff17a2d",
  • "address": "2 / 28 SUTTON STREET CARLTON NORTH VIC 3054",
  • "message": "G-NAF address match and property exists."
}

GNAF Address PID based search

GNAF Address PID based search

Authorizations:
api_key
query Parameters
gnaf_pid
required
string

The GNAF Address PID for the property

Responses

Response samples

Content type
application/json
{
  • "gnaf_address_details_pid": "GAVIC421631055",
  • "property_id": "241d2173c7606762",
  • "address": "107 TURNER STREET ABBOTSFORD VIC 3067",
  • "message": "G-NAF address match and property exists."
}

Property details

Retrieve details for a specific property.

Disclaimer: APM, PSMA, and VG disclaimer

  • When displaying any licensed material the disclaimers 'IDS', 'APMCopyright', 'PSMA', and the relevant State VG disclaimer must also be displayed
Authorizations:
api_key
path Parameters
propertyId
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "property_id": "152f18c43695872d",
  • "bedrooms": 1,
  • "bathrooms": 1,
  • "landarea": 553,
  • "carparks": 1,
  • "property_type": "Unit",
  • "address": "11 / 2 BROAD STREET LABRADOR QLD 4215",
  • "state": "QLD",
  • "address_details": {
    },
  • "legal_parcel": {
    },
  • "dwelling_count": 14,
  • "parent_id": "892ea6667303bd51",
  • "months_occupancy": 8,
  • "occupancy_type": "tenanted"
}

AVM estimate

Retrieve estimated value for a specific property. Any property attribute value passed in with the request overrides the value for that attribute in the IDS property database.

Disclaimer: APM, PSMA, and VG disclaimer

  • When displaying any licensed material the disclaimers 'IDS', 'APMCopyright', 'PSMA', and the relevant State VG disclaimer must also be displayed
Authorizations:
api_key
path Parameters
propertyId
required
string

The id of the property

query Parameters
landarea
string

Land area in square meters to be used when estimating value of property, for houses only not units

bathrooms
string

Number of bathrooms to be used when estimating value of property

property_type
string

Property type to be used when estimating value of property. Valid values: [House, Unit]

date
string

The date (YYYY-MM-DD) for which the estimated value should be provided. If no date is specified then an estimate for the current date will be returned.

fetch_listing
string

true/false - Optional value to obtain current listing value for the property (Internal Use Only)

bedrooms
string

Number of bedrooms to be used when estimating value of property

carparks
string

Number of car parks to be used when estimating value of property

ignore_property_type
string

true / false - Optional value to ignore property type check when performing the estimate (Internal Use Only)

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "address": "5A COLIN PLACE CARLINGFORD NSW 2118",
  • "confidence": "Medium",
  • "estimate_date": "2020-09-07",
  • "estimate": 1227416,
  • "percent_fsd": 15.2,
  • "property_id": "ba19351c6392a0d4"
}

AVM detailed estimate

Retrieve detailed estimated value for a specific property. Any property attribute value passed in with the request overrides the value for that attribute in the IDS property database.

Disclaimer: APM, PSMA, and VG disclaimer

  • When displaying any licensed material the disclaimers 'IDS', 'APMCopyright', 'PSMA', and the relevant State VG disclaimer must also be displayed
Authorizations:
api_key
path Parameters
propertyId
required
string

The id of the property

query Parameters
max_estimate_range_percent
string

Optional value, with range 0-100; defaults to unbounded. Can only be provided when desired_coverage_probability_percent is passed. Determines the maximum range between estimate_low and estimate_high, expressed as a percentage of the estimate.

landarea
string

Land area in square meters to be used when estimating value of property, for houses only not units

bathrooms
string

Number of bathrooms to be used when estimating value of property

property_type
string

Property type to be used when estimating value of property. Valid values: [House, Unit]

date
string

The date (YYYY-MM-DD) for which the estimated value should be provided. If no date is specified then an estimate for the current date will be returned.

fetch_listing
string

true/false - Optional value to obtain current listing value for the property (Internal Use Only)

bedrooms
string

Number of bedrooms to be used when estimating value of property

carparks
string

Number of car parks to be used when estimating value of property

desired_coverage_probability_percent
string

Optional value, with range 0-99; defaults to 68.27 (ie. 1 standard deviation). The values returned for estimate_low and estimate_high will form a range for which there is a (desired) coverage_probability_percent expectation that the true value lies within this range. The returned coverage_probability_percent may differ from the desired value, due to other considerations (eg. max_estimate_range_percent).

ignore_property_type
string

true / false - Optional value to ignore property type check when performing the estimate (Internal Use Only)

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "property_id": "ade61af5328922e8",
  • "address": "107 TURNER ROAD BEROWRA HEIGHTS NSW 2082",
  • "location": {
    },
  • "estimate_date": "2020-09-07",
  • "confidence": "Medium",
  • "percent_fsd": 15.2,
  • "estimate": 975798,
  • "estimate_high": 1122782,
  • "estimate_low": 828814,
  • "coverage_probability_percent": 68.3,
  • "property_type": "House",
  • "landarea": 829,
  • "bedrooms": 3,
  • "bathrooms": 2,
  • "carparks": 1,
  • "last_sale_price": 1050000,
  • "last_sale_date": "2017-11-18",
  • "is_on_market": false,
  • "list_price": 1150000,
  • "list_date": "2017-08-02",
  • "weekly_rent": null,
  • "rent_date": null,
  • "weekly_rent_estimate": 620,
  • "percent_rent_yield_estimate": 3.31,
  • "last_12_mnths_locality_data_similar_properties": {
    },
  • "comparable_sales": [
    ],
  • "comparable_sale_listings": [
    ],
  • "comparable_rental_listings": [
    ]
}

AVM report

Retrieve AVM report for a specific property, with optional estimate date and property attributes. Any property attribute value passed in with the request overrides the value for that attribute in the IDS property database.

Authorizations:
api_key
path Parameters
propertyId
required
string

The id of the property

query Parameters
landarea
string

Land area in square meters to be used when estimating value of property, for houses only not units.

bathrooms
string

Number of bathrooms to be used when estimating value of property.

response_format
required
string

Format the requestor wants the report returned in. Currently supports only 'json' in which case a json formatted URL to the PDF will be returned

property_type
string

Property type to be used when estimating value of property. Valid values: [House, Unit]

date
string

The date (YYYY-MM-DD) for which the estimated value should be provided. If no date is specified then an estimate for the current date will be returned.

bedrooms
string

Number of bedrooms to be used when estimating value of property.

carparks
string

Number of carparks to be used when estimating value of property.

fields
string

Top level fields to be returned in the payload.

client_reference
string

The client reference for the valuation transaction.

client_estimate
string

The client estimate for the property such as the purchase price or owner's estimate.

integer_fsd
string

The indication if fsd has to be returned as integer Valid values: [0, 1]. Defaulted to 0

show_fsd_sentence
string

The indication if clients wants to remove fsd sentence from generated report Valid values: [0, 1]. Defaulted to 1

header Parameters
x-api-key
required
string

Responses

Response samples

Property images

Returns an array of images, with the following fields for each image:

  • url - URL to retrieve the image
  • date - date that the image was created
  • rank - the order from low to high in which the images can be displayed, use this to make sure you don't show a picture of the bathroom as the primary image
Authorizations:
api_key
path Parameters
propertyId
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{}

Property listings

Retrieve the list of historical listings for a specific property.

Authorizations:
api_key
path Parameters
propertyId
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Property sales

Retrieve the list of historical sales for a specific property.

Disclaimer: APM, PSMA, and VG disclaimer

  • When displaying any licensed material the disclaimers 'IDS', 'APMCopyright', 'PSMA', and the relevant State VG disclaimer must also be displayed
Authorizations:
api_key
path Parameters
propertyId
required
string
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Indices and Statistics

Returns a time series for the requests statistic

Path Parameters:

  • interval: must be one of [monthly, quarterly]

  • region: must be one of [sa3, sa4, city, locality, postcode, lga]

Restrictions:

  • Maximum requestable datapoints allowed: 10,000

Disclaimer: APM, PSMA, and VG disclaimer

  • When displaying any licensed material the disclaimers 'IDS', 'APMCopyright', 'PSMA', and the relevant State VG disclaimer must also be displayed
Authorizations:
api_key
path Parameters
region
required
string

One of [sa3, sa4, city, locality, postcode, lga]

interval
required
string

One of [monthly, quarterly]

query Parameters
start
required
string

Start of time series.

Note: will automatically be truncated to start of interval e.g. 2018-03-17 will be interpreted as 2018-03-01 when interval is monthly

Format: YYYY-MM-DD

Restrictions:

  • Value cannot be prior to 1985-01-01
end
required
string

End of time series.

Note: will automatically be truncated to end of interval e.g. 2018-03-17 will be interpreted as 2018-03-31 when interval is monthly

Format: YYYY-MM-DD

Restrictions:

  • Timespan from start to end cannot exceed 50 years
property_type
required
string

Property Type

Valid values: ['house', 'unit', 'dwelling']

Multiple property_type parameters allowed

stat
required
string

Statistics requested

Valid values: ['tom', 'price', 'vee', 'yields', 'rents', 'salecounts', 'marketscore']

Multiple stat parameters allowed

level
required
string

Region level

Valid values vary depending on region chosen e.g. for region=City ['Syd', 'Mel', ..]

Multiple level parameters allowed

Restrictions:

  • Maximum levels per query: 10
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "interval": "monthly",
  • "dates": [
    ],
  • "house": {
    },
  • "unit": {
    }
}

Suburb summary statistics

Returns summary statistics for a suburb in the previous 12 months for the type of property (house or unit) and number of bedrooms passed in with the call.

Disclaimer: APM, PSMA, and VG disclaimer

  • When displaying any licensed material the disclaimers 'IDS', 'APMCopyright', 'PSMA', and the relevant State VG disclaimer must also be displayed
Authorizations:
api_key
query Parameters
property_type
required
string

House or unit

suburb
required
string

Name of the suburb

bedrooms
string

Number of bedrooms

postcode
required
string

Postcode of the suburb

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "locality_id": "NSW3029",
  • "locality": "NORTH PARRAMATTA",
  • "postcode": "2151",
  • "state": "NSW",
  • "location": {
    },
  • "last_12_mnths_locality_data_similar_properties": {
    }
}

Disclaimers

List of disclaimers. All product that require disclaimers must include the 'IDS', 'APMCopyright', 'PSMA', and the relevant State VG disclaimers.

Authorizations:
api_key
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]