GET Details
https://api.geowox.com/property/details?country_code=ie&address=<eircode|address>
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.
The value endpoint response contains details of a specific property.
Below a list of values returned by the API call.
Value | Description |
property_type_name | Property type (e.g. “detached”) |
floor_area_value floor_area_info (if available) | Floor area.
|
bedroom_value bedroom_info (if available) | Number of bedrooms
|
bathroom_value | Number of bathrooms |
lot_area_value | Lot area |
storeys_value | Number of storey |
energy_rating_class | BER (e.g. A1) |
year_built_value | Build year (e.g. 1990) |
location | Latitude and longitude |
property_identifier | The internal identifier of the property based on the country. For Ireland, it's the EIRCODE. |
*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/details?address=D09A0E0&floor_area=121
Response
{"currency": "EUR",
"area_measure": "sqm",
"date_format": "YYYY-MM-DD",
"request_uuid": "53760e60-b114-11ec-a2c5-1ef5b3f0c0d8",
"result": {"address": "apartment 29 botanic square botanic avenue dublin 9 D09A0E0",
"property_identifier": "D09A0E0",
"property_type_name": "apartment",
"floor_area_value": 121.0,
"floor_area_info": "inferred",
"bedroom_value": 2,
"bedroom_info": null,
"bathroom_value": 1,
"lot_area_value": null,
"year_built_value": 1970,
"storey_value": 1,
"energy_rating_class": null,
"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 |
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:
D09VE06
D09K5W7
D09KD00
D09Y0E6
D09X3C4
D09X0C0
D09NT78
D09WE29
D09A0E0
D09A264
D09A2F1
D09A3V7
D09A5X2
D09A890
D09A9N4
D09A9X7
D09AE09
D09AE71
D09AH04
D09AK65
D09AK79
D09AN23
D09C2P2
D09C3F4
D09C656
D09C7R8
D09C8C2
D09C9H6
D09CX84
D09CY20