Document toolboxDocument toolbox

AVM public service v2 Integration Guide.

Owned by Mike Thanos (Unlicensed)
Last updated: 09 Jun, 2021
2 min read

Service Metadata

Service Name

ids-public-api-v2

Model

Point-to-Point

Service State

Stateless

Service Protocol

Restful

Infrastructure Scope

public

Environments

sandbox

prod


This documentation relates to our Corporate data APIs. It does not apply to the data hosted on VM Online.

Service Description

The public facing AVM service allows the external customer to query IDS's avm service. It exposes the following key functions:

  • Search for a property using an address string or a GNAF Address PID

  • Advanced search for a property using individual address components

  • Get the details of a target property, including bedrooms, bathrooms, carparks etc. 

  • Get images of the target property.

  • Get an AVM estimate for a target property - available in simple and detailed formats

  • Retrieve a PDF AVM report, which may be branded with your organisation's logo and colour scheme.

  • Get statistics for a suburb/locality.

End Points 

  • Sandbox - https://au.insightds.com.au/v2/sandbox

  • Production - https://au.insightds.com.au/v2/prod

Service Contract 

A public version of the Service Contract is available at https://developer.ids.io.

Postman 

To assist you with integrating to the API, we make the following Postman Collection and Environment files available for download and use.

SDKs 

We can generate SDKs for a limited number of languages.  Please contact us to enquire.

Authentication Details 

You will be provided with the details to enable you to authenticate with the API when your organisation contracts with IDS.

Support

IDS maintains a customer support portal, built on top of Atlassian Support Desk.  When you contract with IDS for connection to the API, we will also setup an Organisation and Users for you in the IDS Service Desk.

Help Requests

All requests for support must be logged in the IDS Service Desk.  If you call or email us directly, we will request that you open a ticket in the IDS Service Desk.  This ensures that your issues are addressed in a timely and efficient manner, and that we maintain a history of support requests and resolutions.