# PDOK

> Look up any Dutch address, place or parcel in PDOK, the Dutch government's open map data from Kadaster. Find and autocomplete addresses, streets, towns and municipalities, turn a postcode and house number into a full address, find the addresses nearest a point, get a building's construction year, floor area and use, and get CBS figures such as population, households and average home value for any neighbourhood. No account or API key required.

App · 9 actions. Web page: https://docs.lodol.com/docs/integrations/pdok

## Actions

### Find a location

Turn a Dutch address, street, postcode, town or municipality written in full into its official details and coordinates: postcode, house number, town, municipality, province, neighbourhood, BAG IDs, latitude and longitude. Narrow it to some kinds of location, a municipality or a province, or rank results near a point.

**Inputs**

- Search text (`query`, text, required): What to look for, written in full, such as 'Damrak 1 Amsterdam' or 'Utrecht'. Postcodes work with or without the space. Best matches come first, but anything matching one of the words counts towards the total; put 'and' between words that must all match ('Damrak and 1 and Amsterdam'). For half-typed words use 'Suggest locations'.
- Location types (`types`, list): Only these kinds of location. Leave empty for municipalities, towns, streets, postcodes and addresses (PDOK's own choice); tick Cadastral parcel, District, Neighbourhood and the rest to search those too. One or more of: `address`, `street` (Street or road), `postcode`, `town` (Town or city), `municipality`, `province`, `district` (District (wijk)), `neighbourhood` (Neighbourhood (buurt)), `parcel` (Cadastral parcel), `apartment_right` (Apartment right), `hectometre_marker` (Hectometre marker on a road).
- In municipality (`municipality`, text): Only locations in this municipality: pick one, or type its name or four-digit code (such as 0363). Leave empty for the whole country.
- In province (`province`, text): Only locations in this province. Leave empty for all twelve. One of: `PV22` (Drenthe), `PV24` (Flevoland), `PV21` (Fryslân), `PV25` (Gelderland), `PV20` (Groningen), `PV31` (Limburg), `PV30` (Noord-Brabant), `PV27` (Noord-Holland), `PV23` (Overijssel), `PV26` (Utrecht), `PV29` (Zeeland), `PV28` (Zuid-Holland).
- Near latitude (`near_latitude`, number): Rank locations nearer this point higher: its latitude, such as 52.0907. Give a longitude with it. From -90 to 90.
- Near longitude (`near_longitude`, number): The point's longitude, such as 5.1214. Give a latitude with it. From -180 to 180.
- How many to return (`limit`, number): How many locations to return, up to 100. From 1 to 100. Default: `10`.
- Page (`page`, number): Which page of results to return, from 1. PDOK pages through the first 10,000 matches only. From 1 to 10001. Default: `1`.

**Outputs**

- `count` (number): How many are in this answer.
- `locations` (list): The locations found, best match first.
- `more_available` (true/false): Whether a further page has more results.
- `page` (number): Which page of results this is, from 1.
- `query` (text): The search text, as sent.
- `total` (number): How many locations match in all.

**Example output**

```json
{
  "count": 2,
  "locations": [
    {
      "address_type": null,
      "apartment_number": null,
      "bag_address_id": null,
      "bag_object_id": null,
      "bag_street_id": "0363300000003187",
      "cadastral_designation": null,
      "cadastral_municipality": null,
      "cadastral_municipality_code": null,
      "cadastral_section": null,
      "distance_m": null,
      "district": null,
      "district_code": null,
      "hectometre": null,
      "house_letter": null,
      "house_number": null,
      "house_number_addition": null,
      "house_number_full": null,
      "id": "weg-81c29298a0fcc1e5f933da43c190788a",
      "latitude": 52.37513402,
      "longitude": 4.89580599,
      "map_url": "https://www.openstreetmap.org/?mlat=52.37513402&mlon=4.89580599#map=16/52.37513402/4.89580599",
      "municipality": "Amsterdam",
      "municipality_code": "0363",
      "name": "Damrak, Amsterdam",
      "neighbourhood": null,
      "neighbourhood_code": null,
      "parcel_area_m2": null,
      "parcel_id": null,
      "parcel_number": null,
      "parcels": [],
      "postcode": null,
      "province": "Noord-Holland",
      "province_abbreviation": "NH",
      "province_code": "PV27",
      "rd_x": 121537.612,
      "rd_y": 487586.916,
      "road_number": null,
      "score": 13.608241,
      "source": "BAG/NWB",
      "street": "Damrak",
      "town": "Amsterdam",
      "town_code": "3594",
      "type": "street",
      "water_board": null
    },
    {
      "address_type": "main",
      "apartment_number": null,
      "bag_address_id": "0363200012113669",
      "bag_object_id": "0363010012111931",
      "bag_street_id": "0363300000003187",
      "cadastral_designation": null,
      "cadastral_municipality": null,
      "cadastral_municipality_code": null,
      "cadastral_section": null,
      "distance_m": null,
      "district": "Burgwallen-Nieuwe Zijde",
      "district_code": "WK0363AD",
      "hectometre": null,
      "house_letter": null,
      "house_number": 1,
      "house_number_addition": null,
      "house_number_full": "1",
      "id": "adr-8f4d573be765b4c80dd635ba73747903",
      "latitude": 52.37714446,
      "longitude": 4.89803846,
      "map_url": "https://www.openstreetmap.org/?mlat=52.37714446&mlon=4.89803846#map=18/52.37714446/4.89803846",
      "municipality": "Amsterdam",
      "municipality_code": "0363",
      "name": "Damrak 1, 1012LG Amsterdam",
      "neighbourhood": "Nieuwendijk-Noord",
      "neighbourhood_code": "BU0363AD03",
      "parcel_area_m2": null,
      "parcel_id": null,
      "parcel_number": null,
      "parcels": [
        "ASD04-F-6346"
      ],
      "postcode": "1012LG",
      "province": "Noord-Holland",
      "province_abbreviation": "NH",
      "province_code": "PV27",
      "rd_x": 121691.143,
      "rd_y": 487809.576,
      "road_number": null,
      "score": 13.442527,
      "source": "BAG",
      "street": "Damrak",
      "town": "Amsterdam",
      "town_code": "3594",
      "type": "address",
      "water_board": "Waterschap Amstel, Gooi en Vecht"
    }
  ],
  "more_available": true,
  "page": 1,
  "query": "Damrak 1 Amsterdam",
  "total": 942925
}
```

### Find what is at a point

Find the addresses nearest a latitude and longitude in the Netherlands, nearest first with their distance in metres, or the parcel, neighbourhood, municipality or other kinds of location at that point (reverse geocoding).

**Inputs**

- Latitude (`latitude`, number, required): The point's latitude, such as 52.0907. From -90 to 90.
- Longitude (`longitude`, number, required): The point's longitude, such as 5.1214. From -180 to 180.
- Location types (`types`, list): The kinds of location to find. Addresses by default; tick Cadastral parcel to find the parcel the point is on, or Neighbourhood or Municipality to find the area it is in. One or more of: `address`, `street` (Street or road), `postcode`, `town` (Town or city), `municipality`, `province`, `district` (District (wijk)), `neighbourhood` (Neighbourhood (buurt)), `parcel` (Cadastral parcel), `apartment_right` (Apartment right), `hectometre_marker` (Hectometre marker on a road). Default: `["address"]`.
- Within metres (`max_distance`, number): Only locations within this many metres of the point. Leave empty for the nearest, however far. From 1 to 100000.
- How many to return (`limit`, number): How many locations to return, up to 100. From 1 to 100. Default: `10`.

**Outputs**

- `count` (number): How many locations were found.
- `latitude` (number): The point's latitude.
- `locations` (list): The locations nearest the point, nearest first, each with its distance_m.
- `longitude` (number): The point's longitude.

**Example output**

```json
{
  "count": 2,
  "latitude": 52.0907,
  "locations": [
    {
      "address_type": null,
      "apartment_number": null,
      "bag_address_id": null,
      "bag_object_id": null,
      "bag_street_id": null,
      "cadastral_designation": "Utrecht B 3901",
      "cadastral_municipality": "Utrecht",
      "cadastral_municipality_code": "UTT00",
      "cadastral_section": "B",
      "distance_m": 0.0,
      "district": null,
      "district_code": null,
      "hectometre": null,
      "house_letter": null,
      "house_number": null,
      "house_number_addition": null,
      "house_number_full": null,
      "id": "pcl-5d63e714ccf8a08bf676a5bf36b325be",
      "latitude": 52.09065337,
      "longitude": 5.1213088,
      "map_url": "https://www.openstreetmap.org/?mlat=52.09065337&mlon=5.1213088#map=18/52.09065337/5.1213088",
      "municipality": null,
      "municipality_code": null,
      "name": "Perceel Utrecht (UTT00) B 3901",
      "neighbourhood": null,
      "neighbourhood_code": null,
      "parcel_area_m2": 380,
      "parcel_id": "UTT00-B-3901",
      "parcel_number": 3901,
      "parcels": [],
      "postcode": null,
      "province": null,
      "province_abbreviation": null,
      "province_code": null,
      "rd_x": 136777.456,
      "rd_y": 455854.974,
      "road_number": null,
      "score": 7.1971397,
      "source": "DKK",
      "street": null,
      "town": null,
      "town_code": null,
      "type": "parcel",
      "water_board": null
    },
    {
      "address_type": null,
      "apartment_number": null,
      "bag_address_id": null,
      "bag_object_id": null,
      "bag_street_id": null,
      "cadastral_designation": "Utrecht B 5580",
      "cadastral_municipality": "Utrecht",
      "cadastral_municipality_code": "UTT00",
      "cadastral_section": "B",
      "distance_m": 2.17,
      "district": null,
      "district_code": null,
      "hectometre": null,
      "house_letter": null,
      "house_number": null,
      "house_number_addition": null,
      "house_number_full": null,
      "id": "pcl-335cfa24a9759b0cc41592b5fcafe140",
      "latitude": 52.09055704,
      "longitude": 5.1216607,
      "map_url": "https://www.openstreetmap.org/?mlat=52.09055704&mlon=5.1216607#map=18/52.09055704/5.1216607",
      "municipality": null,
      "municipality_code": null,
      "name": "Perceel Utrecht (UTT00) B 5580",
      "neighbourhood": null,
      "neighbourhood_code": null,
      "parcel_area_m2": 4149,
      "parcel_id": "UTT00-B-5580",
      "parcel_number": 5580,
      "parcels": [],
      "postcode": null,
      "province": null,
      "province_abbreviation": null,
      "province_code": null,
      "rd_x": 136801.534,
      "rd_y": 455844.169,
      "road_number": null,
      "score": 7.1971397,
      "source": "DKK",
      "street": null,
      "town": null,
      "town_code": null,
      "type": "parcel",
      "water_board": null
    }
  ],
  "longitude": 5.1214
}
```

### Get a location

Get one location's full details by the PDOK ID another PDOK step gave (such as adr-...), or by a 16-digit BAG ID of an address, unit or street. Says found or not rather than failing.

**Inputs**

- Location ID (`location_id`, text, required): A PDOK ID from another PDOK step, such as adr-8f4d573be765b4c80dd635ba73747903, or a BAG ID of 16 digits, such as 0363200012113669.

**Outputs**

- `address_type` (text): For an address: 'main' for a building's main address, or 'secondary' for one of its other addresses.
- `apartment_number` (number): For an apartment right: its number within the parcel.
- `bag_address_id` (text): The address's BAG ID (nummeraanduiding), 16 digits, such as 0363200012113669.
- `bag_object_id` (text): The BAG ID of what the address belongs to (a unit, mooring or pitch), 16 digits. 'Get building details' reads it.
- `bag_street_id` (text): The street's BAG ID (openbare ruimte), 16 digits.
- `cadastral_designation` (text): For a parcel or apartment right: its designation, such as 'Amsterdam F 6346'.
- `cadastral_municipality` (text): For a parcel: the cadastral municipality, such as Amsterdam.
- `cadastral_municipality_code` (text): For a parcel: the cadastral municipality's code, such as ASD04.
- `cadastral_section` (text): For a parcel: its section, such as F.
- `distance_m` (number): For 'Find what is at a point': its distance from the point in metres. Empty otherwise.
- `district` (text): The CBS district (wijk) the address is in.
- `district_code` (text): The CBS district's code, such as WK0363AD.
- `found` (true/false): Whether PDOK has a location with that ID. Every other field is empty when it hasn't.
- `hectometre` (text): For a hectometre marker: its position in kilometres as the post shows it, such as 100.1.
- `house_letter` (text): The house letter, such as A in 10A.
- `house_number` (number): The house number, such as 10.
- `house_number_addition` (text): The house number addition, such as BS in 10A-BS or 2 in 28-2.
- `house_number_full` (text): The house number with its letter and addition, such as 10A-BS.
- `id` (text): PDOK's ID for the location, such as adr-8f4d573be765b4c80dd635ba73747903. 'Get a location' reads it again.
- `latitude` (number): Its latitude (WGS84). For an area, its centre.
- `longitude` (number): Its longitude (WGS84). For an area, its centre.
- `map_url` (text): A link that opens it on OpenStreetMap.
- `municipality` (text): The municipality (gemeente).
- `municipality_code` (text): The municipality's four-digit code, such as 0363. CBS writes it GM0363.
- `name` (text): Its full name, such as 'Damrak 1, 1012LG Amsterdam'.
- `neighbourhood` (text): The CBS neighbourhood (buurt) the address is in.
- `neighbourhood_code` (text): The CBS neighbourhood's code, such as BU0363AD03. 'Get area statistics' reads its figures.
- `parcel_area_m2` (number): For a parcel: its area in square metres, as the land register records it.
- `parcel_id` (text): For a parcel or apartment right: its cadastral ID, such as ASD04-F-6346.
- `parcel_number` (number): For a parcel: its number, such as 6346.
- `parcels` (list): For an address: the cadastral parcels its building stands on, such as ASD04-F-6346.
- `postcode` (text): The postcode, such as 1012LG.
- `province` (text): The province, such as Noord-Holland.
- `province_abbreviation` (text): The province's abbreviation, such as NH.
- `province_code` (text): The province's code, such as PV27.
- `rd_x` (number): Its x in the Dutch RD grid (EPSG:28992), in metres.
- `rd_y` (number): Its y in the Dutch RD grid (EPSG:28992), in metres.
- `road_number` (text): For a hectometre marker: the road, such as A2.
- `score` (number): How well it matches the search text; higher is better. Empty for a point search.
- `source` (text): The register it comes from: BAG (addresses and buildings), NWB (roads), DKK (cadastral map), CBS or Bestuurlijke Grenzen (boundaries).
- `street` (text): The street's name, for an address, postcode or street.
- `town` (text): The town or city (woonplaats).
- `town_code` (text): The BAG code of the town, such as 3594.
- `type` (text): What it is: address, street, postcode, town, municipality, province, district, neighbourhood, parcel, apartment_right or hectometre_marker.
- `water_board` (text): The water board (waterschap) responsible for the address.

**Example output**

```json
{
  "address_type": "main",
  "apartment_number": null,
  "bag_address_id": "0363200012113669",
  "bag_object_id": "0363010012111931",
  "bag_street_id": "0363300000003187",
  "cadastral_designation": null,
  "cadastral_municipality": null,
  "cadastral_municipality_code": null,
  "cadastral_section": null,
  "distance_m": null,
  "district": "Burgwallen-Nieuwe Zijde",
  "district_code": "WK0363AD",
  "found": true,
  "hectometre": null,
  "house_letter": null,
  "house_number": 1,
  "house_number_addition": null,
  "house_number_full": "1",
  "id": "adr-8f4d573be765b4c80dd635ba73747903",
  "latitude": 52.37714446,
  "longitude": 4.89803846,
  "map_url": "https://www.openstreetmap.org/?mlat=52.37714446&mlon=4.89803846#map=18/52.37714446/4.89803846",
  "municipality": "Amsterdam",
  "municipality_code": "0363",
  "name": "Damrak 1, 1012LG Amsterdam",
  "neighbourhood": "Nieuwendijk-Noord",
  "neighbourhood_code": "BU0363AD03",
  "parcel_area_m2": null,
  "parcel_id": null,
  "parcel_number": null,
  "parcels": [
    "ASD04-F-6346"
  ],
  "postcode": "1012LG",
  "province": "Noord-Holland",
  "province_abbreviation": "NH",
  "province_code": "PV27",
  "rd_x": 121691.143,
  "rd_y": 487809.576,
  "road_number": null,
  "score": 7.2204456,
  "source": "BAG",
  "street": "Damrak",
  "town": "Amsterdam",
  "town_code": "3594",
  "type": "address",
  "water_board": "Waterschap Amstel, Gooi en Vecht"
}
```

### Get area statistics

Get Statistics Netherlands (CBS) key figures for a municipality, district or neighbourhood: residents and their ages, households, homes, average home value, owner-occupied and rented homes, income, gas and electricity use, businesses, cars and distances to schools, GPs, supermarkets and stations.

**Inputs**

- Area (`area`, text, required): Pick a municipality, or type a district code (WK...) or neighbourhood code (BU...), such as the neighbourhood code of an address from another PDOK step.
- Year (`year`, number): The year the figures are for, from 2023. Leave empty for the newest year with the full set of figures; figures CBS hasn't published for it yet (incomes come about two years late) are then taken from the year before. At least 2023.

**Outputs**

- `address_density_per_km2` (number): Addresses per square kilometre around each address. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `area_code` (text): The area's CBS code: GM for a municipality, WK for a district, BU for a neighbourhood, such as BU0363AD03.
- `area_name` (text): The area's name.
- `area_type` (text): 'municipality', 'district' or 'neighbourhood'.
- `average_electricity_use_kwh` (number): Average electricity drawn from the grid per home, in kWh a year. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `average_gas_use_m3` (number): Average natural gas use per home, in cubic metres a year. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `average_home_value_eur` (number): Average home value for property tax (WOZ), in euros. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `average_household_income_eur` (number): Average standardised disposable household income, in euros a year. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `average_household_size` (number): Average people per household. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `average_income_per_resident_eur` (number): Average personal income per resident, in euros a year. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `businesses` (number): Business locations. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `cars_per_household` (number): Passenger cars per household. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `distance_to_childcare_km` (number): Average road distance to a day nursery, in km. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `distance_to_gp_km` (number): Average road distance to a GP practice, in km. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `distance_to_hospital_km` (number): Average road distance to a hospital, in km. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `distance_to_motorway_km` (number): Average road distance to a motorway on-ramp, in km. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `distance_to_primary_school_km` (number): Average road distance to a primary school, in km. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `distance_to_supermarket_km` (number): Average road distance to a large supermarket, in km. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `distance_to_train_station_km` (number): Average road distance to a train station, in km. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `district_code` (text): For a neighbourhood: its district's code.
- `dwellings` (number): Homes (the housing stock). Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `earlier_year` (number): When some figures are from the year before (CBS publishes incomes and some other figures later), that year.
- `earlier_year_figures` (list): The names of the figures taken from the earlier year.
- `found` (true/false): Whether CBS has figures for the area. Every other field is empty when it hasn't.
- `households` (number): Private households. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `land_area_ha` (number): Land area in hectares. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `men` (number): Male residents. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `most_common_postcode` (text): For a neighbourhood: its most common four-digit postcode area. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `municipality` (text): The municipality the area is in.
- `municipality_code` (text): The municipality's CBS code, such as GM0363.
- `percent_aged_0_to_14` (number): Share of residents aged 0 to 14, in percent. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `percent_aged_15_to_24` (number): Share of residents aged 15 to 24, in percent. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `percent_aged_25_to_44` (number): Share of residents aged 25 to 44, in percent. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `percent_aged_45_to_64` (number): Share of residents aged 45 to 64, in percent. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `percent_aged_65_and_over` (number): Share of residents aged 65 or over, in percent. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `percent_built_last_10_years` (number): Share of homes built in the last ten years, in percent. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `percent_homes_with_solar_panels` (number): Share of homes with solar panels, in percent. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `percent_households_with_children` (number): Share of households with children, in percent. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `percent_housing_association` (number): Share of homes rented from a housing association, in percent. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `percent_low_income_households` (number): Share of low-income households, in percent. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `percent_owner_occupied` (number): Share of homes that are owner-occupied, in percent. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `percent_rented` (number): Share of homes that are rented, in percent. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `percent_single_family_homes` (number): Share of homes that are single-family houses, in percent. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `percent_single_person_households` (number): Share of one-person households, in percent. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `population` (number): Residents. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `population_density_per_km2` (number): Residents per square kilometre of land. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `source_url` (text): A link to the area's CBS record on PDOK, with a map.
- `urbanity` (number): How urban it is, from 1 (very strongly urban, 2,500 or more addresses per km2) to 5 (not urban, fewer than 500). Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `water_area_ha` (number): Water area in hectares. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `women` (number): Female residents. Empty when CBS keeps it secret (for a small area) or hasn't published it.
- `year` (number): The year the figures are for.

**Example output**

```json
{
  "address_density_per_km2": 7237,
  "area_code": "BU0363AD03",
  "area_name": "Nieuwendijk-Noord",
  "area_type": "neighbourhood",
  "average_electricity_use_kwh": 1910,
  "average_gas_use_m3": 670,
  "average_home_value_eur": 505000,
  "average_household_income_eur": null,
  "average_household_size": 1.4,
  "average_income_per_resident_eur": null,
  "businesses": 300,
  "cars_per_household": 0.2,
  "distance_to_childcare_km": 0.8,
  "distance_to_gp_km": 0.7,
  "distance_to_hospital_km": 3.7,
  "distance_to_motorway_km": 4.2,
  "distance_to_primary_school_km": 0.9,
  "distance_to_supermarket_km": 0.5,
  "distance_to_train_station_km": 1,
  "district_code": "WK0363AD",
  "dwellings": 347,
  "earlier_year": 2023,
  "earlier_year_figures": [
    "percent_low_income_households"
  ],
  "found": true,
  "households": 365,
  "land_area_ha": 5,
  "men": 275,
  "most_common_postcode": "1012",
  "municipality": "Amsterdam",
  "municipality_code": "GM0363",
  "percent_aged_0_to_14": 4,
  "percent_aged_15_to_24": 18,
  "percent_aged_25_to_44": 55,
  "percent_aged_45_to_64": 18,
  "percent_aged_65_and_over": 5,
  "percent_built_last_10_years": 0,
  "percent_homes_with_solar_panels": 1,
  "percent_households_with_children": 5,
  "percent_housing_association": 10,
  "percent_low_income_households": 57,
  "percent_owner_occupied": 15,
  "percent_rented": 84,
  "percent_single_family_homes": 6,
  "percent_single_person_households": 68,
  "population": 500,
  "population_density_per_km2": 9115,
  "source_url": "https://api.pdok.nl/cbs/wijken-en-buurten-2024/ogc/v1/collections/buurten/items/588ab442-ebc5-53a6-9456-1995981a5e52?f=html",
  "urbanity": 1,
  "water_area_ha": 1,
  "women": 215,
  "year": 2024
}
```

### Get building details

Get what the official building register (BAG) records for a Dutch address: what it is used for (residential, office, retail and so on), its floor area, its status and the year its building was built. Give a postcode and house number, or an address ID from another PDOK step.

**Inputs**

- Address ID (`address_id`, text): The address's BAG object or address ID from another PDOK step (16 digits, such as 0363010012111931), or its PDOK ID (adr-...). Leave empty to give a postcode and house number instead.
- Postcode (`postcode`, text): The address's postcode, such as 1012 LG, when no address ID is given.
- House number (`house_number`, number): The house number, with a postcode. From 1 to 99999.
- House letter (`house_letter`, text): The letter after the house number, such as A in 10A. Most have none.
- House number addition (`house_number_addition`, text): What follows the number and letter, such as BS in 10A-BS or 2 in 28-2. Most have none.

**Outputs**

- `address` (text): The address, such as 'Damrak 1, 1012LG Amsterdam'.
- `bag_address_id` (text): The address's BAG ID (nummeraanduiding).
- `bag_object_id` (text): The BAG ID of the unit, mooring or pitch.
- `bag_url` (text): A link to the unit's BAG record on PDOK, with a map.
- `building_count` (number): How many buildings the unit is in.
- `buildings` (list): Each building the unit is in.
- `construction_year` (number): The year its building was built; the oldest, when it spans several.
- `floor_area_m2` (number): The unit's usable floor area in square metres, as the BAG records it.
- `found` (true/false): Whether the address was found in the BAG. Every other field is empty when it wasn't.
- `is_residential` (true/false): Whether one of its uses is Residential.
- `latitude` (number): The address's latitude.
- `longitude` (number): The address's longitude.
- `map_url` (text): A link that opens the address on OpenStreetMap.
- `municipality` (text): The address's municipality.
- `object_type` (text): What the address belongs to: 'unit' (a home, office or other space in a building), 'mooring' (for a houseboat) or 'pitch' (for a caravan or mobile home).
- `postcode` (text): The address's postcode.
- `status` (text): Its status, such as 'In use' or 'Being renovated'.
- `town` (text): The address's town or city.
- `uses` (list): What the unit is used for: Residential, Office, Retail, Industrial, Assembly, Lodging, Healthcare, Education, Sports, Detention or Other.

**Example output**

```json
{
  "address": "Damrak 1, 1012LG Amsterdam",
  "bag_address_id": "0363200012113669",
  "bag_object_id": "0363010012111931",
  "bag_url": "https://api.pdok.nl/kadaster/bag/ogc/v2/collections/verblijfsobject/items/793f4b39-6b64-5fe0-af12-7fdd2f94666e?f=html",
  "building_count": 1,
  "buildings": [
    {
      "bag_url": "https://api.pdok.nl/kadaster/bag/ogc/v2/collections/pand/items/9cfda850-6e7e-5637-9bf3-7f431dc0c3e8?f=html",
      "building_id": "0363100012185508",
      "construction_year": 1890,
      "status": "In use",
      "unit_count": 5,
      "uses": [
        "Assembly",
        "Lodging",
        "Retail"
      ]
    }
  ],
  "construction_year": 1890,
  "floor_area_m2": 16100,
  "found": true,
  "is_residential": false,
  "latitude": 52.37714446,
  "longitude": 4.89803846,
  "map_url": "https://www.openstreetmap.org/?mlat=52.37714446&mlon=4.89803846#map=18/52.37714446/4.89803846",
  "municipality": "Amsterdam",
  "object_type": "unit",
  "postcode": "1012LG",
  "status": "In use",
  "town": "Amsterdam",
  "uses": [
    "Assembly",
    "Lodging"
  ]
}
```

### List area statistics

Get the CBS key figures for every neighbourhood or district of a municipality in one go, to compare them or copy them into a spreadsheet: the same figures as 'Get area statistics' for each.

**Inputs**

- Municipality (`municipality`, text, required): The municipality: pick one, or type its name or four-digit code (such as 0344).
- Areas (`level`, text): Neighbourhoods (buurten, the smallest areas) or districts (wijken, groups of neighbourhoods). One of: `neighbourhoods` (Neighbourhoods (buurten)), `districts` (Districts (wijken)). Default: `neighbourhoods`.
- Year (`year`, number): The year the figures are for, from 2023. Leave empty for the newest year with the full set of figures; figures CBS hasn't published for it yet (incomes come about two years late) are then taken from the year before. At least 2023.

**Outputs**

- `areas` (list): Each district or neighbourhood with its figures, by code. Large water areas, which have no figures, are left out.
- `count` (number): How many areas are listed.
- `found` (true/false): Whether CBS has figures for the municipality's areas.
- `level` (text): 'neighbourhoods' or 'districts'.
- `municipality` (text): The municipality's name.
- `municipality_code` (text): The municipality's CBS code, such as GM0344.
- `year` (number): The year the figures are for.

**Example output**

```json
{
  "areas": [
    {
      "address_density_per_km2": 4001,
      "area_code": "WK034401",
      "area_name": "Wijk 01 West",
      "area_type": "district",
      "average_electricity_use_kwh": 1940,
      "average_gas_use_m3": 720,
      "average_home_value_eur": 431000,
      "average_household_income_eur": 37900,
      "average_household_size": 1.8,
      "average_income_per_resident_eur": 38000,
      "businesses": 6360,
      "cars_per_household": 0.6,
      "distance_to_childcare_km": 0.4,
      "distance_to_gp_km": 0.6,
      "distance_to_hospital_km": 4,
      "distance_to_motorway_km": 2.6,
      "distance_to_primary_school_km": 0.5,
      "distance_to_supermarket_km": 0.6,
      "distance_to_train_station_km": 1.7,
      "district_code": null,
      "dwellings": 13429,
      "earlier_year": 2023,
      "earlier_year_figures": [
        "average_income_per_resident_eur",
        "average_household_income_eur",
        "percent_low_income_households"
      ],
      "households": 16165,
      "land_area_ha": 810,
      "men": 14320,
      "most_common_postcode": null,
      "municipality": "Utrecht",
      "municipality_code": "GM0344",
      "percent_aged_0_to_14": 14,
      "percent_aged_15_to_24": 15,
      "percent_aged_25_to_44": 41,
      "percent_aged_45_to_64": 20,
      "percent_aged_65_and_over": 10,
      "percent_built_last_10_years": 8,
      "percent_homes_with_solar_panels": 21,
      "percent_households_with_children": 22,
      "percent_housing_association": 22,
      "percent_low_income_households": 45,
      "percent_owner_occupied": 51,
      "percent_rented": 49,
      "percent_single_family_homes": 35,
      "percent_single_person_households": 54,
      "population": 29710,
      "population_density_per_km2": 3669,
      "source_url": "https://api.pdok.nl/cbs/wijken-en-buurten-2024/ogc/v1/collections/wijken/items/fb0c756e-ad8d-5ca6-9ab5-a066d9716ffc?f=html",
      "urbanity": 1,
      "water_area_ha": 89,
      "women": 15385,
      "year": 2024
    },
    {
      "address_density_per_km2": 4212,
      "area_code": "WK034402",
      "area_name": "Wijk 02 Noordwest",
      "area_type": "district",
      "average_electricity_use_kwh": 1960,
      "average_gas_use_m3": 630,
      "average_home_value_eur": 392000,
      "average_household_income_eur": 34800,
      "average_household_size": 1.8,
      "average_income_per_resident_eur": 33000,
      "businesses": 6600,
      "cars_per_household": 0.5,
      "distance_to_childcare_km": 0.4,
      "distance_to_gp_km": 0.6,
      "distance_to_hospital_km": 4.8,
      "distance_to_motorway_km": 3.1,
      "distance_to_primary_school_km": 0.5,
      "distance_to_supermarket_km": 0.5,
      "distance_to_train_station_km": 2,
      "district_code": null,
      "dwellings": 21386,
      "earlier_year": 2023,
      "earlier_year_figures": [
        "average_income_per_resident_eur",
        "average_household_income_eur",
        "percent_low_income_households"
      ],
      "households": 24705,
      "land_area_ha": 439,
      "men": 21795,
      "most_common_postcode": null,
      "municipality": "Utrecht",
      "municipality_code": "GM0344",
      "percent_aged_0_to_14": 14,
      "percent_aged_15_to_24": 14,
      "percent_aged_25_to_44": 43,
      "percent_aged_45_to_64": 19,
      "percent_aged_65_and_over": 10,
      "percent_built_last_10_years": 6,
      "percent_homes_with_solar_panels": 24,
      "percent_households_with_children": 22,
      "percent_housing_association": 33,
      "percent_low_income_households": 48,
      "percent_owner_occupied": 41,
      "percent_rented": 59,
      "percent_single_family_homes": 46,
      "percent_single_person_households": 52,
      "population": 45220,
      "population_density_per_km2": 10292,
      "source_url": "https://api.pdok.nl/cbs/wijken-en-buurten-2024/ogc/v1/collections/wijken/items/b3f658e2-ed05-55f0-a258-4dcda0300e5b?f=html",
      "urbanity": 1,
      "water_area_ha": 14,
      "women": 23425,
      "year": 2024
    }
  ],
  "count": 2,
  "found": true,
  "level": "districts",
  "municipality": "Utrecht",
  "municipality_code": "GM0344",
  "year": 2024
}
```

### List municipalities

List every Dutch municipality, or those in one province, with its code (and CBS's GM code), province and centre point, in alphabetical order.

**Inputs**

- Province (`province`, text): Only municipalities in this province. Leave empty for all of them. One of: `PV22` (Drenthe), `PV24` (Flevoland), `PV21` (Fryslân), `PV25` (Gelderland), `PV20` (Groningen), `PV31` (Limburg), `PV30` (Noord-Brabant), `PV27` (Noord-Holland), `PV23` (Overijssel), `PV26` (Utrecht), `PV29` (Zeeland), `PV28` (Zuid-Holland).

**Outputs**

- `count` (number): How many municipalities are listed.
- `municipalities` (list): Every municipality, in alphabetical order.
- `province` (text): The province the list is for; empty for all of them.

**Example output**

```json
{
  "count": 2,
  "municipalities": [
    {
      "cbs_code": "GM0307",
      "code": "0307",
      "id": "gem-cceb0170170bb0dce737a135e1100ce5",
      "latitude": 52.17364981,
      "longitude": 5.38469621,
      "map_url": "https://www.openstreetmap.org/?mlat=52.17364981&mlon=5.38469621#map=11/52.17364981/5.38469621",
      "name": "Amersfoort",
      "province": "Utrecht",
      "province_abbreviation": "UT",
      "province_code": "PV26"
    },
    {
      "cbs_code": "GM0308",
      "code": "0308",
      "id": "gem-b39653958fb680c65adbf5081403c192",
      "latitude": 52.20383396,
      "longitude": 5.26414159,
      "map_url": "https://www.openstreetmap.org/?mlat=52.20383396&mlon=5.26414159#map=11/52.20383396/5.26414159",
      "name": "Baarn",
      "province": "Utrecht",
      "province_abbreviation": "UT",
      "province_code": "PV26"
    }
  ],
  "province": "Utrecht"
}
```

### Look up a postcode

Turn a Dutch postcode and house number into the full address with its street, town, coordinates and BAG IDs. Without a house number, list every address at the postcode; without a letter or addition, every address at that number (10, 10A, 10A-BS).

**Inputs**

- Postcode (`postcode`, text, required): The postcode, such as 1012 LG. The space is optional.
- House number (`house_number`, number): The house number, such as 1. Leave empty to list every address at the postcode. From 1 to 99999.
- House letter (`house_letter`, text): The letter after the house number, such as A in 10A. Most have none.
- House number addition (`house_number_addition`, text): What follows the number and letter, such as BS in 10A-BS or 2 in 28-2. Most have none.

**Outputs**

- `addresses` (list): Every matching address, in house number order.
- `count` (number): How many addresses match.
- `found` (true/false): Whether any address matches.
- `postcode` (text): The postcode, written without a space, such as 1012LG.

**Example output**

```json
{
  "addresses": [
    {
      "address_type": "main",
      "apartment_number": null,
      "bag_address_id": "0344200000057671",
      "bag_object_id": "0344010000051090",
      "bag_street_id": "0344300000002883",
      "cadastral_designation": null,
      "cadastral_municipality": null,
      "cadastral_municipality_code": null,
      "cadastral_section": null,
      "distance_m": null,
      "district": "Wijk 05 Oost",
      "district_code": "WK034405",
      "hectometre": null,
      "house_letter": null,
      "house_number": 10,
      "house_number_addition": null,
      "house_number_full": "10",
      "id": "adr-6f8e5b27c0044be0bf7104d4e01bb8c5",
      "latitude": 52.08881079,
      "longitude": 5.13331164,
      "map_url": "https://www.openstreetmap.org/?mlat=52.08881079&mlon=5.13331164#map=18/52.08881079/5.13331164",
      "municipality": "Utrecht",
      "municipality_code": "0344",
      "name": "Bolstraat 10, 3581WX Utrecht",
      "neighbourhood": "Oudwijk",
      "neighbourhood_code": "BU03440512",
      "parcel_area_m2": null,
      "parcel_id": null,
      "parcel_number": null,
      "parcels": [
        "ASD40-C-2167"
      ],
      "postcode": "3581WX",
      "province": "Utrecht",
      "province_abbreviation": "UT",
      "province_code": "PV26",
      "rd_x": 137599.328,
      "rd_y": 455647.027,
      "road_number": null,
      "score": 6.9560184,
      "source": "BAG",
      "street": "Bolstraat",
      "town": "Utrecht",
      "town_code": "3295",
      "type": "address",
      "water_board": "Hoogheemraadschap De Stichtse Rijnlanden"
    },
    {
      "address_type": "main",
      "apartment_number": null,
      "bag_address_id": "0344200000057672",
      "bag_object_id": "0344010000145922",
      "bag_street_id": "0344300000002883",
      "cadastral_designation": null,
      "cadastral_municipality": null,
      "cadastral_municipality_code": null,
      "cadastral_section": null,
      "distance_m": null,
      "district": "Wijk 05 Oost",
      "district_code": "WK034405",
      "hectometre": null,
      "house_letter": "A",
      "house_number": 10,
      "house_number_addition": null,
      "house_number_full": "10A",
      "id": "adr-91c10a7602d764a0b9afdb1f46a3fdcb",
      "latitude": 52.0887785,
      "longitude": 5.1333693,
      "map_url": "https://www.openstreetmap.org/?mlat=52.0887785&mlon=5.1333693#map=18/52.0887785/5.1333693",
      "municipality": "Utrecht",
      "municipality_code": "0344",
      "name": "Bolstraat 10A, 3581WX Utrecht",
      "neighbourhood": "Oudwijk",
      "neighbourhood_code": "BU03440512",
      "parcel_area_m2": null,
      "parcel_id": null,
      "parcel_number": null,
      "parcels": [
        "ASD40-C-5923"
      ],
      "postcode": "3581WX",
      "province": "Utrecht",
      "province_abbreviation": "UT",
      "province_code": "PV26",
      "rd_x": 137603.267,
      "rd_y": 455643.421,
      "road_number": null,
      "score": 6.9560184,
      "source": "BAG",
      "street": "Bolstraat",
      "town": "Utrecht",
      "town_code": "3295",
      "type": "address",
      "water_board": "Hoogheemraadschap De Stichtse Rijnlanden"
    },
    {
      "address_type": "main",
      "apartment_number": null,
      "bag_address_id": "0344200000057673",
      "bag_object_id": "0344010000051091",
      "bag_street_id": "0344300000002883",
      "cadastral_designation": null,
      "cadastral_municipality": null,
      "cadastral_municipality_code": null,
      "cadastral_section": null,
      "distance_m": null,
      "district": "Wijk 05 Oost",
      "district_code": "WK034405",
      "hectometre": null,
      "house_letter": "A",
      "house_number": 10,
      "house_number_addition": "BS",
      "house_number_full": "10A-BS",
      "id": "adr-1fe019897308ba8cc442f665b431a81d",
      "latitude": 52.08876986,
      "longitude": 5.13338475,
      "map_url": "https://www.openstreetmap.org/?mlat=52.08876986&mlon=5.13338475#map=18/52.08876986/5.13338475",
      "municipality": "Utrecht",
      "municipality_code": "0344",
      "name": "Bolstraat 10A-BS, 3581WX Utrecht",
      "neighbourhood": "Oudwijk",
      "neighbourhood_code": "BU03440512",
      "parcel_area_m2": null,
      "parcel_id": null,
      "parcel_number": null,
      "parcels": [
        "ASD40-C-5923"
      ],
      "postcode": "3581WX",
      "province": "Utrecht",
      "province_abbreviation": "UT",
      "province_code": "PV26",
      "rd_x": 137604.323,
      "rd_y": 455642.456,
      "road_number": null,
      "score": 6.9560184,
      "source": "BAG",
      "street": "Bolstraat",
      "town": "Utrecht",
      "town_code": "3295",
      "type": "address",
      "water_board": "Hoogheemraadschap De Stichtse Rijnlanden"
    }
  ],
  "count": 3,
  "found": true,
  "postcode": "3581WX"
}
```

### Suggest locations

Match Dutch addresses and places to text that is incomplete or half-typed, such as 'Damr 1 Amst', the way a search box autocompletes. Each suggestion has the same details as 'Find a location', and when nothing matches PDOK suggests spellings to try instead.

**Inputs**

- Text (`query`, text, required): The text so far, such as 'Damr 1 Amst' or '3581 W'. Words may be unfinished.
- Location types (`types`, list): Only these kinds of location. Leave empty for municipalities, towns, streets, postcodes and addresses (PDOK's own choice); tick Cadastral parcel, District, Neighbourhood and the rest to search those too. One or more of: `address`, `street` (Street or road), `postcode`, `town` (Town or city), `municipality`, `province`, `district` (District (wijk)), `neighbourhood` (Neighbourhood (buurt)), `parcel` (Cadastral parcel), `apartment_right` (Apartment right), `hectometre_marker` (Hectometre marker on a road).
- In municipality (`municipality`, text): Only locations in this municipality: pick one, or type its name or four-digit code (such as 0363). Leave empty for the whole country.
- In province (`province`, text): Only locations in this province. Leave empty for all twelve. One of: `PV22` (Drenthe), `PV24` (Flevoland), `PV21` (Fryslân), `PV25` (Gelderland), `PV20` (Groningen), `PV31` (Limburg), `PV30` (Noord-Brabant), `PV27` (Noord-Holland), `PV23` (Overijssel), `PV26` (Utrecht), `PV29` (Zeeland), `PV28` (Zuid-Holland).
- Near latitude (`near_latitude`, number): Rank locations nearer this point higher: its latitude, such as 52.0907. Give a longitude with it. From -90 to 90.
- Near longitude (`near_longitude`, number): The point's longitude, such as 5.1214. Give a latitude with it. From -180 to 180.
- How many to return (`limit`, number): How many suggestions to return, up to 100. From 1 to 100. Default: `10`.

**Outputs**

- `count` (number): How many are in this answer.
- `did_you_mean` (list): When nothing matches: spellings PDOK suggests trying instead.
- `locations` (list): The locations found, best match first.
- `query` (text): The text, as sent.
- `total` (number): How many locations match in all.

**Example output**

```json
{
  "count": 2,
  "did_you_mean": [],
  "locations": [
    {
      "address_type": "main",
      "apartment_number": null,
      "bag_address_id": "0363200012113669",
      "bag_object_id": "0363010012111931",
      "bag_street_id": "0363300000003187",
      "cadastral_designation": null,
      "cadastral_municipality": null,
      "cadastral_municipality_code": null,
      "cadastral_section": null,
      "distance_m": null,
      "district": "Burgwallen-Nieuwe Zijde",
      "district_code": "WK0363AD",
      "hectometre": null,
      "house_letter": null,
      "house_number": 1,
      "house_number_addition": null,
      "house_number_full": "1",
      "id": "adr-8f4d573be765b4c80dd635ba73747903",
      "latitude": 52.37714446,
      "longitude": 4.89803846,
      "map_url": "https://www.openstreetmap.org/?mlat=52.37714446&mlon=4.89803846#map=18/52.37714446/4.89803846",
      "municipality": "Amsterdam",
      "municipality_code": "0363",
      "name": "Damrak 1, 1012LG Amsterdam",
      "neighbourhood": "Nieuwendijk-Noord",
      "neighbourhood_code": "BU0363AD03",
      "parcel_area_m2": null,
      "parcel_id": null,
      "parcel_number": null,
      "parcels": [
        "ASD04-F-6346"
      ],
      "postcode": "1012LG",
      "province": "Noord-Holland",
      "province_abbreviation": "NH",
      "province_code": "PV27",
      "rd_x": 121691.143,
      "rd_y": 487809.576,
      "road_number": null,
      "score": 7.597257,
      "source": "BAG",
      "street": "Damrak",
      "town": "Amsterdam",
      "town_code": "3594",
      "type": "address",
      "water_board": "Waterschap Amstel, Gooi en Vecht"
    },
    {
      "address_type": "secondary",
      "apartment_number": null,
      "bag_address_id": "0363200012120422",
      "bag_object_id": "0363010012118642",
      "bag_street_id": "0363300000003188",
      "cadastral_designation": null,
      "cadastral_municipality": null,
      "cadastral_municipality_code": null,
      "cadastral_section": null,
      "distance_m": null,
      "district": "Burgwallen-Nieuwe Zijde",
      "district_code": "WK0363AD",
      "hectometre": null,
      "house_letter": null,
      "house_number": 1,
      "house_number_addition": null,
      "house_number_full": "1",
      "id": "adr-bd7761c205487bb4a624038619e2ec8b",
      "latitude": 52.37359669,
      "longitude": 4.89336168,
      "map_url": "https://www.openstreetmap.org/?mlat=52.37359669&mlon=4.89336168#map=18/52.37359669/4.89336168",
      "municipality": "Amsterdam",
      "municipality_code": "0363",
      "name": "Damraksteeg 1, 1012LP Amsterdam",
      "neighbourhood": "Nieuwe Kerk e.o.",
      "neighbourhood_code": "BU0363AD05",
      "parcel_area_m2": null,
      "parcel_id": null,
      "parcel_number": null,
      "parcels": [],
      "postcode": "1012LP",
      "province": "Noord-Holland",
      "province_abbreviation": "NH",
      "province_code": "PV27",
      "rd_x": 121370.0,
      "rd_y": 487417.0,
      "road_number": null,
      "score": 7.597257,
      "source": "BAG",
      "street": "Damraksteeg",
      "town": "Amsterdam",
      "town_code": "3594",
      "type": "address",
      "water_board": "Waterschap Amstel, Gooi en Vecht"
    }
  ],
  "query": "Damr 1 Amst",
  "total": 266
}
```
