# /pararius/properties

`POST /api/pararius/properties`

Price: 10 credits

Get full Pararius real estate listing details by listing URL (or city/id pair): address and neighbourhood, rental/asking price, deposit, service charge, living area, volume, plot area, number of rooms, bedrooms and bathrooms, energy label, build year, construction type, interior, dwelling type, facilities, situations, full description, photos, coordinates, selling/letting agent, whether the listing has been archived (taken off the market), nearby points of interest and the full grouped characteristics sections.

## How to use it

Fetch a single Pararius listing by its listing URL or a city/id pair (e.g. 'amsterdam/45ca958d'); the city part is required. status is the localized upstream wording, 'For rent' on the English site and 'Beschikbaar' on the Dutch one, so branch on is_archived rather than on it. A listing taken off the market is still served, with is_archived true: Pararius removes the letting/sale-terms block, the selling agent and the photo gallery from such a page, so what they carried comes back null and images falls back to the cover photo. What the listing published about itself — its address and description, the price it last asked, its coordinates, its characteristics and the nearby points of interest — is still there. For-rent listings are served in English; for-sale listings redirect to the Dutch site, so their feature labels come back in Dutch.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `property` (string, required) — Pararius listing URL, or a city/id pair identifying the listing (examples: "https://www.pararius.com/house-for-rent/amsterdam/da6d7e27/akbarstraat", "amsterdam/45ca958d"; minLength: 1)
- `city` (string) (default: "")
- `listing_id` (string) (default: "")

## Response

### 200 — Successful Response

- `@type` (string) (default: "ParariusProperty")
- `id` (string, required)
- `global_id` (string, nullable)
- `url` (string, nullable)
- `offering_type` (string, nullable)
- `status` (string, nullable)
- `is_archived` (boolean) (default: false)
- `address` (object, nullable)
  - `@type` (string) (default: "ParariusPropertyAddress")
  - `street` (string, nullable)
  - `postcode` (string, nullable)
  - `city` (string, nullable)
  - `district` (string, nullable)
- `description` (string, nullable)
- `price` (integer, nullable)
- `price_label` (string, nullable)
- `price_per_m2` (integer, nullable)
- `deposit` (integer, nullable)
- `service_charge` (integer, nullable)
- `offered_since` (string, nullable)
- `available` (string, nullable)
- `interior` (string, nullable)
- `living_area_m2` (integer, nullable)
- `volume_m3` (integer, nullable)
- `plot_area_m2` (integer, nullable)
- `room_count` (integer, nullable)
- `bedroom_count` (integer, nullable)
- `bathroom_count` (integer, nullable)
- `floor_count` (integer, nullable)
- `dwelling_type` (string, nullable)
- `construction_type` (string, nullable)
- `build_year` (integer, nullable)
- `energy_label` (string, nullable)
- `facilities` (array) (default: [])
- `situations` (array) (default: [])
- `coordinates` (array) (default: [])
- `images` (array) (default: [])
- `agent` (object, nullable)
  - `@type` (string) (default: "ParariusPropertyAgent")
  - `name` (string, nullable)
  - `alias` (string, nullable)
  - `city` (string, nullable)
  - `url` (string, nullable)
  - `image` (string, nullable)
- `points_of_interest` (array) (default: [])
  - `@type` (string) (default: "ParariusPointOfInterest")
  - `category` (string, nullable)
  - `name` (string, nullable)
  - `type` (string, nullable)
  - `distance` (string, nullable)
- `feature_sections` (array) (default: [])
  - `@type` (string) (default: "ParariusPropertyFeatureSection")
  - `features` (array) (default: [])
    - `@type` (string) (default: "ParariusPropertyFeature")
    - `label` (string, nullable)
    - `value` (string, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.

### 412

Listing not found (well-formed reference, but Pararius serves no listing for this city/id)

What to do: Retrying will not help: either the entity does not exist, or the input points at a different one.

### 429

Too many requests: a rate limit or a usage window is exhausted

What to do: When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.

### 500

Something broke on our side

What to do: Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.

### 529

Rate limit reached, or the endpoint is overloaded

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these headers:

- `X-Error` — Error message text (present only on error)
- `X-Request-ID` — Unique request identifier
- `X-Execution-Time` — Execution time in seconds
- `X-Result-Count` — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
- `X-Total-Available-Results` — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
- `X-Warning` — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
- `X-Retry-After` — Seconds to wait before retrying. Present only on 429.