try out ↗

← API Index


/api/geocode1

Address check / geocoding with results from cache and providers

Parameters

Name Description Type
zipcity ZIP and city (e.g. '04103 Leipzig') string
streetnr street name including house number string
country country as ISO code (default from shop config) string
latlng lat,lng for reverse geocoding (alternative to zipcity/streetnr) string
ns set to 1 for public (unauthenticated) access int
oo-rf optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml String
oo-auth optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. int

Response Types

Type Version Description
GeoCodeResult 1 Result of a geocode/address check operation
GeoAddress 1 A geocoded address result with coordinates and quality indicator

OpenAPI

See geocode1.yaml

Referenced in skills