Getting Started
Endpoint Structure
An API endpoint typically consists of:
<host>/<version>/<type>/<mode>/<resource_id>
where
<url>
:is
https://dataset.api.hub.geosphere.at
<version>
:is
v1
<type>
:is either
grid
,timeseries
orstation
, see Types<mode>
:is either
historical
,current
orforecast
, see Modes<resource_id>
:is one of the resources listed in Resources.
Note
Not for every permutation of type, mode and resource_id exists an endpoint.
All datasets can be listed via https://dataset.api.hub.geosphere.at/v1/datasets.
Furthermore, all endpoints metadata can be requested by appending /metadata
.
Example
In this example we want to get the current air temperature from the TAWES station WIEN/HOHE WARTE
.
From https://dataset.api.hub.geosphere.at/v1/datasets we know the endpoint
https://dataset.api.hub.geosphere.at/v1/station/current/tawes-v1-10min
will provide the data.
The endpoint requires request parameters parameters
and station_ids
. From the metadata
https://dataset.api.hub.geosphere.at/v1/station/current/tawes-v1-10min/metadata
we find the parameter name TL
for air temperature and station_id 11035
for WIEN/HOHE WARTE
. This results in:
https://dataset.api.hub.geosphere.at/v1/station/current/tawes-v1-10min?parameters=TL&station_ids=11035
parameters
and station_ids
are array types. You can pass multiple values either as a comma-separated string,
e.g. parameters=TL,TLMAX
or you pass the query parameter multiple times, e.g. parameters=TL¶meters=TLMAX
Tip
If you prefer to use Swagger to understand the API capabilities, see OpenAPI docs
Further information
- User Guide:
User Guide.
- Data Portal:
Graphical user interface.
- List all endpoints:
API endpoint listing all available dataset endpoints.
- OpenAPI docs:
API endpoint documentation.