address_lookup.clients package
Submodules
address_lookup.clients.client module
address_lookup.clients.here_client module
- class address_lookup.clients.here_client.AddressLookupHereClient(here_api_key: str)
Bases:
address_lookup.clients.client.AddressLookupClient
Client for the HERE Address Lookup API
- lookup_address(search_query: str, error_on_multiple: bool = False) address_lookup.result.AddressLookupResult
Lookup the address using the HERE API.
- Parameters
search_query (str) – The address to lookup
error_on_multiple (bool, optional) – Whether to raise an exception if multiple results are found. Defaults to False.
- Raises
AddressLookupException – The error that occurred during the lookup.
- Returns
The result of the address lookup.
- Return type
- parse_response(response: dict) address_lookup.result.AddressLookupResult
Parse response returned by the HERE API into a result object.
- Parameters
response (dict) – Response from the HERE API
- Raises
AddressLookupException – The error that occurred during the lookup.
- Returns
The result of the address lookup.
- Return type