hamburg 4.0.0

Asynchronous Python client for the urban datasets of Hamburg (Germany).

About

A python package with which you can retrieve data from the Urban Data Platform of Hamburg via their API. This package was initially created to only retrieve parking data from the API, but the code base is made in such a way that it is easy to extend for other datasets from the same platform.

Complete source collections

await client.park_and_ride_collection(max_records=10000) returns Collection[ParkAndRide] with records, total_count, pages_fetched and complete. The generic Collection[T] model is shared by source record types; the method selects the P+R dataset. Retrieval checks numberMatched, numberReturned and original IDs across offset pages; changing counts, duplicates, incomplete pages and exceeded safety ceilings raise rather than return a partial collection. No dataset-wide transactional revision is available.

await client.disabled_parking_collection(max_records=10000) returns Collection[DisabledParking] for the complete disabled-parking dataset. The disabled-parking method uses the current official behindertenstellplaetze collection ID, also used by disabled_parkings(). Both methods use the same bounded pagination and count/ID validation; the existing limited list methods remain available.

Source counts and measurement dates can be absent. P+R timestamps use Berlin seasonal time; ambiguous/nonexistent local times at DST transitions remain unknown. The package does not infer an observation time from the request time or promise that every site's reading is current.

Installation

pip install hamburg

Datasets

You can read the following datasets with this package:

• Disabled parking spaces / Behindertenstellplätze (901)
• Park and rides occupancy / Park + Ride Anlagen (33)
• Garages occupancy / Parkhäuser (45 live data / 124 total)

There are a number of parameters you can set to retrieve the data:

• limit (default: 10) - How many results you want to retrieve.

Example

import asyncio

from hamburg import UDPHamburg


async def main() -> None:
    """Show example on using the UDP Hamburg API client."""
    async with UDPHamburg() as client:
        disabled_parkings = await client.disabled_parkings()
        park_and_rides = await client.park_and_rides()
        garages = await client.garages()
        print(disabled_parkings)
        print(park_and_rides)
        print(garages)


if __name__ == "__main__":
    asyncio.run(main())

Use cases

NIPKaart.nl

A website that provides insight into where disabled parking spaces are, based on data from users and municipalities. Operates mainly in the Netherlands, but also has plans to process data from abroad.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We've set up a separate document for our contribution guidelines.

Thank you for being involved! 😍

Setting up development environment

The simplest way to begin is by utilizing the Dev Container feature of Visual Studio Code or by opening a CodeSpace directly on GitHub. By clicking the button below you immediately start a Dev Container in Visual Studio Code.

This Python project relies on uv as its dependency manager, providing comprehensive management and control over project dependencies.

You need at least:

• Python 3.12+
• uv

Complete source collections

await client.park_and_ride_collection(max_records=10000) returns Collection[ParkAndRide] with records, total_count, pages_fetched and complete. The generic Collection[T] model is shared by source record types; the method selects the P+R dataset. Retrieval checks numberMatched, numberReturned and original IDs across offset pages; changing counts, duplicates, incomplete pages and exceeded safety ceilings raise rather than return a partial collection. No dataset-wide transactional revision is available.

await client.disabled_parking_collection(max_records=10000) returns Collection[DisabledParking] for the complete disabled-parking dataset. The disabled-parking method uses the current official behindertenstellplaetze collection ID, also used by disabled_parkings(). Both methods use the same bounded pagination and count/ID validation; the existing limited list methods remain available.

Source counts and measurement dates can be absent. P+R timestamps use Berlin seasonal time; ambiguous/nonexistent local times at DST transitions remain unknown. The package does not infer an observation time from the request time or promise that every site's reading is current.

Installation

Install all packages, including all development requirements:

uv sync --locked

uv creates a project virtual environment in .venv and installs the locked dependencies.

Prek

This repository uses the prek framework, all changes are linted and tested with each commit. To setup the prek check, run:

uv run prek install

And to run all checks and tests manually, use the following command:

uv run prek run --all-files

Testing

It uses pytest as the test framework. To run the tests:

uv run pytest

To update the syrupy snapshot tests:

uv run pytest --snapshot-update

License

MIT License

Copyright (c) 2022-2026 Klaas Schoute

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.