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 Attribute | Data Type | Data Lookup |
|---|
| Full Address | String | N/A |
| Property Type | String | | Key | Meaning | | B | Bungalow | | F | Flat | | H | House | | M | Maisonette | | O | Other | | P | Park Home | | R | Room Bedsit |
|
| Property Style | String | | Key | Meaning | | CM | Caravan / Mobile | | DT | Detached | | FL | Flat | | HB | House Boat | | RM | Room | | SA | Sheltered Accommodation | | SD | Semi-detached | | TR | Terraced Roof |
|
| Year Built | Integer | N/A |
| Tenure | String | | Key | Meaning | | FH | Freehold | | LH | Leasehold | | FE | Feudal | | SH | Shared |
|
| If Flat - No. Floors | Integer | N/A |
| Period Built | Integer | N/A |
| Ex Local Authority | Boolean | N/A |
| Wall Construction type | String | | Key | Meaning | | BR | Brick | | ST | Stone | | NT | Non Traditional | | TF | Timber Frame | | CB | Cob | | PH | Park Home |
|
| Roof Type | String | | Key | Meaning | | PI | Pitched | | FL | Flat | | TH | Thatched |
|
| No. Bathrooms | Integer | N/A |
| No. Bedrooms | Integer | N/A |
| No. Reception Rooms | Integer | N/A |
| If Flat - Floor Number | Integer | N/A |
| Heating Info | String | | Key | Meaning | | MG | Mains Gas | | EL | Electric | | OI | Oil | | CO | Coal | | BG | Bottled Gas | | LP | LPG |
|
| No. Habitable Rooms | Integer | N/A |
| Listed Status | String | N/A |
| Flat Roof %age | Integer | N/A |
Broker AVM API Spec