Liking cljdoc? Tell your friends :D

wagoe.geo.shell.adapters.osm

OpenStreetMap Nominatim geocoding adapter.

Rate limit: 1 request per second (OSM usage policy requires this). No API key required. A descriptive User-Agent header is mandatory.

Usage: (def adapter (create-nominatim-adapter {:user-agent "MyApp/1.0 (contact@example.com)"})) (geocode adapter {:postcode "1012 JS" :city "Amsterdam"})

OpenStreetMap Nominatim geocoding adapter.

Rate limit: 1 request per second (OSM usage policy requires this).
No API key required. A descriptive User-Agent header is mandatory.

Usage:
  (def adapter (create-nominatim-adapter {:user-agent "MyApp/1.0 (contact@example.com)"}))
  (geocode adapter {:postcode "1012 JS" :city "Amsterdam"})
raw docstring

create-nominatim-adapterclj

(create-nominatim-adapter {:keys [user-agent base-url min-interval-ms]
                           :or {base-url default-base-url
                                min-interval-ms default-min-interval-ms}})

Create an OpenStreetMap Nominatim adapter.

Config keys: :user-agent - Descriptive User-Agent string (REQUIRED by OSM policy) :base-url - Override base URL (default: https://nominatim.openstreetmap.org) :min-interval-ms - Minimum ms between requests (default: 1000)

Returns: NominatimAdapter implementing GeoProviderProtocol

Create an OpenStreetMap Nominatim adapter.

Config keys:
  :user-agent       - Descriptive User-Agent string (REQUIRED by OSM policy)
  :base-url         - Override base URL (default: https://nominatim.openstreetmap.org)
  :min-interval-ms  - Minimum ms between requests (default: 1000)

Returns:
  NominatimAdapter implementing GeoProviderProtocol
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close