@callback geocode(longitude :: number(), latitude :: number(), options :: keyword()) :: [
  Geospatial.Address.t()
]

Get an address from longitude and latitude coordinates.

Options

In addition to the shared options, geocode/3 also accepts the following options:

• zoom Level of detail required for the address. Default: 15

Examples

iex> geocode(48.11, -1.77)
%Address{}

@callback get_by_id(id :: String.t(), options :: keyword()) :: [Geospatial.Address.t()]

Lookup for an address by id

@callback search(address :: String.t(), options :: keyword()) :: [Geospatial.Address.t()]

Search for an address

Options

In addition to the shared options, search/2 also accepts the following options:

• coords Map of coordinates (ex: %{lon: 48.11, lat: -1.77}) allowing to give a geographic priority to the search. Defaults to nil.
• type Filter by type of results. Allowed values:
  • :administrative (cities, regions)

Examples

iex> search("10 rue Jangot")
%Address{}