propertypal.com APIpropertypal.com ↗
Access Northern Ireland property listings, price trends, agent details, and market news via the PropertyPal API. 9 endpoints for sales, rentals, and commercial.
curl -X GET 'https://api.parse.bot/scraper/58744562-ed79-498a-b263-f9d9e3fe45b6/search_properties_for_rent?page=1&location=northern-ireland' \ -H 'X-API-Key: $PARSE_API_KEY'
Search for residential properties for rent in Northern Ireland or specific areas. Returns paginated results including property listings with details such as price, bedrooms, address, and agent information.
| Param | Type | Description |
|---|---|---|
| page | integer | Page number for pagination. |
| bedrooms | integer | Minimum number of bedrooms to filter by. |
| location | string | Location slug for the search area (e.g. 'belfast', 'northern-ireland', 'ballyclare'). |
| max_price | integer | Maximum monthly rental price in GBP. |
| min_price | integer | Minimum monthly rental price in GBP. |
{
"type": "object",
"fields": {
"pageProps": "object containing search results, initialState with property listings, pagination data, and search metadata"
},
"sample": {
"data": {
"__N_SSP": true,
"pageProps": {
"loggedIn": false,
"initialState": {
"properties": {
"data": {
"results": [
{
"id": 1063408,
"price": {
"price": 325000,
"currencySymbol": "£"
},
"numBedrooms": 4,
"displayAddress": "16 Eaton Court, Dunmurry, Belfast"
}
],
"totalPages": 125,
"totalResults": 1500
}
}
}
}
},
"status": "success"
}
}About the propertypal.com API
The PropertyPal API exposes 9 endpoints covering residential sales, rentals, commercial properties, new-build developments, and market statistics for Northern Ireland. Use search_properties_for_sale to filter by location, price range, and bedroom count, or call get_ni_house_prices to retrieve average price trends and year-over-year growth rates broken down by property size and geographic area.
Property Search and Listings
The search_properties_for_rent and search_properties_for_sale endpoints both accept location slugs (e.g. belfast, ballyclare, northern-ireland), min_price/max_price in GBP, a bedrooms floor, and a page integer for pagination. Both return a pageProps object containing an initialState array of property listings — each with price, address, bedroom count, and agent information — plus pagination metadata. The search_commercial_properties endpoint follows the same shape but omits bedroom and price-range filters, returning land, office, retail, and other commercial types instead.
Property and Agent Detail
get_property_details requires both a slug (the address portion of the property URL) and a property_id (the numeric ID). The response includes a full image set, written description, EPC rating, pricing history, and agent contact data. get_agent_details takes an agent_slug and returns an account object with the agent's profile, logo, branding, and contact details alongside an initialState object containing their current listings.
Market Data and Viewings
get_ni_house_prices returns a data array of price series segmented by property type (e.g. 1–2 bed, 3 bed, Northern Ireland overall), a form object enumerating wards, areas, and districts for geographic filtering, and an averagePriceGrowth array showing year-over-year percentage changes by bedroom count. get_open_viewings surfaces properties with scheduled open viewing events, filterable by location and page, and may return either paginated results or a redirect to a sorted search URL.
News and New Homes
get_news_and_analysis returns a data object containing a paginated articles array plus a trending array of currently popular articles and a subCategories classification list. search_new_homes returns development-level listings for new-build properties across Northern Ireland without additional filter parameters.
- Build a rental affordability tool filtering Belfast listings by
max_priceandbedroomsviasearch_properties_for_rent. - Track Northern Ireland house price growth over time using the
averagePriceGrowtharray fromget_ni_house_prices. - Aggregate upcoming open viewings by area for a property-tour scheduling app using
get_open_viewings. - Display agent profiles and their active listings in a CRM integration using
get_agent_details. - Monitor new-build development availability across NI with
search_new_homesfor a new-homes alert service. - Publish a property market news feed by pulling articles and trending content from
get_news_and_analysis. - Compare commercial property availability in specific districts using the
locationfilter onsearch_commercial_properties.
| Tier | Price | Credits/month | Rate limit |
|---|---|---|---|
| Free | $0/mo | 100 | 5 req/min |
| Hobby | $30/mo | 1,000 | 20 req/min |
| Developer | $100/mo | 5,000 | 250 req/min |
One credit = one API call regardless of which marketplace API you call. Exceeding the rate limit returns a 429 response. Authenticate with the X-API-Key header.
Does PropertyPal offer an official developer API?+
What does `get_ni_house_prices` actually return — is it just a single average figure?+
data array of multiple price trend series segmented by property type (e.g. Northern Ireland overall, 1–2 bed, 3 bed), bounded by startTime and endTime ISO timestamps. It also includes an averagePriceGrowth array with year-over-year growth rates by bedroom count, and a form object listing wards, areas, and districts you can use for geographic context.Does the API cover properties in the Republic of Ireland, not just Northern Ireland?+
Can I retrieve the full pricing history for a specific property?+
get_property_details returns pricing data within the pageProps response object, but the depth of historical price changes depends on what PropertyPal records for each individual listing. Properties with limited transaction history may return only current pricing. You can fork the API on Parse and revise it to enrich results with additional historic data sources if deeper history is required.Is it possible to search rentals by property type (e.g. apartment vs. house)?+
search_properties_for_rent endpoint currently accepts location, min_price, max_price, bedrooms, and page as filter parameters. Property-type filtering is not exposed as a parameter at this time. You can fork the API on Parse and revise it to add a property-type filter if that distinction is important to your use case.