GetHouseSurvey APIgethousesurvey.ie ↗
Place a Planning Search order on GetHouseSurvey.ie via API. Returns price breakdown, customer details, property data, and a checkout URL to complete payment.
What is the GetHouseSurvey API?
The GetHouseSurvey.ie API exposes 1 endpoint — order_planning_search — that submits a Standard Planning Search order for an Irish property and returns 8 structured response fields including a full price breakdown (net, VAT, total in EUR), customer and property objects, and the checkout URL where payment is completed. The search covers PRA folio, Names Index, Mapping, and Registry of Deeds searches.
curl -X POST 'https://api.parse.bot/scraper/cb0b32e9-0579-4177-86e2-d69d5dd9725b/order_planning_search' \
-H 'X-API-Key: $PARSE_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"town": "Carrigaline",
"county": "Cork",
"eircode": "P43AB12",
"last_name": "Doe",
"first_name": "John",
"folio_number": "CK12345F",
"street_address": "123 Main St"
}'Typed, relational, agent-ready
A generated client with real types, enums, and the links between objects — the structure a flat JSON response can't carry. Autocompletes in your editor and reads cleanly to coding agents.
- Fully typed · autocompletes
- Objects link to objects
- Typed errors & pagination
Typed Python client. Set up the SDK in your uv project, then pull this API’s typed client:
uv add parse-sdk uv run parse init uv run parse add --marketplace gethousesurvey-ie-api
uv run parse add --marketplace pulls a pinned snapshot of this canonical API — it won’t change underneath you. To customize it, subscribe and swap to your own copy.
"""Walkthrough: place a Planning Search order on GetHouseSurvey.ie."""
from parse_apis.gethousesurvey_ie_api import GetHouseSurvey, County, InputFormatInvalid
client = GetHouseSurvey()
# Submit a planning search order for a property in Cork.
try:
order = client.orders.create(
first_name="Jane",
last_name="Doe",
email="[email protected]",
phone="+1 (555) 012-3456",
street_address="123 Main St",
town="Springfield",
county=County.CORK,
eircode="P43AB12",
folio_number="CK12345F",
)
except InputFormatInvalid as e:
print("Validation error:", e.message)
raise
# Inspect the returned order confirmation.
print("Submitted:", order.submitted)
print("Search type:", order.search_type)
print("Payment required:", order.payment_required)
# Read the price breakdown.
print(f"Net: {order.price.net} {order.price.currency}")
print(f"VAT ({order.price.vat_rate_percent}%): {order.price.vat}")
print(f"Total: {order.price.total} {order.price.currency}")
# Customer and property echoed back from the site.
print(f"Customer: {order.customer.first_name} {order.customer.last_name}")
print(f"Property: {order.property.street_address}, {order.property.town}, {order.property.county}")
# Proceed to payment via the checkout URL.
print("Checkout:", order.checkout_url)
print("exercised: orders.create")Submits a Planning Search order request to GetHouseSurvey.ie for one property. The request is recorded with the company (the fixed 'Standard' planning search, priced at EUR 299 including 23% VAT at the time of writing) and the response returns the submitted customer and property details, the price breakdown read from the site's checkout summary (net, VAT, total, currency), and the checkout_url on the site where the caller completes card payment; the order is not paid or started until payment is completed on that page. Every call places a new order request, so call it once per intended order. Required contact and property fields that are missing, an email that is not a valid address, or a county outside the Irish county / Dublin postal district list are rejected with a 422 before anything is sent; a submission the site itself rejects (for example an email domain it refuses) also returns 422 with the site's reason. There is no file-upload support for the optional Ordnance Survey map.
| Param | Type | Description |
|---|---|---|
| townrequired | string | Town of the property to be searched. |
| emailrequired | string | Customer's email address; the checkout and report are sent here. |
| phonerequired | string | Customer's contact phone number, e.g. 0870000000. |
| countyrequired | string | County of the property, or its Dublin postal district (case-insensitive). |
| eircoderequired | string | Eircode of the property, e.g. P43AB12. |
| last_namerequired | string | Customer's last name. |
| first_namerequired | string | Customer's first name. |
| folio_numberrequired | string | Property PRAI / Land Registry folio number(s), e.g. CK12345F; several may be given separated by commas. |
| street_addressrequired | string | Street address of the property to be searched. |
{
"type": "object",
"fields": {
"price": "object: net and vat and total in EUR as numbers, vat_rate_percent, currency code, read from the site's checkout summary",
"customer": "object with the submitted first_name, last_name, email, phone",
"property": "object with the submitted street_address, town, county, eircode, folio_number",
"submitted": "boolean, true when the site accepted the order request",
"search_type": "planning search product ordered (always Standard)",
"checkout_url": "site page where the caller completes payment for this order",
"payment_required": "boolean, true: the order is only processed once paid on checkout_url",
"confirmation_message": "text the site returns on acceptance; empty string when it returns none (observed empty)"
},
"sample": {
"data": {
"price": {
"net": 243.09,
"vat": 55.91,
"total": 299,
"currency": "EUR",
"vat_rate_percent": 23
},
"customer": {
"email": "[email protected]",
"phone": "+1 (555) 012-3456",
"last_name": "Doe",
"first_name": "John"
},
"property": {
"town": "Carrigaline",
"county": "Cork",
"eircode": "P43AB12",
"folio_number": "CK12345F",
"street_address": "123 Main St"
},
"submitted": true,
"search_type": "Standard",
"checkout_url": "https://form.gethousesurvey.ie/planning-search-checkout?firstname=John&lastname=Doe&email=user%40example.com&property_street_address=123+Main+St&property_town=Carrigaline&property_county=Cork",
"payment_required": true,
"confirmation_message": ""
},
"status": "success"
}
}About the GetHouseSurvey API
What the API Does
The order_planning_search endpoint registers a Standard Planning Search order with GetHouseSurvey.ie for a single Irish property. You supply the customer's contact details (first_name, last_name, email, phone) and the property identifiers (town, county, eircode, folio_number). The API records the order and returns everything needed to hand the customer off to payment.
Response Fields
The response includes a price object with net, vat, total as numeric EUR amounts plus vat_rate_percent and currency. A customer object echoes back the submitted contact details; a property object echoes the submitted address, eircode, and folio number(s). The checkout_url field is the page where the customer completes payment — the payment_required boolean confirms the order is not processed until that payment step is done. search_type is always Standard for this product tier. submitted is true when the site accepted the request, and confirmation_message carries any acceptance text returned (observed as empty string in practice).
Input Notes
The folio_number field accepts multiple PRAI/Land Registry folio numbers separated by commas (e.g. CK12345F, CK12346F), which is useful for properties with more than one registered folio. county accepts Dublin postal districts as well as county names and is case-insensitive. eircode should follow the standard seven-character Irish format (e.g. P43AB12).
Coverage Scope
The API covers the single Standard Planning Search product offered at gethousesurvey.ie/planning-searches. It does not expose additional survey products such as building surveys, valuations, or snag lists that may appear elsewhere on the site. The endpoint is suited to conveyancing workflows, property due-diligence pipelines, or platforms that need to initiate Irish title and planning searches programmatically.
The GetHouseSurvey API is a managed, monitored endpoint for gethousesurvey.ie — not a raw scraper you maintain. Every endpoint is automatically health-checked on a schedule, and when gethousesurvey.ie changes and a check fails, the API is automatically queued for repair and re-verified. It is built to keep working as the site underneath it changes.
This isn't an official gethousesurvey.ie API — it's an independent, maintained REST wrapper over public data. Where the source has no official API (or only a limited one), Parse gives you a stable contract over a source that never promised one, and keeps it current. Need a new endpoint or field? You can revise it yourself in plain English and the agent rebuilds it against the live site in minutes — contributing the change back to the shared API is free.
Will this API break when the source site changes?+
Is this an official API from the source site?+
Can I fix or extend this API myself if I need a new endpoint or field?+
What happens if I call an endpoint that has an issue?+
- Automate Planning Search orders inside a conveyancing case management system using the
folio_numberandeircodealready on file. - Embed an Irish planning search order form in a property platform and surface the returned
pricebreakdown to the end user before redirecting tocheckout_url. - Batch-submit Planning Search orders for a portfolio of properties by iterating over folio numbers and collecting a
checkout_urlper property. - Trigger a planning search order automatically when a sale-agreed status is set in a CRM, using the
emailfield to route the checkout link to the relevant solicitor. - Display the VAT-inclusive total from the
priceobject in a client-facing quote before order confirmation. - Log
submittedandconfirmation_messagevalues per order for audit trail purposes in a property transaction workflow.
| Tier | Price | Credits/month | Rate limit |
|---|---|---|---|
| Free | $0/mo | 200 | 5 req/min |
| Hobby | $30/mo | 1,000 | 20 req/min |
| Developer | $100/mo | 5,000 | 100 req/min |
| Team | $300/mo | 20,000 | 300 req/min |
| Company | $1,000/mo | 100,000 | 500 req/min |
Each endpoint has a fixed posted price per successful call — most fall between 1 and 10 credits — shown on this API's page before you run it. Exceeding the rate limit returns a 429 response. Authenticate with the X-API-Key header.
Does GetHouseSurvey.ie have an official developer API?+
What does the `order_planning_search` endpoint actually return after submission?+
price object (net, VAT, total in EUR, VAT rate, currency), customer and property objects echoing submitted details, a checkout_url where payment is completed, a payment_required boolean (always true — the order is only processed after payment), a search_type string (always 'Standard'), a submitted boolean, and a confirmation_message string (observed empty in practice).Can I retrieve the completed Planning Search report document through this API?+
Does the API support ordering products other than the Standard Planning Search, such as building surveys or valuations?+
What folio number format is expected, and can multiple folios be submitted for one property?+
CK12345F. The folio_number input accepts multiple values separated by commas, so a property with more than one registered folio can be covered in a single order submission.