Oceanographic Observation and Tidewater API
Click here for Swagger - Interactive API explorer (external site)
To execute calls the service input your api-key by clicking the "Authorize" button in Swagger
Quick start examples:
Example: https://dmigw.govcloud.dk/v2/oceanObs/collections/observation/items?api-key=<api-key>
Description: Will return up to 1000 (the default limit) observations
Example: https://dmigw.govcloud.dk/v2/oceanObs/collections/station/items?api-key=<api-key>
Description: Will return up to 1000 (the default limit) stations
The collection endpoints support a number of query parameters to filter or sort data. Make sure to read the query primer to make use of the below query parameters.
Example Response
{
"type": "FeatureCollection",
"features": [
{
"geometry": {
"coordinates": [
9.9625,
57.5951
],
"type": "Point"
},
"id": "02109a3a-769e-c02f-cc3d-6e0251ac9e96",
"type": "Feature",
"properties": {
"created": "2023-10-26T09:20:35.754319Z",
"observed": "2023-10-26T09:20:00Z",
"parameterId": "sealev_ln",
"qcStatus": "auto",
"stationId": "20047",
"value": -30.0
}
}
],
"timeStamp": "2023-10-26T09:24:45Z",
"numberReturned": 1,
"links": [
{
"href": "https://dmigw.govcloud.dk/v2/oceanObs/collections/observation/items?limit=1&sortorder=observed,DESC",
"rel": "self",
"type": "application/geo+json",
"title": "This document"
},
{
"href": "https://dmigw.govcloud.dk/v2/oceanObs/collections/observation/items?limit=1&sortorder=observed,DESC&offset=1",
"rel": "next",
"type": "application/geo+json",
"title": "Next set of results"
}
]
}
API
/collections
Example: https://dmigw.govcloud.dk/v2/oceanObs/collections
Description: Will return all available collections in the API. Available collections:
- station
- observation
- tidewater
- tidewaterstation
/collections/<collection name>/items
Query parameters:
Query examples
Examples:
Returns observations within the dates UTC 2018-02-12 at midnight and UTC 2018-03-18 at midnight (both dates are inclusive), and within the bounding box having the Southwesterly point of 7.0, 54.0 and northeasterly point of 16.0, 58.0 (which basically covers the area of Denmark), returning a maximum of 100 objects skipping the first 1000.
Returns observations within the dates UTC 2018-02-12 at midnight and UTC 2018-03-18 at midnight (both dates are inclusive), and limited to the station having the id "30017" and the parameter having the id "tw", returning a maximum of 20000 objects in total sorted by the "observed" time in descending order
Returns stations having the type "Tide-gauge-primary" and status "Active" and is within the bounding box having the Southwesterly point of 7.0, 54.0 and northeasterly point of 16.0, 58.0 (which basically covers the area of Denmark).
Returns tidewater predictions for January 2024 for station 20333
Response schema
Overall Structure
The API is an OGC API - Features API and follows this standard as documented here: http://docs.opengeospatial.org/is/17-069r3/17-069r3.html (external site).
Data is returned in a FeatureCollection object that describes the returned data-set. Data points are found in the features field which contains a number of Feature objects as described below.
FeatureCollection
Feature objects are wrapped in a GeoJSON FeatureCollection (external site), which include:
Generic Fields for Every Feature
Observation
This is a GeoJSON feature (external site) and the table below describes the returned data:
properties.qcStatus
properties.qcResult
Station
This is a GeoJSON feature (external site) and the table below describes the returned data:
Tidewater
This is a GeoJSON feature (external site) and is similar to the schema for observations, but have predictionTime and predictionType that are unique.
Tidewaterstation
This is a GeoJSON feature (external site) and the table below describes the returned data:
