Skip to main content

A Python wrapper for the Rijkswaterstaat WaterWebservices (ddapi20) API. Simplifies downloading observation data, forecasts, tidal extremes, chemical concentrations and more.

Project description

How to use

Provide user documentation here.

Installation

To install rws_waterinfo, do:

pip install rws-waterinfo

Run tests with:

pip install -r requirements-dev.txt
pytest

Example

Get observation data from Waterinfo using the ddapi20 API.

Location coordinates are no longer required; use the unified location codes (for example ameland.nes or hoekvanholland).

The primary change is the parameter format: the library now expects a list of lists (7 items) instead of the older 9-item format with X/Y coordinates.

New format (each inner list):

  • compartiment_code

  • eenheid_code

  • meetapparaat_code

  • grootheid_code

  • locatie_code

  • start_date (YYYY-MM-DD)

  • end_date (YYYY-MM-DD)

By default the client uses parallel downloads for better performance. Use the max_workers argument to control concurrency.

import pandas as pd
import rws_waterinfo as rw

# Initialize rws_waterinfo library
params = [
    ["OW", "", "", "WATHTE", "ameland.nes", "2025-12-01", "2026-01-01"]
]

# Default is parallel download; specify max_workers if needed
df = rw.get_data(params=params, return_df=True, max_workers=8)
print(df.head())

This function sends a request to Waterinfo for parameter information and parses the response into a Pandas DataFrame. The DataFrame contains the locations and parameters combined into a single table.

import pandas as pd
import rws_waterinfo as rw

catalog = rw.get_catalog()
print(catalog.head())

License

Copyright (c) 2026, Rijkswaterstaat

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rws_waterinfo-1.0.0.tar.gz (19.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rws_waterinfo-1.0.0-py3-none-any.whl (14.0 kB view details)

Uploaded Python 3

File details

Details for the file rws_waterinfo-1.0.0.tar.gz.

File metadata

  • Download URL: rws_waterinfo-1.0.0.tar.gz
  • Upload date:
  • Size: 19.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for rws_waterinfo-1.0.0.tar.gz
Algorithm Hash digest
SHA256 b2e5d15236d9b0a86fc32250b96f7789c41320a8c79ae8d7b14b451c0dc7d495
MD5 1a7b58e9feffc6fd685785f7fc2d2bb9
BLAKE2b-256 b787cf08d4220bcab3f20b34dff8958834436d1113576ab76cedf4bc560e7bed

See more details on using hashes here.

File details

Details for the file rws_waterinfo-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: rws_waterinfo-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 14.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for rws_waterinfo-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3aad4af147770034ad2413a473b24daed24c53597be87e73435838ee6621f831
MD5 2b87f55458983f9d712bdc745e326035
BLAKE2b-256 bd48e65669ae67311be523604872888f494eafed5d0d61df159e8676e123c53f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page