API

Buildings

Organization: Kielce City Hall 1 endpoint Technical name: budynki Version: v1 Managed Public

Building footprints, identifiers, functions, areas and completion years where available in the source. The public API supports pagination, column selection and filtering by indexed fields.

Requests to the whole API service

Loading statistics…

Daily aggregates · UTC

Documentation

The API exposes public table data with selected columns, filters, sorting and pagination.

API endpoints

GET /budynki_publiczne/data Table data: Buildings json

Returns records from public table budynki_publiczne. Building footprints, identifiers, functions, areas and completion years where available in the source.

Data publication metadata
License Creative Commons Attribution 4.0 International
Organization Kielce City Hall
Openness level
Categories Housing, Spatial data and geography
Spatial coverage POLYGON((20.51161975 50.79354309,20.71545425 50.79354309,20.71545425 50.91363549,20.51161975 50.91363549,20.51161975 50.79354309))
Data sources Building register
Try endpoint

Response schemas

Check the documented response schemas in the OpenAPI document.

Open the OpenAPI document

Endpoint

/api/public/budynki/budynki_publiczne/data?version=v1

Parameters

Name Location Type Required Description example
columns query string optional Optional comma-separated list of columns. Empty value returns all public columns. id,name
filter[column] query string optional Filter by a public indexed column. Put the column name in brackets, for example filter[status]=active. active
sort query string optional Sort by a public sortable column. Prefix "-" means descending order. -updated_at
limit query integer optional Optional number of records from 1 to 1000; defaults to 100. Zero is not allowed. 100
offset query integer optional Optional non-negative integer offset; defaults to 0. -
Columns 7
Column Type Description Semantics Filtering Sorting
Building identifier identyfikator VARCHAR(100) - - yes yes
Building function funkcja VARCHAR(100) - - yes yes
Footprint area [m²] powierzchnia_zabudowy_m2 DECIMAL(20,4) - - no no
Total area [m²] powierzchnia_calkowita_m2 DECIMAL(20,4) - - no no
Construction completion year rok_zakonczenia_budowy INTEGER - - yes yes
Building footprint geometry GEOMETRY(MULTIPOLYGON,2178) - - yes no
URI _uri URL Stable semantic URI generated from the unique table column. Semantic URI identifier no no
Filters 4
Name Type Required Mode example
identyfikator VARCHAR(100) optional exact match filter[identyfikator]=sample
funkcja VARCHAR(100) optional exact match filter[funkcja]=sample
rok_zakonczenia_budowy INTEGER optional range: min and/or max (or equality) filter[rok_zakonczenia_budowy][min]=10&filter[rok_zakonczenia_budowy][max]=100
geometry GEOMETRY(MULTIPOLYGON,2178) optional bbox: xmin,ymin,xmax,ymax filter[geometry]=20.58,50.82,20.72,50.90
Request
GET /api/public/budynki/budynki_publiczne/data?columns=identyfikator,funkcja&limit=10&offset=0
Response
{
    "tableName": "budynki_publiczne",
    "columns": [
        {
            "name": "identyfikator",
            "type": "VARCHAR(100)",
            "filterable": true,
            "requiredFilter": false,
            "sortable": true,
            "label": "Building identifier",
            "description": null,
            "semanticRole": null,
            "semanticPredicate": null
        },
        {
            "name": "funkcja",
            "type": "VARCHAR(100)",
            "filterable": true,
            "requiredFilter": false,
            "sortable": true,
            "label": "Building function",
            "description": null,
            "semanticRole": null,
            "semanticPredicate": null
        }
    ],
    "requiredFilters": [],
    "allowedFilters": [
        "identyfikator",
        "funkcja"
    ],
    "pagination": {
        "limit": 10,
        "offset": 0,
        "count": 1,
        "total": 1
    },
    "filters": [],
    "items": [
        {
            "identyfikator": "sample",
            "funkcja": "sample"
        }
    ]
}