Home

Welcome to the public documentation of PegelAlarm REST services!

The PegelAlarm REST API provides programmatic access to read, write, ... PegelAlarm data. For questions or a free test-account contact us at office@sobos.at.

First steps - Needed!

1. Authentication

• Login and apiKey creation
• Creating an authentication token

Often used

1. Download water data

• Search station(s) and Download current water data of one or more stations
• Download historic water data of one station
• Download predicted water data of one station

2. Register for flood warnings (SMS, Email,..) for a specific station

• Query your registered flood warnings
• Register your phone number or email address for flood warnings at a specific station
  • Request a code to verify your phone number or email address
  • Verify your phone number or email address using the requested code
• Un-register your phone number or email address from flood warnings at a specific station

3. Register for flood warnings (SMS, Email,..) for a specific region

• Create, read, update or delete a warning region
• Register your phone number or email address for flood warnings for a specific region

Provide your gauge- and waterlevel data to PegelAlarm

1. Use our REST-API to push data directly to our backend servers

• Create new or update existing station
• Add new current water level data to a station
• Add new water level forecast data to a station

Embed PegelAlarm widgets into your website

1. Lists, charts and images

• Embed now

Pricing

Data retrieval is free for science projects and during the time of software development and integration work. After that, our prices depend on

• your pricing strategy
• the number of users you provide data to and
• the data request frequency.