View Source ExNominatim.Client (ExNominatim v1.0.0)

Functions used for creating a validated request and dispatching it to the requested endpoint.

Summary

Functions

Use the /details API endpoint. Delegated to from ExNominatim.details/1, which is documented.

Use the /lookup API endpoint. Delegated to from ExNominatim.lookup/1, which is documented.

Create a new request params struct from the provided keyword list p, taking into account any required fields listed as atoms in the required list. Delegated to from the new/1 function of the modules of SearchParams, ReverseParams, etc. (the module).

Use the /reverse API endpoint. Delegated to from ExNominatim.reverse/1, which is documented.

Use the /search API endpoint. Delegated to from ExNominatim.search/1, which is documented.

Use the /status API endpoint. Delegated to from ExNominatim.status/1, which is documented.

Functions

Link to this function

details(params)

View Source (since 1.0.0)

Use the /details API endpoint. Delegated to from ExNominatim.details/1, which is documented.

Link to this function

lookup(params)

View Source (since 1.0.0)

Use the /lookup API endpoint. Delegated to from ExNominatim.lookup/1, which is documented.

Link to this function

new(p, required, module)

View Source (since 1.0.0)

Create a new request params struct from the provided keyword list p, taking into account any required fields listed as atoms in the required list. Delegated to from the new/1 function of the modules of SearchParams, ReverseParams, etc. (the module).

Link to this function

reverse(params)

View Source (since 1.0.0)

Use the /reverse API endpoint. Delegated to from ExNominatim.reverse/1, which is documented.

Link to this function

search(params)

View Source (since 1.0.0)

Use the /search API endpoint. Delegated to from ExNominatim.search/1, which is documented.

Link to this function

status(params \\ [format: "text"])

View Source (since 1.0.0)

Use the /status API endpoint. Delegated to from ExNominatim.status/1, which is documented.