# Social housing API for the Netherlands

Dutch rentals come in three segments with different rules. WoningMe returns all of them through one API and lets you filter on each.

## The three rental segments

The Dutch rental market is split into segments, and many data sources only cover one of them. In WoningMe each listing carries its segment as flags, so you can keep them apart or combine them.

 | Segment | Dutch term | In the API |
|---|---|---|
 | Social housing | sociale huur, offered by housing associations (woningcorporaties) | `isHousingAssociation: true`, filter `is_social_housing` |
 | Mid-market rent | middenhuur | `isMiddenhuur: true`, filter `is_middenhuur` |
 | Private sector | vrije sector | filter `is_free_market` |

## Filtering on a segment

By default a new search matches all three segments. Set the flags explicitly to narrow it. This search returns only housing-association listings around Amsterdam:

```
curl -X POST https://woning.me/api/developer/v1/searches \
  -H "X-Api-Key: $KEY" -H "Content-Type: application/json" \
  -d '{"label":"Amsterdam social","city":"Amsterdam","radius_km":10,
       "is_social_housing":true,"is_free_market":false,"is_middenhuur":false}'
```

The segment flags are independent. Setting only one of them to `true` does not switch the others on, so state all three when you want an exact combination.

## What a social housing listing contains

The response has the same shape as every other listing: address, coordinates, rent, surface, rooms and a link to the original listing. Some sources do not publish every field, so fields such as `availableFrom` or `constructionType` can be `null`. The `agent` field names the listing party when the source provides it.

## Typical uses

- Housing search tools that show social, mid-market and private rentals side by side.
- Research and prototypes on the supply of affordable rentals in a city.
- Alerts for one segment, combined with [webhooks](https://woning.me/developer/rental-webhooks).

Rentals only. WoningMe does not offer properties for sale.

Source: https://woning.me/developer/social-housing-api (part of the WoningMe Developer API, https://woning.me/developer)