Developer Overheid Open Source Register
Developer Overheid Open Source Register
Download OpenAPI specification:Download
KNMI OpenAPI specification
| code required | string [ 4 .. 7 ] characters ^[1-9][0-9]{3}( ?(?!SA|SD|SS)[A-Z]{2})? Example: code=3731 GA Retrieve information associated with a specific postal code. The postal code should be formatted as four digits, or as four digits, followed by a space and two letters in capitals. |
{- "name": "De Bilt",
- "disambiguator": "Utrecht",
- "postalCode": 3731,
- "geoPoint": {
- "lat": 52.1213856642,
- "lon": 5.19097860256,
- "projection": "epsg4326"
}
}{- "regions": [
- {
- "region": 0,
- "alerts": [
- {
- "level": "red",
- "weatherType": 1372,
- "title": "Code oranje: hitte",
- "description": "Code rood voor een zware storm vanavond 20:00 tot morgen 06:00."
}
]
}
], - "title": "Vandaag en morgen extreme hitte in het hele land",
- "description": "Vandaag en morgen wordt het tropisch warm. Daarom is het Nationaal hitteplan (RIVM) van kracht. Vanaf vanmiddag tot morgen avond geldt code oranje voor zeer hoge temperaturen, met maximumtemperaturen van 38-39°C.\n",
- "alerts": [
- {
- "region": 0,
- "level": "red"
}
], - "advice": [
- {
- "level": "red",
- "weatherType": 1372,
}
]
}| location required | string The location for which precipitation graph information is requested |
| time required | string <date-time> The date and time for which precipitation graph information is requested, which should be rounded to 5 minutes. |
{- "time": "2024-02-14T07:19:00Z",
- "precipitation": {
- "times": [
- "2024-02-14T23:00:00Z"
], - "amounts": [
- 0
]
}
}| location required | string The location for which precipitation graph information is requested |
| time required | string <date-time> The date and time for which precipitation graph information is requested, which should be rounded to 5 minutes. |
{- "time": "2024-02-14T07:19:00Z",
- "precipitation": {
- "times": [
- "2024-02-14T23:00:00Z"
], - "amounts": [
- 0
]
}
}| location required | string The location for which weather information is requested |
| region | integer The region for which weather information is requested |
{- "backgrounds": [
- {
- "dateTime": "2024-02-14T23:00:00Z",
- "sky": "dayClear",
- "celestial": "sun",
- "clouds": "dayMist",
- "precipitation": "lightRain"
}
], - "summaries": [
- {
- "dateTime": "2024-02-14T23:00:00Z",
- "temperature": 24
}
], - "alerts": [
- {
- "level": "red",
- "title": "Weeralarm: zware storm",
- "description": "Code rood voor een zware storm vanavond 20:00 tot morgen 06:00."
}
], - "hourly": {
- "forecast": [
- {
- "dateTime": "2024-02-14T23:00:00Z",
- "alertLevel": "red",
- "weatherType": 1372,
- "temperature": -7,
- "precipitation": {
- "amount": 0,
- "chance": 0
}, - "wind": {
- "source": "N",
- "speed": 0,
- "gusts": 0,
- "degree": 345,
- "beaufort": 7
}
}
]
}, - "daily": {
- "forecast": [
- {
- "date": "2024-02-14T00:00:00Z",
- "alertLevels": [
- "red"
], - "weatherType": 1372,
- "temperature": {
- "min": -7,
- "max": 24
}, - "precipitation": {
- "amount": 0,
- "chance": 0
}
}
]
}, - "sun": {
- "sunrise": "2024-02-14T07:19:00Z",
- "sunset": "2024-02-14T17:09:00Z"
}, - "wind": {
- "source": "N",
- "speed": 0,
- "gusts": 0,
- "degree": 345,
- "beaufort": 7
}, - "uvIndex": {
- "value": 7,
- "summary": "Ga niet langer dan 1 uur onbeschermd de zon in"
}
}| location required | string The location for which weather information is requested |
| region | integer The region for which weather information is requested |
| date required | string <date-time> Example: date=2024-02-14T00:00:00Z The date for which weather information is requested |
{- "alerts": [
- {
- "level": "red",
- "description": "Code rood voor een zware storm vanavond 20:00 tot morgen 06:00."
}
], - "hourly": {
- "forecast": [
- {
- "dateTime": "2024-02-14T23:00:00Z",
- "alertLevel": "red",
- "weatherType": 1372,
- "temperature": -7,
- "precipitation": {
- "amount": 0,
- "chance": 0
}, - "wind": {
- "source": "N",
- "speed": 0,
- "gusts": 0,
- "degree": 345,
- "beaufort": 7
}
}
]
}, - "daily": {
- "temperature": {
- "dates": [
- "2024-02-14T23:00:00Z"
], - "minTemperatures": [
- 0
], - "lowerMinTemperatures": [
- 0
], - "upperMinTemperatures": [
- 0
], - "maxTemperatures": [
- 0
], - "lowerMaxTemperatures": [
- 0
], - "upperMaxTemperatures": [
- 0
]
}, - "precipitation": {
- "dates": [
- "2024-02-14T23:00:00Z"
], - "amounts": [
- 0
], - "lowerAmounts": [
- 0
], - "upperAmounts": [
- 0
]
}
}, - "precipitationChance": {
- "chance": 0,
- "summary": "Het blijft droog"
}, - "sunshine": {
- "hours": 2,
- "description": "Een bewolkte dag"
}, - "wind": {
- "source": "N",
- "speed": 0,
- "gusts": 0,
- "degree": 345,
- "beaufort": 7
}, - "climate": {
- "month": 2,
- "currentTemperatureRange": {
- "min": -7,
- "max": 24
}, - "averageTemperatureRange": {
- "min": -7,
- "max": 24
}, - "label": "Gemiddeld in [begin|midden|end] februari\"",
- "summary": "Rond 2050 is de temperatuur in de winter tussen de 0,5°C en 1,2°C hoger dan gemiddeld (1991-2020)."
}, - "sun": {
- "sunrise": "2024-02-14T07:19:00Z",
- "sunset": "2024-02-14T17:09:00Z"
}, - "uvIndex": {
- "value": 7,
- "summary": "Ga niet langer dan 1 uur onbeschermd de zon in"
}
}| location required | string The location for which weather information is requested |
| region | integer The region for which weather information is requested |
{- "alertLevel": "red",
- "temperature": 24,
- "weatherType": 1372
}{- "activities": [
- {
- "id": "string",
- "time": "2019-08-24T14:15:22Z",
- "geoPoint": {
- "lat": 52.1213856642,
- "lon": 5.19097860256,
- "projection": "epsg4326"
}, - "description": "Er is vandaag om 14:06 bij Appingendam, Groningen een geïnduceerde aardbeving geweest, met een grootte van 0.3 op 3.0 km diepte.",
- "kind": "induced",
- "magnitude": 0,
- "reviewed": true,
}
]
}| unit required | string (MeasurementUnit) Enum: "beaufort" "kilometerPerHour" "degreeCelsius" "percentage" The unit in which the measurements on the map and in the legend should be returned. Wind speed is measured in Beaufort. |
{- "time": "2024-02-14T07:19:00Z",
- "legend": {
- "unit": "beaufort",
- "steps": [
- {
- "value": 1,
- "color": "#FF0000"
}
]
}, - "links": {
- "detail": "string"
}
}| unit required | string (MeasurementUnit) Enum: "beaufort" "kilometerPerHour" "degreeCelsius" "percentage" The unit in which the measurements on the map and in the legend should be returned. Wind gusts are measured in km/h. |
{- "time": "2024-02-14T07:19:00Z",
- "legend": {
- "unit": "beaufort",
- "steps": [
- {
- "value": 1,
- "color": "#FF0000"
}
]
}, - "links": {
- "detail": "string"
}
}| unit required | string (MeasurementUnit) Enum: "beaufort" "kilometerPerHour" "degreeCelsius" "percentage" The unit in which the measurements on the map and in the legend should be returned. Temperature is measured in degrees Celcius. |
{- "time": "2024-02-14T07:19:00Z",
- "legend": {
- "unit": "beaufort",
- "steps": [
- {
- "value": 1,
- "color": "#FF0000"
}
]
}, - "links": {
- "detail": "string"
}
}| unit required | string (MeasurementUnit) Enum: "beaufort" "kilometerPerHour" "degreeCelsius" "percentage" The unit in which the measurements on the map and in the legend should be returned. Relative humidity is measured in percentages. |
{- "time": "2024-02-14T07:19:00Z",
- "legend": {
- "unit": "beaufort",
- "steps": [
- {
- "value": 1,
- "color": "#FF0000"
}
]
}, - "links": {
- "detail": "string"
}
}Allows users to subscribe for notifications.
| subscriberId required | string <uuid> A unique user identifier, ideally a UUID >= v5 |
| deviceToken required | string The globally unique device token |
| deviceFamily required | string (DeviceFamily) Enum: "ios" "android" Type of the device being subscribed (e.g., ios or android) |
| locale | string (Locale) An identifier that represents the subscriber's language, in IETF BCP 47 format. This identifier typically consists of an ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value. For example, the locale code for the Netherlands is nl_NL. |
| debug | boolean When in debug the APNS mode will be set to sandbox (only available on non-prod envs) |
{- "deviceToken": "00fc13adff785122b4ad28809a3420982341241421348097878e577c991de8f0",
- "deviceFamily": "ios",
- "locale": "nl_NL",
- "debug": true
}{- "status": 0,
- "title": "string",
- "correlationId": "string"
}Retrieve the notification settings for a user.
| subscriberId required | string <uuid> A unique user identifier, ideally a UUID >= v5 |
{- "weather": {
- "alertLevel": "red",
- "useMyLocation": true,
- "regions": [
- 0
]
}, - "seismic": {
- "induced": true,
- "natural": true,
- "unreviewed": true,
- "other": true
}
}Update the notification settings for a user.
| subscriberId required | string <uuid> A unique user identifier, ideally a UUID >= v5 |
required | object (WeatherNotificationSettings) |
required | object (SeismicNotificationSettings) |
{- "weather": {
- "alertLevel": "red",
- "useMyLocation": true,
- "regions": [
- 0
]
}, - "seismic": {
- "induced": true,
- "natural": true,
- "unreviewed": true,
- "other": true
}
}{- "weather": {
- "alertLevel": "red",
- "useMyLocation": true,
- "regions": [
- 0
]
}, - "seismic": {
- "induced": true,
- "natural": true,
- "unreviewed": true,
- "other": true
}
}