Authentifizierung

Zur Verwendung der API musst du dich mit einem API-Key authentifizieren. Dazu wird HTTP Basic Authentication verwendet. Der API-Key ist als Benutzernamen einzugeben. Ein Passwort ist nicht erforderlich.

Der Host für alle APIs lautet: http://api.opendata.host/

address/find

Sucht Adressen in Österreich und spielt Postleitzahl, Ort, Straße, Hausnummer, sowie Longitude und Latitude als Ergebnis aus. Es muss mindestens ein Suchparameter (zip, city, street-address, street-number) angegeben werden.

Pro Request werden kostenfrei maximal 100 Datensätze ausgegeben.

 

URL:

http://api.opendata.host/1.0/address/find?country=xx&zip=xxx&city=xxx&street-address=xxx&street-number=xxx&offset=xxx&limit=xxx 
 

Beispiel:

http://api.opendata.host/1.0/address/find?country=at&zip=1190&city=Wien&street-address=Grinzin&street-number=14&offset=1&limit=2

Parameter

country	Land, default at
zip	Postleitzahl
city	Stadt oder Gemeinde
street-address	Straßenname
street-number	Hausnummer
limit	Anzahl der maximal angezeigten Ergebnisse, default 100
offset	Index des Startelements, default 0

Resultat

Erfolg

/1.0/address/find?country=at&zip=1190&city=Wien&street-address=Grinzin&street-number=14&offset=1&limit=2
 {
   addresses:  [
      {
         postalCode:  "1190",
         city:  "Wien",
         street:  "Grinzinger Steig",
         houseNumber:  "14",
         longitude:  16.3444433854524,
         latitude:  48.258507347356
      },
      {
         postalCode:  "1190",
         city:  "Wien",
         street:  "Grinzinger Straße",
         houseNumber:  "149",
         longitude:  16.366989618421,
         latitude:  48.2548247714943
      }
   ],
   offset:  1,
   limit:  2,
   size:  9,
   errorCode:  0
}

Fehler

/1.0/address/find?offset=1&limit=2
{
  size: 0,
  errorCode: 4,
  errorMessage: "Please restrict your search conditions"
} 

Fehlercodes

Folgende Fehlercodes werden verwendet:

Errorcode	Fehlergrund	Errormessage
0	Erfolg	keine Message
1	Keine Resultate gefunden	No results found
2	Keine Daten bei Compass gefunden	No data available
3	Eingabeparameter entsprechen nicht dem erwarteten Format (z.B. Firmennummer)	Invalid input format
4	Suche zu allgemein	Please narrow your search conditions
5	Unerwarteter Fehler	Internal error