# Propertypal — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search and browse thousands of properties across Northern Ireland including rentals, sales, and commercial listings while accessing agent details, price trends, and market news. Get comprehensive property information, open viewing schedules, and real estate insights all in one place.

**Category:** Real Estate | **Website:** [propertypal.com/](https://propertypal.com/) | **Docs:** [parse.bot/marketplace/1cf1309e-31cb-4fd7-9029-f34720628899/propertypal-com-api](https://parse.bot/marketplace/1cf1309e-31cb-4fd7-9029-f34720628899/propertypal-com-api)

Pay-per-use API proxy. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-propertypal-com-api-1cf1309e/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### get_agent_details

Retrieve details about a specific estate agent including their branches, contact information, property listings count, and accreditations. The agent_slug is the URL-friendly name found in agent URLs on PropertyPal. Returns matching agent branches.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `agent_slug` | string | Yes | Agent slug from the agent's URL path (e.g. 'simon-brien-residential-east-belfast'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-propertypal-com-api-1cf1309e/get_agent_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"agent_slug":"<string>"}'
```

### get_news_and_analysis

Retrieve property market news and analysis articles from PropertyPal's content hub. Returns articles with title, slug, publication date, blurb, poster images, and sub-category classifications, plus a trending articles section and pagination metadata.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-propertypal-com-api-1cf1309e/get_news_and_analysis \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_ni_house_prices

Retrieve Northern Ireland house price trends and market statistics. Returns quarterly price data series by property size (overall, 1-2 bed, 3 bed, 4+ bed), year-over-year growth rates, and geographic filter options (wards, areas, districts) for further analysis.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-propertypal-com-api-1cf1309e/get_ni_house_prices \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### get_open_viewings

Retrieve properties with upcoming open viewing events sorted by open viewing start time. Typically returns a redirect object with the canonical sorted search URL. When actual results are available, they include the standard property listing format.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `location` | string | No | Location slug for the search area. |
| `page` | integer | No | Page number for pagination. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-propertypal-com-api-1cf1309e/get_open_viewings \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"location":"<string>","page":"<integer>"}'
```

### get_property_details

Retrieve full details for a specific property listing including images, description, agent information, EPC rating, price history, key info, and related searches. Requires both the property address slug and the property ID from a search result's path field.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `property_id` | string | Yes | Property ID number from the property URL (e.g. '1075021'). Found as pathId in search results. |
| `slug` | string | Yes | Property address slug from the property URL path (the text portion before the numeric ID, e.g. '19-06-obel-62-donegall-quay-belfast'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-propertypal-com-api-1cf1309e/get_property_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"property_id":"<string>","slug":"<string>"}'
```

### search_commercial_properties

Search for commercial properties for sale in Northern Ireland including land, offices, retail, and investment properties. Returns paginated results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `location` | string | No | Location slug for the search area. |
| `page` | integer | No | Page number for pagination. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-propertypal-com-api-1cf1309e/search_commercial_properties \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"location":"<string>","page":"<integer>"}'
```

### search_new_homes

Search for new home developments in Northern Ireland. Returns superfeature developments (premium listings) and featured developments with details including pricing, available units, show home opening times, and developer/agent information.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-propertypal-com-api-1cf1309e/search_new_homes \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### search_properties_for_rent

Search for residential properties to rent in Northern Ireland. Returns paginated results with property listings including address, price, bedrooms, agent info, and images. Each page contains up to 12 results. When filters (bedrooms, price) are applied together with the base location, the API may return a redirect URL indicating the canonical filtered search path instead of results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `bedrooms` | integer | No | Minimum number of bedrooms to filter by. |
| `location` | string | No | Location slug for the search area. |
| `max_price` | integer | No | Maximum monthly rental price in GBP. |
| `min_price` | integer | No | Minimum monthly rental price in GBP. |
| `page` | integer | No | Page number for pagination. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-propertypal-com-api-1cf1309e/search_properties_for_rent \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"bedrooms":"<integer>","location":"<string>","max_price":"<integer>","min_price":"<integer>","page":"<integer>"}'
```

### search_properties_for_sale

Search for residential properties for sale in Northern Ireland. Returns paginated results with property listings including address, price, bedrooms, agent info, and images. Each page contains up to 12 results. When filters are applied, the API may return a redirect URL.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `bedrooms` | integer | No | Minimum number of bedrooms to filter by. |
| `location` | string | No | Location slug for the search area. |
| `max_price` | integer | No | Maximum sale price in GBP. |
| `min_price` | integer | No | Minimum sale price in GBP. |
| `page` | integer | No | Page number for pagination. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-propertypal-com-api-1cf1309e/search_properties_for_sale \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"bedrooms":"<integer>","location":"<string>","max_price":"<integer>","min_price":"<integer>","page":"<integer>"}'
```