Packages

A full-featured client for the OpenStreetMap Nominatim API V1 (public and self-hosted), with extensive request validation, robust error-handling and reporting, rate limiting, optional caching, telemetry instrumentation, retry with exponential backoff, and geohash enrichment.

Retired package: Deprecated - Switch to v1.1.3 with a bugfix for applying the application configuration as described in the docs

Current section

Files

Jump to
ex_nominatim lib client status_params.ex
Raw

lib/client/status_params.ex

# SPDX-FileCopyrightText: 2024 Isaak Tsalicoglou <isaak@overbring.com>
# SPDX-License-Identifier: Apache-2.0
defmodule ExNominatim.Client.StatusParams do
@moduledoc """
The struct for a request to the `/status` API endpoint.
"""
@moduledoc since: "1.0.0"
defstruct [:format, valid?: nil, errors: []]
@required []
@doc """
Construct a new `%StatusParams{}` struct from the content of the keyword list `opts`.
"""
def new(opts), do: ExNominatim.Client.new(opts, @required, __MODULE__)
end