Endpoints

Tip

If you prefer to use Swagger to understand the API capabilities, see OpenAPI docs.

Listing Datasets

All available dataset endpoints are listed in https://dataset.api.hub.geosphere.at/v1/datasets.

Dataset Endpoint Structure.

An dataset endpoint consists of five parts:

  • a host

  • a version

  • a type

  • a mode

  • and a resource_id

and are put together like this

<host>/<version>/<type>/<mode>/<resource_id>

where

<host>:

is https://dataset.api.hub.geosphere.at

<verion>:

is v1

<type>:

is either grid, timeseries or station, see Types

<mode>:

is either historical, current, or forecast, see Modes

<resource_id>:

is one of the resources listed in Resources.

Note

The host https://dataset.api.hub.zamg.ac.at is deprecated.

Tip

The resource determines the available types and mode.

For example weather stations will always have the station type.

Tip

Some API parameters are mode and type specific.

Metadata

All dataset endpoints have metadata which can be requested by appending /metadata to the dataset endpoint.

Metadata contain amongst other helpful information about the request parameters like the range of allowed values.