Building List
List assets of type Building.
Query parameters
id:
Numerical filter on the id field.
code:
Text filter on the code field. All text field filter methods,
like startswith, endswith, icontains are supported,
created:
Temporal filter on created. Supports various lookup types
(exact, lt, lte, gt, gte; created__exact by default).
Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.
last_modified:
Temporal filter on last_modified. Supports various lookup types
(exact, lt, lte, gt, gte; last_modified__exact by default).
Filter values should be specified in ISO 8601 YYYY-MM-DDThh:mm:ssZ format.
organisation
Filter by organisation. Supports lookups on uuid and name.
build_year:
Numerical filter on the build_year field. All numeric field filter methods are supported: gt, gte, lt, lte, and isnull.
start/end:
Both query parameters can be used to filter the buildings. They define
an interval [start, end) and should be either in ISO 8601
YYYY-MM-DDThh:mm:ssZ format or in milliseconds since the epoch.
Available lookups are gt, gte, lt, lte, isnull.
valid_at:
Return only buildings that are present at given timestamp. If multiple
buildings with the same code and organisation are present, only the
one with the latest start is returned.
geom_within:
Spatial filter on geometry, filter operator is ST_within.
Supports WKT, HEXEWKB, and GeoJSON.
geom_intersects:
Spatial filter on geometry, filter operator is ST_intersects.
Supports WKT, HEXEWKB, and GeoJSON.
in_bbox:
Spatial filter on geometry. The bounding box format is: min Lat,
min Lon, max Lat, max Lon. Includes assets that overlap the bounding
box.
boundary__id:
Filter on geometry of the region/boundary with the id boundary__id.
For a list of regions/boundaries, see the boundary endpoint /api/v4/boundaries/
boundary__code:
Filter on geometry of the region/boundary with the id boundary__code.
For a list of regions/boundaries, see the boundary endpoint /api/v4/boundaries/
boundary__type:
Spatial filter on geometry, whereby geometry is specified by a
region/boundary object (see below) and filter operator is
ST_Intersects. Available types are COUNTRY, PROVINCE, WATER_BOARD,
MUNICIPALITY, CATCHMENT, POLDER, FIXED_DRAINAGE_LEVEL_AREA,
PUMPED_DRAINAGE_AREA, MAIN_PUMPED_DRAINAGE_AREA, DISTRICT,
NEIGHBOURHOOD, CADASTRE, PLANTATION, FIELD, CITY, and CUSTOM
boundary__name:
Filter on name of the region/boundary with the name
boundary__name. Requires boundary__type.
For a list of regions/boundaries, see the boundary endpoint /api/v4/boundaries/
simplify: Simplify the query geometries (in WGS84) using this value as tolerance. A higher value may result in a better response time for detailed geometries. Defaults to 0.00001 degrees (approx. 1 meter). NB: Returned geometries are unaffected.
addresses__postalcode:
Filter on postal code of the building address(es). All text field
filter methods, in particular startswith, endswith, contains
are supported, e. g. postalcode__startswith=9 returns buildings
within the postal code area 9.
addresses__house_number: Filter on house number of building address(es).
addresses__house_letter: Filter on house letter of building address(es).
addresses__house_number_suffix: Filter on house number suffix of building address(es).
page_size
The number of results on a single page. Defaults to 10, maximum is 100.
Note that pagination is disabled for the root endpoint: the response
will be truncated to page_size.
Custom route: by-organisation
Filter assets by organisation UUID. Pagination is enabled on this endpoint.
/api/v4/buildings/by-organisation/
Examples
?id=1
?code=135123
?code__startswith=0100
?created__gte=2017-01-01T00:00:00Z
?last_modified__lt=2018-01-01T00:00:00Z
?organisation__name__startswith=Nelen
?organisation__uuid=61f5a464-c350-44c1-9bc7-d4b42d7f58cb
?organisation__name__icontains=Schuur
?build_year__gt=1997
?start__gt=1900-01-01T00:00:00Z
?start=2019-01-01T02:03:04Z
?start__gt=1900-01-01T00:00:00Z&end__lt=2000-01-01T00:00:00Z
?start__gt=2015-01-01T00:00:00Z&end__isnull=true
?valid_at=2010-01-01T00:00:00Z
?geom_within=POLYGON((4.87 52.73, 4.87 52.79, 4.98 52.79,
4.98 52.73, 4.87 52.73))
?geom_intersects=POLYGON((4.87 52.73, 4.87 52.79, 4.98 52.79,
4.98 52.73, 4.87 52.73))
?in_bbox=4.8,52.7,4.9,52.8
?boundary__id=198
?boundary__code=NL_GM0344
?boundary__type=PROVINCE&boundary__name=Utrecht
?addresses__postalcode=1111AA
?addresses__postalcode=1111AA&addresses__house_number__gte=1&addresses__house_number__lte=99
?addresses__postalcode__startswith=1
?page_size=20
/by-organisation/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/
GET /api/v4/buildings/
[ { "url": "https://demo.lizard.net/api/v4/buildings/15614301/", "id": 15614301, "code": "0603100000003562", "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/", "uuid": "61f5a464-c350-44c1-9bc7-d4b42d7f58cb", "name": "Nelen & Schuurmans Consultancy" }, "geometry": { "type": "Polygon", "coordinates": [ [ [ 4.311286605281673, 52.025585205542626, 0.0 ], [ 4.311172767261126, 52.02554785036663, 0.0 ], [ 4.311215900743376, 52.025498617427274, 0.0 ], [ 4.311329753027753, 52.02553598168157, 0.0 ], [ 4.311286605281673, 52.025585205542626, 0.0 ] ] ] }, "last_modified": "2019-06-25T13:54:16.463605Z", "created": "2019-06-25T13:54:16.463621Z", "image_url": "", "addresses": [ { "street": "Aletta Jacobsstraat", "house_number": 37, "house_letter": "", "house_number_suffix": "", "postalcode": "2286BM", "city": "Rijswijk" } ], "start": "2010-11-26T00:00:00Z", "end": "2021-06-18T00:00:00Z", "build_year": 1970 }, { "url": "https://demo.lizard.net/api/v4/buildings/15614302/", "id": 15614302, "code": "0603100000003563", "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/", "uuid": "61f5a464-c350-44c1-9bc7-d4b42d7f58cb", "name": "Nelen & Schuurmans Consultancy" }, "geometry": { "type": "Polygon", "coordinates": [ [ [ 4.311329753027753, 52.02553598168157, 0.0 ], [ 4.311215900743376, 52.025498617427274, 0.0 ], [ 4.311259034130534, 52.02544938447153, 0.0 ], [ 4.311372900678728, 52.02548675780405, 0.0 ], [ 4.311329753027753, 52.02553598168157, 0.0 ] ] ] }, "last_modified": "2019-06-25T13:54:16.463824Z", "created": "2019-06-25T13:54:16.463841Z", "image_url": "", "addresses": [ { "street": "Aletta Jacobsstraat", "house_number": 39, "house_letter": "", "house_number_suffix": "", "postalcode": "2286BM", "city": "Rijswijk" } ], "start": "2010-11-26T00:00:00Z", "end": "2021-06-18T00:00:00Z", "build_year": 1970 }, { "url": "https://demo.lizard.net/api/v4/buildings/15614303/", "id": 15614303, "code": "0603100000003564", "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/", "uuid": "61f5a464-c350-44c1-9bc7-d4b42d7f58cb", "name": "Nelen & Schuurmans Consultancy" }, "geometry": { "type": "Polygon", "coordinates": [ [ [ 4.311372900678728, 52.02548675780405, 0.0 ], [ 4.311259034130534, 52.02544938447153, 0.0 ], [ 4.311302152422812, 52.025400169339825, 0.0 ], [ 4.311416048018801, 52.02543754289695, 0.0 ], [ 4.311372900678728, 52.02548675780405, 0.0 ] ] ] }, "last_modified": "2019-06-25T13:54:16.464057Z", "created": "2019-06-25T13:54:16.464075Z", "image_url": "", "addresses": [ { "street": "Aletta Jacobsstraat", "house_number": 41, "house_letter": "", "house_number_suffix": "", "postalcode": "2286BM", "city": "Rijswijk" } ], "start": "2010-11-26T00:00:00Z", "end": "2021-06-18T00:00:00Z", "build_year": 1970 }, { "url": "https://demo.lizard.net/api/v4/buildings/15614305/", "id": 15614305, "code": "0603100000003565", "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/", "uuid": "61f5a464-c350-44c1-9bc7-d4b42d7f58cb", "name": "Nelen & Schuurmans Consultancy" }, "geometry": { "type": "Polygon", "coordinates": [ [ [ 4.311302152422812, 52.025400169339825, 0.0 ], [ 4.31134628930856, 52.025349794956895, 0.0 ], [ 4.311459195479578, 52.02538831898655, 0.0 ], [ 4.311416048018801, 52.02543754289695, 0.0 ], [ 4.311302152422812, 52.025400169339825, 0.0 ] ] ] }, "last_modified": "2019-06-25T13:54:16.464462Z", "created": "2019-06-25T13:54:16.464479Z", "image_url": "", "addresses": [ { "street": "Aletta Jacobsstraat", "house_number": 43, "house_letter": "", "house_number_suffix": "", "postalcode": "2286BM", "city": "Rijswijk" } ], "start": "2011-10-03T00:00:00Z", "end": "2021-06-18T00:00:00Z", "build_year": 1970 }, { "url": "https://demo.lizard.net/api/v4/buildings/15614306/", "id": 15614306, "code": "0603100000003566", "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/", "uuid": "61f5a464-c350-44c1-9bc7-d4b42d7f58cb", "name": "Nelen & Schuurmans Consultancy" }, "geometry": { "type": "Polygon", "coordinates": [ [ [ 4.312356690851635, 52.0257659651237, 0.0 ], [ 4.31241752457344, 52.02569681237501, 0.0 ], [ 4.312497057970054, 52.02572343516804, 0.0 ], [ 4.312436179335861, 52.0257926414798, 0.0 ], [ 4.312356690851635, 52.0257659651237, 0.0 ] ] ] }, "last_modified": "2024-01-26T06:34:29.870830Z", "created": "2019-06-25T13:54:16.464669Z", "image_url": "", "addresses": [ { "street": "Suze Groenewegstraat", "house_number": 32, "house_letter": "", "house_number_suffix": "", "postalcode": "2286JG", "city": "Rijswijk" } ], "start": "2010-11-26T00:00:00Z", "end": "2023-07-04T00:00:00Z", "build_year": 1970 }, { "url": "https://demo.lizard.net/api/v4/buildings/15614307/", "id": 15614307, "code": "0603100000003567", "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/", "uuid": "61f5a464-c350-44c1-9bc7-d4b42d7f58cb", "name": "Nelen & Schuurmans Consultancy" }, "geometry": { "type": "Polygon", "coordinates": [ [ [ 4.312277216814992, 52.02573929783395, 0.0 ], [ 4.312338005839878, 52.02567018966142, 0.0 ], [ 4.31241752457344, 52.02569681237501, 0.0 ], [ 4.312356690851635, 52.0257659651237, 0.0 ], [ 4.312277216814992, 52.02573929783395, 0.0 ] ] ] }, "last_modified": "2024-01-26T06:34:29.870836Z", "created": "2019-06-25T13:54:16.464855Z", "image_url": "", "addresses": [ { "street": "Suze Groenewegstraat", "house_number": 30, "house_letter": "", "house_number_suffix": "", "postalcode": "2286JG", "city": "Rijswijk" } ], "start": "2010-11-26T00:00:00Z", "end": "2023-07-04T00:00:00Z", "build_year": 1970 }, { "url": "https://demo.lizard.net/api/v4/buildings/15614308/", "id": 15614308, "code": "0603100000003568", "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/", "uuid": "61f5a464-c350-44c1-9bc7-d4b42d7f58cb", "name": "Nelen & Schuurmans Consultancy" }, "geometry": { "type": "Polygon", "coordinates": [ [ [ 4.312197728304996, 52.02571263035769, 0.0 ], [ 4.312258487201109, 52.02564356689425, 0.0 ], [ 4.312338005839878, 52.02567018966142, 0.0 ], [ 4.312277216814992, 52.02573929783395, 0.0 ], [ 4.312197728304996, 52.02571263035769, 0.0 ] ] ] }, "last_modified": "2024-01-26T06:34:29.870842Z", "created": "2019-06-25T13:54:16.465062Z", "image_url": "", "addresses": [ { "street": "Suze Groenewegstraat", "house_number": 28, "house_letter": "", "house_number_suffix": "", "postalcode": "2286JG", "city": "Rijswijk" } ], "start": "2010-11-26T00:00:00Z", "end": "2023-07-04T00:00:00Z", "build_year": 1970 }, { "url": "https://demo.lizard.net/api/v4/buildings/15614310/", "id": 15614310, "code": "0603100000003569", "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/", "uuid": "61f5a464-c350-44c1-9bc7-d4b42d7f58cb", "name": "Nelen & Schuurmans Consultancy" }, "geometry": { "type": "Polygon", "coordinates": [ [ [ 4.312197728304996, 52.02571263035769, 0.0 ], [ 4.312118240105578, 52.025685953841055, 0.0 ], [ 4.312175557081996, 52.02561580729868, 0.0 ], [ 4.312258487201109, 52.02564356689425, 0.0 ], [ 4.312197728304996, 52.02571263035769, 0.0 ] ] ] }, "last_modified": "2024-01-26T06:34:29.870855Z", "created": "2019-06-25T13:54:16.465438Z", "image_url": "", "addresses": [ { "street": "Suze Groenewegstraat", "house_number": 26, "house_letter": "", "house_number_suffix": "", "postalcode": "2286JG", "city": "Rijswijk" } ], "start": "2011-10-03T00:00:00Z", "end": "2023-07-04T00:00:00Z", "build_year": 1970 }, { "url": "https://demo.lizard.net/api/v4/buildings/15614312/", "id": 15614312, "code": "0603100000003570", "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/", "uuid": "61f5a464-c350-44c1-9bc7-d4b42d7f58cb", "name": "Nelen & Schuurmans Consultancy" }, "geometry": { "type": "Polygon", "coordinates": [ [ [ 4.313170311562465, 52.02597954864952, 0.0 ], [ 4.313213616905029, 52.025932797468684, 0.0 ], [ 4.31324943844584, 52.02594475575213, 0.0 ], [ 4.313207852973656, 52.025992097918724, 0.0 ], [ 4.313170311562465, 52.02597954864952, 0.0 ] ] ] }, "last_modified": "2024-01-26T06:34:29.870862Z", "created": "2019-06-25T13:54:16.465812Z", "image_url": "", "addresses": [ { "street": "Petronella Voûtestraat", "house_number": 391, "house_letter": "L", "house_number_suffix": "", "postalcode": "2286VC", "city": "Rijswijk" } ], "start": "2011-10-03T00:00:00Z", "end": "2023-02-06T00:00:00Z", "build_year": 1970 }, { "url": "https://demo.lizard.net/api/v4/buildings/15614314/", "id": 15614314, "code": "0603100000003571", "organisation": { "url": "https://demo.lizard.net/api/v4/organisations/61f5a464-c350-44c1-9bc7-d4b42d7f58cb/", "uuid": "61f5a464-c350-44c1-9bc7-d4b42d7f58cb", "name": "Nelen & Schuurmans Consultancy" }, "geometry": { "type": "Polygon", "coordinates": [ [ [ 4.313286994634056, 52.02595729614223, 0.0 ], [ 4.313245394405942, 52.02600464717597, 0.0 ], [ 4.313207852973656, 52.025992097918724, 0.0 ], [ 4.31324943844584, 52.02594475575213, 0.0 ], [ 4.313286994634056, 52.02595729614223, 0.0 ] ] ] }, "last_modified": "2024-01-26T06:34:29.870869Z", "created": "2019-06-25T13:54:16.466203Z", "image_url": "", "addresses": [ { "street": "Petronella Voûtestraat", "house_number": 391, "house_letter": "K", "house_number_suffix": "", "postalcode": "2286VC", "city": "Rijswijk" } ], "start": "2011-06-29T00:00:00Z", "end": "2023-02-06T00:00:00Z", "build_year": 1970 } ]