odp-amsterdam 7.0.0

Asynchronous Python client for the open datasets of Amsterdam (The Netherlands).

About

A python package with which you can retrieve data from the Open Data Platform of Amsterdam 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.

Installation

pip install odp-amsterdam

Datasets

You can read the following datasets with this package:

• Parking garages occupancy / Garages parkeerbezetting (53 garages)
• Parking locations / Parkeervakken

locations() returns a ParkingLocations result with records, total_count, pages_fetched and complete. Without a limit it retrieves the full selection; with limit=10 it returns at most ten records. pages_fetched excludes the final source verification request.

complete indicates that all records reported by the source were received, including a verified empty selection. Inconsistent pages or changing totals raise ODPAmsterdamError. This does not guarantee an atomic source snapshot or current parking availability; inspect regimes for restrictions.

Usage

import asyncio

from odp_amsterdam import ODPAmsterdam


async def main():
    """Show example on using the ODP Amsterdam API client."""
    async with ODPAmsterdam() as client:
        # Parking locations
        locations = await client.locations(limit=5, parking_type="E6a")

        # Garages
        all_garages = await client.all_garages()
        garage = await client.garage(garage_id="ID_OF_GARAGE")

        print(locations.records)
        print(locations.total_count, locations.complete)
        print(all_garages)
        print(garage)


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! :heart_eyes:

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 project uses uv to manage dependencies and the development environment.

You need at least:

• Python 3.12+
• uv

Installation

Install all packages, including all development requirements:

uv sync --locked

uv installs the locked dependencies into .venv.

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) 2020-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.