Address API
Autofill vervollständigt eine Postadresse beim Tippen. Die Validierung prüft eine Adresse gegen das amtliche Register.
Basis-URL: https://api.mapx.at · Rate-Limit-Zone: search (10/s) · Guide: Suche
Address Autofill: suggestions
GET /v1/autofill/suggest
Official address register only (BEV). Completes street, house number, postcode and place; fields separated in suggestions[].
Parameter
| Name | Ort | Typ | Pflicht | Standard | Beschreibung |
|---|---|---|---|---|---|
q | query | string | ja | – | Partial input, e.g. Hauptpl 3 Mel |
session_token | query | string | – | Session id (1 to 64 characters), echoed back | |
proximity | query | string | – | lon,lat, prefers near addresses | |
limit | query | string | 5 | 1 to 10, default 5 |
Beispiel
curl -s -H "Authorization: Bearer YOUR_TOKEN" "https://api.mapx.at/v1/autofill/suggest?q=Herrengasse%2013%20Wien&limit=3" | jqBeispielantwort
{
"session_token": "abc-1",
"suggestions": [
{
"id": "address-1234567",
"address_line1": "Hauptplatz 3",
"street": "Hauptplatz",
"housenumber": "3",
"postcode": "3390",
"place": "Melk",
"full_address": "Hauptplatz 3, 3390 Melk",
"coordinates": [
15.3298,
48.2273
]
}
]
}Fehler (Details: Fehlerkatalog)
| Status | Bedeutung |
|---|---|
400 | Parameter fehlt oder ist ungültig |
401 | Token fehlt oder ungültig (missing-token, invalid-token, token-expired) |
403 | Token nicht erlaubt (origin-not-allowed, origin-missing, pk-not-allowed, app-not-allowed, token-blocked, ip-not-allowed) |
429 | Rate-Limit überschritten, Retry-After abwarten |
502 | Vorgelagerter Dienst nicht erreichbar |
Address Autofill: retrieve the chosen address
GET /v1/autofill/retrieve/{id}
id from suggestions[].id (address-<AdrCD>). FeatureCollection with one point feature, properties as in suggest.
Parameter
| Name | Ort | Typ | Pflicht | Standard | Beschreibung |
|---|---|---|---|---|---|
id | path | string | ja | – | Address id from suggest |
session_token | query | string | – | As in suggest |
Beispiel
curl -s -H "Authorization: Bearer YOUR_TOKEN" "https://api.mapx.at/v1/autofill/retrieve/address-7065749" | jqBeispielantwort
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
15.3298,
48.2273
]
},
"properties": {
"name": "Hauptplatz 3"
}
}
]
}Fehler (Details: Fehlerkatalog)
| Status | Bedeutung |
|---|---|
400 | Parameter fehlt oder ist ungültig |
401 | Token fehlt oder ungültig (missing-token, invalid-token, token-expired) |
403 | Token nicht erlaubt (origin-not-allowed, origin-missing, pk-not-allowed, app-not-allowed, token-blocked, ip-not-allowed) |
404 | Nicht gefunden (Name, Pfad oder Position) |
429 | Rate-Limit überschritten, Retry-After abwarten |
Address Validation (free text or structured)
GET /v1/address/validate
Checks an address against the official register. status: match | corrected | ambiguous | not_found. Returns the normalized address, confidence (0 to 1), deviations[] per field (kind: spelling | wrong | added), coordinate, id and adrcd. Understands Str./Straße, abbreviations, umlauts and ß.
Mehr
ambiguous returns candidates[] (up to 5) instead of address.
Parameter
| Name | Ort | Typ | Pflicht | Standard | Beschreibung |
|---|---|---|---|---|---|
q | query | string | – | Free text, e.g. Hauptstr. 12a, 3390 Melk (or structured fields) | |
street | query | string | – | Street | |
housenumber | query | string | – | House number | |
postcode | query | string | – | Postcode | |
place | query | string | – | Place |
Beispiel
curl -s -H "Authorization: Bearer YOUR_TOKEN" "https://api.mapx.at/v1/address/validate?q=Herrengasse%2013,%201010%20Wien" | jqBeispielantwort
{
"status": "corrected",
"confidence": 0.93,
"address": {
"street": "Hauptstraße",
"housenumber": "12a",
"postcode": "3390",
"place": "Melk"
},
"deviations": [
{
"field": "street",
"kind": "spelling"
}
],
"id": "address-1234567",
"coordinates": [
15.33,
48.23
]
}Fehler (Details: Fehlerkatalog)
| Status | Bedeutung |
|---|---|
400 | Parameter fehlt oder ist ungültig |
401 | Token fehlt oder ungültig (missing-token, invalid-token, token-expired) |
403 | Token nicht erlaubt (origin-not-allowed, origin-missing, pk-not-allowed, app-not-allowed, token-blocked, ip-not-allowed) |
429 | Rate-Limit überschritten, Retry-After abwarten |
502 | Vorgelagerter Dienst nicht erreichbar |
Address Validation (JSON body)
POST /v1/address/validate
Same as GET with the fields in a JSON object (q or street, housenumber, postcode, place). At most 16 KB.
Request-Body (JSON)
{
"street": "Hauptstr.",
"housenumber": "12a",
"postcode": "3390"
}Beispiel
curl -s -X POST "https://api.mapx.at/v1/address/validate" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{"street":"Hauptstr.","housenumber":"12a","postcode":"3390"}' | jqBeispielantwort
{
"status": "corrected",
"confidence": 0.93,
"address": {
"street": "Hauptstraße",
"housenumber": "12a",
"postcode": "3390",
"place": "Melk"
},
"deviations": [
{
"field": "street",
"kind": "spelling"
}
],
"id": "address-1234567",
"coordinates": [
15.33,
48.23
]
}Fehler (Details: Fehlerkatalog)
| Status | Bedeutung |
|---|---|
400 | Parameter fehlt oder ist ungültig |
401 | Token fehlt oder ungültig (missing-token, invalid-token, token-expired) |
403 | Token nicht erlaubt (origin-not-allowed, origin-missing, pk-not-allowed, app-not-allowed, token-blocked, ip-not-allowed) |
429 | Rate-Limit überschritten, Retry-After abwarten |
502 | Vorgelagerter Dienst nicht erreichbar |
Playground
curl
Antwort erscheint hier.