Broker AVM API

Authentication

All Hometrack APIs are secured using OAuth2 via the Auth0 unified authentication platform. This page shows the steps to authenticate against a Hometrack API.

Token generation

The first step is to get the access token from the Auth0 authentication provider using an HTTP POST request sent to:

https://hometrack-prod.eu.auth0.com/oauth/token

The BODY of the request must contain the following information as a JSON document:

Client Id and Secret used to uniquely identify your subscription to the Hometrack API


{
"client_id": "abcdefghijklmnopqrstuvwxyz0123456789",
"client_secret": "abcdefghijklmnopqrstuvwxyz0123456789",
"audience": "https://api.hometrack.com",
"grant_type": "client_credentials"
}

Receiving access token from Auth0

Using the token obtained in step 2 above make a call to the API

https://api.hometrack.com/valuation/v2

Make sure to include Authorization token of type Bearer.


curl -s -H "Authorization: Bearer $access_token" \\
https://api.hometrack.com/valuation/v2/broker/valuation/{valuationId}

Data Dictionary

Data AttributeData TypeData Lookup
Full AddressStringN/A
Property TypeString
KeyMeaning
BBungalow
FFlat
HHouse
MMaisonette
OOther
PPark Home
RRoom Bedsit
Property StyleString
KeyMeaning
CMCaravan / Mobile
DTDetached
FLFlat
HBHouse Boat
RMRoom
SASheltered Accommodation
SDSemi-detached
TRTerraced Roof
Year BuiltIntegerN/A
TenureString
KeyMeaning
FHFreehold
LHLeasehold
FEFeudal
SHShared
If Flat - No. FloorsIntegerN/A
Period BuiltIntegerN/A
Ex Local Authority BooleanN/A
Wall Construction typeString
KeyMeaning
BRBrick
STStone
NTNon Traditional
TFTimber Frame
CBCob
PHPark Home
Roof TypeString
KeyMeaning
PIPitched
FLFlat
THThatched
No. BathroomsIntegerN/A
No. BedroomsIntegerN/A
No. Reception RoomsIntegerN/A
If Flat - Floor NumberIntegerN/A
Heating InfoString
KeyMeaning
MGMains Gas
ELElectric
OIOil
COCoal
BGBottled Gas
LPLPG
No. Habitable RoomsIntegerN/A
Listed StatusStringN/A
Flat Roof %ageIntegerN/A

Broker AVM API Spec