Geolixir.Providers.OpenStreetMap (geolixir v0.1.1)

View Source

Geolixir provider for the OpenStreetMap Nominatim API.

This provider uses the public Nominatim service (https://nominatim.openstreetmap.org).

Features

  • Geocoding (address to coordinates)
  • Reverse Geocoding (coordinates to address)

Configuration

  • API Key: Not required for the public Nominatim API.
  • Endpoint: https://nominatim.openstreetmap.org (configurable via Base, but usually not needed)

Usage Notes

  • Be mindful of the Nominatim Usage Policy, especially regarding rate limits and acceptable use for the public API. For heavy usage, consider hosting your own instance.
  • Default language for results is English ("accept-language": "en").
  • Address details are requested by default (addressdetails: 1).

Summary

Functions

geocode_list(payload, opts \\ [])

Callback implementation for Geolixir.Provider.geocode_list/2.

reverse_geocode_list(payload, opts \\ [])

Callback implementation for Geolixir.Provider.reverse_geocode_list/2.