API - TPIRequest

Application Programming Interface (API)

API-Attribute 'TPIRequest'

Der API-Aufruf 'TPIRequest' generiert eine kolorierte Abbildung des Topographic Position Index (TPI) für einen Kartenausschnitt von 1x1 km. Der Kartenausschnitt wird durch einen beliebigen Referenzpunkt bestimmt. Der Referenzpunkt kann in den Koordinatensystemen Longitude/Latitude oder UTM angegeben werden. Die Antwort enthält die kolorierte TPI-Abbildung im GeoTIFF- oder PNG-Format (Base64-kodiert), sowie Metadaten zur Quelle und Attributierung.

Es ist eine Farbtextdatei für die Kolorierung zu übergeben. Die Antwort kann Daten für eine, zwei oder drei Kacheln enthalten, falls eine Landesgrenze den Bereich schneidet.

Attribut	Subattribut	Datentyp	Beschreibung
Type		string	Typ der Anfrage (TPIRequest)
ID		string	Eindeutige ID der Anfrage
Attributes		struct	Attribute der Anfrage
	Zone	int	UTM Zone Referenzpunkt
	Easting	float	Easting, X, Ostwert Referenzpunkt
	Northing	float	Northing, Y, Nordwert Referenzpunkt
	Longitude	float	Längengrad Referenzpunkt (Dezimalgrad)
	Latitude	float	Breitengrad Referenzpunkt (Dezimalgrad)
	ColorTextFileContent	[]string	Inhalt der Farbtextdatei für die Kolorierung des TPI
	ColoringAlgorithm	string	Algorithmus für Zuweisung 'Wert zu Farbe' ('interpolation' oder 'rounding')

API-Attribute 'TPIResponse'

Attribut	Subattribut	Subattribut	Datentyp	Beschreibung
Type			string	Typ der Antwort (TPIResponse)
ID			string	ID der Antwort
Attributes			struct	Attribute der Antwort
	Zone		int	UTM Zone des angefragten Referenzpunkts
	Easting		float	Easting, X, Ostwert des angefragten Referenzpunkts
	Northing		float	Northing, Y, Nordwert des angefragten Referenzpunkts
	Longitude		float	Längengrad des angefragten Referenzpunkts (Dezimalgrad)
	Latitude		float	Breitengrad des angefragten Referenzpunkts (Dezimalgrad)
	ColorTextFileContent		[]string	Inhalt der Farbtextdatei für die Kolorierung des TPI
	ColoringAlgorithm		string	Algorithmus für Zuweisung 'Wert zu Farbe'
	TPIs		[]struct	Array von kolorierten TPI Abbildungen
		Data	string (Base64)	Kolorierte TPI Abbildung für die Kachel
		DataFormat	string	Format der Daten (GeoTIFF oder PNG)
		Actuality	string	Aktualität der Daten
		Origin	string	Herkunft der Daten
		Attribution	string	Attribution der Daten
		TileIndex	string	Index der Quelldatenkachel
		BoundingBox	struct	WGS84 Georeferenz (relevant bei PNG)
	IsError		bool	Fehler (ja/nein)
	Error		struct	Fehlerdetails
		Code	string	Fehlernummer
		Title	string	Fehlerbeschreibung
		Details	string	Fehlerdetaillierung

Eingabe:

Aus den Koordinaten eines Referenzpunkts wird die Kachel (1x1 km) abgeleitet, für die die TPI-Abbildungen erstellt werden.
Mögliche Koordinatensysteme:

Lon/Lat-Koordinaten (WGS84, EPSG:4326).
UTM-Koordinaten (EPSG:25832 / EPSG:25833).

Ausgabe:

Abhängig vom Eingabeformat werden unterschiedliche Ausgabeformate erzeugt:

PNG in der Projektion EPSG:3857 (Webmercator) mit expliziter Georeferenzierung durch Lon/Lat-Koordinaten (WGS84, EPSG:4326).
GeoTIFF in der Projektion der DGM1-Ausgangsdaten (EPSG:25832 / EPSG:25833) mit impliziter Georeferenzierung in den Metadaten.

Anmerkungen:

Ein Kartenausschnitt wird in der Regel durch genau eine Kachel repräsentiert.
Verläuft eine Landesgrenze durch eine Kachel, wird sie von allen betroffenen Bundesländer (2 oder 3) zur Verfügung gestellt.
Entsprechend enthält das Feld 'Attributes.TPIs' die Daten für eine, zwei oder maximal drei Kacheln.
Der Body der Antwort ist komprimiert (gzip).

TPIRequest (Beispiel)


#!/bin/bash
#
# Abfrage TPI für eine Kachel mit 1000x1000 Meter. 

postdata=$(cat <<EOF
{
  "Type": "TPIRequest",
  "ID": "Hegekopf, Edersee, Hessen",
  "Attributes": {
    "Zone": 0,
    "Easting": 0.0,
    "Northing": 0.0,
    "Longitude": 8.964229,
    "Latitude": 51.185913,
    "ColorTextFileContent": [
      "# Farbdefinition für TPI",
      "# Format: Wert Rot Grün Blau Alpha",
      "# Senken: kleiner -0.05",
      "# Ebenen: -0.05 ... 0.05",
      "# Kuppen: größer 0.05",
      "-0.050001 0 0 0 255",
      "-0.05 255 255 255 255",
      "0.05 255 255 255 255",
      "0.050001 0 0 0 255",
      "nv 0 0 0 0"
    ],
    "ColoringAlgorithm": "interpolation"
  }
}
EOF
)

echo "postdata = $postdata"

curl \
--silent \
--include \
--compressed \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "Accept-Encoding: gzip" \
--data "$postdata" \
https://api.hoehendaten.de:14444/v1/tpi

TPIResponse:


HTTP/2 200
access-control-allow-headers: Content-Type
access-control-allow-methods: POST
access-control-allow-origin: *
content-encoding: gzip
content-type: application/json; charset=utf-8
date: Tue, 05 Aug 2025 14:04:27 GMT

{
  "Type": "TPIResponse",
  "ID": "Hegekopf, Edersee, Hessen",
  "Attributes": {
    "Zone": 0,
    "Easting": 0,
    "Northing": 0,
    "Longitude": 8.964229,
    "Latitude": 51.185913,
    "ColorTextFileContent": [
      "# Farbdefinition für TPI",
      "# Format: Wert Rot Grün Blau Alpha",
      "# Senken: kleiner -0.05",
      "# Ebenen: -0.05 ... 0.05",
      "# Kuppen: größer 0.05",
      "-0.050001 0 0 0 255",
      "-0.05 255 255 255 255",
      "0.05 255 255 255 255",
      "0.050001 0 0 0 255",
      "nv 0 0 0 0"
    ],
    "ColoringAlgorithm": "interpolation",
    "TPIs": [
      {
        "Data": "iVBORw0KGgoAAAANSUhEUgAAA+cAAAPqCAYAAAD ... sLCA/B/Q+5Z18++tGoAAAAASUVORK5CYII=",
        "DataFormat": "png",
        "Actuality": "2021-04-26",
        "Origin": "DE-HE",
        "Attribution": "Geobasisdaten © Hessische Verwaltung für Bodenmanagement und Geoinformation, dl-de/by-2-0",
        "TileIndex": "32_497_5670",
        "BoundingBox": {
          "MinLon": 8.95707049585795,
          "MaxLon": 8.971385896601037,
          "MinLat": 51.18141399484732,
          "MaxLat": 51.190410580109756
        }
      }
    ],
    "IsError": false,
    "Error": {
      "Code": "",
      "Title": "",
      "Detail": ""
    }
  }
}