GeocodeHelper

Repository for ORS Geocoding endpoints using GET requests only.

Methods are member extensions on OrsClient and delegate to it.

Constructors

constructor()

suspend fun OrsClient.autocomplete(apiKey: String, text: String, focusLon: Double? = null, focusLat: Double? = null, rectMinLon: Double? = null, rectMinLat: Double? = null, rectMaxLon: Double? = null, rectMaxLat: Double? = null, circleLon: Double? = null, circleLat: Double? = null, circleRadius: Double? = null, country: String? = null, sources: List<String>? = null, layers: List<String>? = null, size: Int? = null): GeocodeSearchResponse

Autocomplete search; returns suggestions for a partial query.

suspend fun OrsClient.reverse(apiKey: String, lon: Double, lat: Double, radiusKm: Double? = null, size: Int? = null, layers: List<String>? = null, sources: List<String>? = null, boundaryCountry: String? = null): GeocodeSearchResponse

Reverse geocoding for a point.

suspend fun OrsClient.search(text: String, apiKey: String, focusLon: Double? = null, focusLat: Double? = null, rectMinLon: Double? = null, rectMinLat: Double? = null, rectMaxLon: Double? = null, rectMaxLat: Double? = null, circleLon: Double? = null, circleLat: Double? = null, circleRadiusMeters: Double? = null, boundaryGid: String? = null, boundaryCountry: String? = null, sourcesCsv: String? = null, layersCsv: String? = null, size: Int? = 10): GeocodeSearchResponse

Forward geocoding search.

suspend fun OrsClient.structured(apiKey: String, address: String? = null, neighbourhood: String? = null, borough: String? = null, locality: String? = null, county: String? = null, region: String? = null, country: String? = null, postalcode: String? = null, focusLon: Double? = null, focusLat: Double? = null, rectMinLon: Double? = null, rectMinLat: Double? = null, rectMaxLon: Double? = null, rectMaxLat: Double? = null, circleLon: Double? = null, circleLat: Double? = null, circleRadiusMeters: Double? = null, boundaryCountry: String? = null, layers: List<String>? = null, sources: List<String>? = null, size: Int? = null): GeocodeSearchResponse

Structured forward geocoding using address fields.