LiveGET /data/v1/places/insights

Neighbourhood API

De Neighbourhood API geeft cijfers over de mensen en woningen in een gemeente, wijk of buurt, met de bronvermelding die daarbij hoort.

Account aanmaken Lees de documentatie

Buurt

Verzoek

GET/data/v1/places/insights?type=neighborhood&slug=langestraat-e-o-jtvr6xz675kh

X-API-Key: YOUR_API_KEY

Antwoord

{
  "type": "neighborhood",
  "slug": "langestraat-e-o-jtvr6xz675kh",
  "displayName": "Langestraat e.o.",
  "archived": false,
  "municipality": {"slug": "amsterdam-gsxxzjaz98rj", "displayName": "Amsterdam"},
  "district": {
    "slug": "grachtengordel-west-mavt2wcj84gj",
    "displayName": "Grachtengordel-West"
  },
  "districts": [],
  "neighborhoods": [],
  "metrics": [
    {
      "key": "population.total",
      "unit": "count",
      "latest": {
        "period": {"type": "date", "start": "2026-01-01", "end": "2026-01-01"},
        "value": 1180
      },
      "history": [
        {
          "period": {
            "type": "date",
            "start": "2026-01-01",
            "end": "2026-01-01"
          },
          "value": 1180
        },
        {
          "period": {
            "type": "date",
            "start": "2025-01-01",
            "end": "2025-01-01"
          },
          "value": 1165
        },
        {
          "period": {
            "type": "date",
            "start": "2024-01-01",
            "end": "2024-01-01"
          },
          "value": 1140
        }
      ],
      "comparisons": [
        {"place": "district", "value": 9870},
        {"place": "municipality", "value": 934900},
        {"place": "country", "value": 17942942}
      ]
    },
    {
      "key": "housing.ownership.owner_occupied_share",
      "unit": "percentage",
      "latest": {
        "period": {"type": "date", "start": "2026-01-01", "end": "2026-01-01"},
        "value": 38
      },
      "history": [],
      "comparisons": [{"place": "country", "value": 57}]
    }
  ],
  "attribution": [
    {
      "provider": "cbs-statistics",
      "publisher": "Centraal Bureau voor de Statistiek (CBS)",
      "license": "CC-BY-4.0",
      "licenseUrl": "https://creativecommons.org/licenses/by/4.0/"
    }
  ]
}

200 OK2 creditsVoorbeeldantwoord

Voorbeelddata uit het gepubliceerde API-contract.

2 creditsper verzoek
395cijfers in het gepubliceerde contract
3soorten plaatsen

Plaatsen

Er zijn cijfers voor drie soorten plaatsen: gemeenten, wijken en buurten.

Gemeente
Wijk
Buurt

Aangeduid met zijn slug

400 unknown_place

Een plaats wordt aangeduid met zijn type en zijn slug, het paar dat de plaatsenzoeker van de Aggregator API teruggeeft. Een plaats die niet bestaat of nog geen cijfers heeft, geeft een 400-fout met de code unknown_place.

Bronvermelding

attribution

De cijfers komen uit openbare bronnen waarvan de licentie bronvermelding vereist. Elk antwoord bevat een lijst met bronvermeldingen, één per aanbieder. Publiceer je de cijfers opnieuw, dan moet je die tonen.

Wat elk cijfer bevat

Voorbeeld

key: population.totalunit: count

Laatste

1.180

2026-01-01

Eerdere waarden history

1.1402024
1.1652025
1.1802026

Vergeleken met comparisons

Wijk: 9.870
Gemeente: 934.900
Nederland: 17.942.942

Centraal Bureau voor de Statistiek (CBS) · CC-BY-4.0

Elk cijfer heeft een sleutel, een eenheid, zijn laatste waarde met de periode waar die over gaat, zijn eerdere waarden als ten minste 3 perioden een cijfer hebben, en hetzelfde cijfer voor de wijk, de gemeente en het land waarin de plaats ligt, voor zover dat er is. Het gepubliceerde contract noemt 395 cijfers. Een plaats geeft de cijfers terug waarvoor een waarde beschikbaar is. De cijfers worden hoogstens één keer per dag bijgewerkt, als de uitgever nieuwe cijfers heeft vrijgegeven.

Roep hem aan vanuit je code

Kosten

Een verzoek kost 2 credits, voor een gemeente, een wijk of een buurt. Een mislukt verzoek kost niets.

Lees de documentatie

curl "https://api.huisly.nl/data/v1/places/insights?type=neighborhood&slug=langestraat-e-o-jtvr6xz675kh" \
  -H "X-API-Key: YOUR_API_KEY"

const params = new URLSearchParams({ type: "neighborhood", slug: "langestraat-e-o-jtvr6xz675kh" })
const response = await fetch(`https://api.huisly.nl/data/v1/places/insights?${params}`, {
  headers: { "X-API-Key": "YOUR_API_KEY" },
})
const body = await response.json()

import requests

response = requests.get(
    "https://api.huisly.nl/data/v1/places/insights",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"type": "neighborhood", "slug": "langestraat-e-o-jtvr6xz675kh"},
)
body = response.json()

Probeer het met gratis credits

Een nieuwe organisatie kan gratis proefcredits claimen om de API uit te proberen.

Account aanmaken Bekijk de prijzen

Vragen

Gesprek inplannenof mailsales@huisly.nl