GET Estimate
https://api.geowox.com/property/estimate?country_code=ie&address=<eircode|address>&floor_area=<floor_area_value_sqm>&bedrooms=<bedroom_value>
Gives insights for a specific property. Parameters accepted are:
string
country_code (required)Accepted parameters:
ie
string
address (required)EIRCODE or
Complete or partial address (e.g.
52 seagrange road
). If address is provided, the API returns the best match.
One between
integer
floor_areainteger
bedrooms
is mandatory. The presence of both increases the API success rate.
The value endpoint response contains an estimated results range.
Below a list of values returned by the API call.
Value | Description |
estimate_date | Date of estimate |
estimate_min_price | Minimum price estimated for the subject property* |
estimate_max_price | Maximum price estimated for the subject property* |
estimate_confidence_level | Estimate confidence level (low, mid, high)* |
subject property (initial eircode/address) | For the requested eircode/address, the following values will be delivered
|
*If present, the call is considered as a hit.
Example
Request
curl --request GET \
-H 'Authorization: Bearer <VERY_LONG_ACCESS_TOKEN>' \
-H 'x-api-key: <API_KEY>'
https://api.geowox.com/property/estimate?address=D09A0E0&floor_area=80
Response
{
"currency": "euro", # global setting currency
"area_measure": "sqm", # global setting metric
"date_format": "YYYY-MM-DD", # global setting date
"request_uuid": "<unique_request_id>",
"result": {
"estimate_min_price": 250,000,
"estimate_max_price": 320000,
"estimate_date": 2022-01-01,
"estimate_confidence_level": "high",
"address": "apartment 29 botanic square botanic avenue dublin 9 D09A0E0",
"property_identifier": "D09A0E0",
"location": {
"lat": 53.369604,
"lon": -6.263843
}
}
}
Status codes
Value | Reason | Message |
200 | - | - |
400 | Missing address param in the request | The address is missing or it's not in the correct format |
400 | Missing country code param in the request | The country code is missing or it's not in the correct format |
400 | Missing floor_area, bedrooms or both params in the request | One between floor_area or bedrooms must be present in the request params |
404 | No value returned for the specific input params | No value has been found |
500 | Unknown error | Unknown error |
Test Staging
Ireland
Below you can find a list of addresses to test with the staging (api.geowox.tech) API returning an estimate:
D09A0E0
D09A264
D09A2F1
D09A3V7
D09A5X2
D09A890
D09A9N4
D09A9X7
D09AE09
D09AE71
D09AH04
D09AK65
D09AK79
D09AN23
D09C2P2
D09C3F4
D09C656
D09C7R8
D09C8C2
D09C9H6
D09CX84
D09CY20