View Source API Reference ExNominatim v1.1.1

Modules

Main user-friendly functions for interacting with the endpoints of a Nominatim API server.

Functions for preparing an HTTP request, including validating the base URL of the target Nominatim API server setting the User-Agent header automatically, selecting all the non-nil request parameters, creating a validated request, and dispatching it to the requested endpoint.

The struct for a request to the /details API endpoint.

The struct for a request to the /lookup API endpoint.

The struct for a request to the /reverse API endpoint.

The struct for a request to the /search API endpoint.

The struct for a request to the /status API endpoint.

Functions for reporting processed responses from the Nominatim API.

Functions used for the automatic validation of the keys of a request parameters struct according to the target endpoint, their values according to the API endpoint's specification, and invalidate any request parameters with confusing intent that might have unexpected results, such as defining both the :q free-form query parameter and at least one of the parameters of a structured query (:city, :country, etc.).