{"openapi":"3.1.0","info":{"title":"databuurt public v1 API","version":"0.1.0","description":"Onafhankelijke aggregaten over Nederlandse koopwoningen op basis van publieke Funda-listings. CC-BY-4.0 — attribution via https://databuurt.nl/over."},"servers":[{"url":"https://databuurt.nl"}],"paths":{"/api/v1/municipalities":{"get":{"tags":["public-v1"],"summary":"Lijst gemeenten + €/m²","description":"Median €/m² and listing count for every Dutch municipality with data.","operationId":"municipalities_api_v1_municipalities_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}},"head":{"tags":["public-v1"],"summary":"Lijst gemeenten + €/m²","description":"Median €/m² and listing count for every Dutch municipality with data.","operationId":"municipalities_api_v1_municipalities_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/v1/municipality/{name}":{"get":{"tags":["public-v1"],"summary":"Details voor één gemeente","description":"All headline metrics for a single municipality.","operationId":"municipality_api_v1_municipality__name__get","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"head":{"tags":["public-v1"],"summary":"Details voor één gemeente","description":"All headline metrics for a single municipality.","operationId":"municipality_api_v1_municipality__name__get","parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/wijken":{"get":{"tags":["public-v1"],"summary":"Wijken met statistieken","description":"All wijken with at least `min_n` listings.","operationId":"wijken_api_v1_wijken_get","parameters":[{"name":"min_n","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"default":3,"title":"Min N"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"head":{"tags":["public-v1"],"summary":"Wijken met statistieken","description":"All wijken with at least `min_n` listings.","operationId":"wijken_api_v1_wijken_get","parameters":[{"name":"min_n","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"default":3,"title":"Min N"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/national-overview":{"get":{"tags":["public-v1"],"summary":"Landelijk overzicht (mediaan, verdelingen)","operationId":"national_overview_api_v1_national_overview_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}},"head":{"tags":["public-v1"],"summary":"Landelijk overzicht (mediaan, verdelingen)","operationId":"national_overview_api_v1_national_overview_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/v1/energy-label-premium":{"get":{"tags":["public-v1"],"summary":"Energielabel-premium per gemeente","operationId":"energy_label_premium_api_v1_energy_label_premium_get","parameters":[{"name":"min_n_per_label","in":"query","required":false,"schema":{"type":"integer","maximum":20,"minimum":2,"default":4,"title":"Min N Per Label"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"head":{"tags":["public-v1"],"summary":"Energielabel-premium per gemeente","operationId":"energy_label_premium_api_v1_energy_label_premium_get","parameters":[{"name":"min_n_per_label","in":"query","required":false,"schema":{"type":"integer","maximum":20,"minimum":2,"default":4,"title":"Min N Per Label"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/buurt/{buurtcode}":{"get":{"tags":["public-v1"],"summary":"CBS Kerncijfers voor één buurt","description":"Per-buurt statistieken uit CBS Kerncijfers Wijken en Buurten.\n\n`buurtcode` is een BU... code uit het CBS-systeem. Te vinden via PDOK\nLocatieserver of via /api/v1/wijken.","operationId":"api_v1_buurt_api_v1_buurt__buurtcode__get","parameters":[{"name":"buurtcode","in":"path","required":true,"schema":{"type":"string","title":"Buurtcode"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}