https://github.com/larsdecker/pegelonline-api-client
A wrapper for the Pegelonline API. The API Endpoint is free of charge and can be used without registration. The API provided data about water levels, water temperatures and discharge rates of rivers in Germany. The data is provided by the Federal Waterways and Shipping Administration (WSV).
https://github.com/larsdecker/pegelonline-api-client
Last synced: 4 months ago
JSON representation
A wrapper for the Pegelonline API. The API Endpoint is free of charge and can be used without registration. The API provided data about water levels, water temperatures and discharge rates of rivers in Germany. The data is provided by the Federal Waterways and Shipping Administration (WSV).
- Host: GitHub
- URL: https://github.com/larsdecker/pegelonline-api-client
- Owner: larsdecker
- Created: 2023-06-16T10:37:23.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-10-02T03:37:03.000Z (over 1 year ago)
- Last Synced: 2025-01-11T02:29:09.641Z (5 months ago)
- Language: TypeScript
- Size: 745 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# pegelonline-api-client
A wrapper for the Pegelonline API. The API Endpoint is free of charge and can be used without registration. The API provided data about water levels, water temperatures and discharge rates of rivers in Germany. The data is provided by the Federal Waterways and Shipping Administration (WSV).
The wrapper is written in Typescript and can be used in Node.js and in the browser.
## Installation
```
npm install pegelonline-api-client
```
## Usage
### Node.js
```javascript
const PegelonlineApi = require('pegelonline-api-client').PegelOnlineApiClient;
const api = new PegelOnlineApiClient();
const station = await api.getStationDetails('c0ec139b-13b4-4f86-bee3-06665ad81a40');
```
### Browser
```javascript
import { PegelOnlineApiClient } from 'pegelonline-api-client';
const api = new PegelOnlineApiClient();
const station = await api.getStationDetails('c0ec139b-13b4-4f86-bee3-06665ad81a40');
```