This module contains an LookupApi class to perform API operations.

The HERE API reference documentation used in this module can be found here: Lookup API Reference # noqa E501

class here.platform.api.lookup_api.LookupApi(auth: Auth | None, platform_config: PlatformConfig, application_config: ApplicationConfig, lookup_api_registry: LookupApiRegistry, proxies: dict | None = None)[source]#

Bases: BaseApi

This class provides access to HERE platform Lookup APIs.

Instances can call only to those API endpoints relevant for accessing catalog and layer metadata, as well as those needed to access the data contained in different types of layers.

api_version_impl = {'blob': ['v1', 'v2'], 'index': ['v1'], 'ingest': ['v1'], 'interactive': ['v1'], 'lookup': ['v1'], 'metadata': ['v1'], 'notification': ['v2'], 'publish': ['v2'], 'query': ['v1'], 'statistics': ['v1'], 'stream': ['v2'], 'volatile-blob': ['v1']}#
get_impl_platform_api_list() → dict[source]#

Lookup implemented platform APIs.

get_platform_api(api: str, version: str) → dict[source]#

Return details of a single platform API.

Parameters:

  • api – The identifier of the API

  • version – The version of the API

Returns:

Details of the requested API for the resource

Raises:

PlatformException – If platform responds with an HTTP error.

get_platform_api_list() → list[source]#

Return the list of the platform APIs.

Returns:

The list of APIs of the platform

Raises:

PlatformException – If platform responds with an HTTP error.

get_resource_api(hrn: str, api: str, version: str, region: str | None = None) → dict[source]#

Return details of a single API for a given resource identified by hrn, api and version.

Parameters:

  • hrn – a HERE Resource Name identifying the resource

  • api – The identifier of the API

  • version – The version of the API

  • region – an Optional param to look up a specific region for a given resource

Returns:

Details of the requested API for the resource

Raises:

PlatformException – If platform responds with an HTTP error.

get_resource_api_list(hrn: str, region: str | None = None) → dict[source]#

Lookup all available APIs for given HRN.

Parameters:

  • hrn – a HERE Resource Name identifying the resource

  • region – an Optional param to look up a specific region for a given resource

Returns:

The list of APIs that can be used with the resource

Raises:

PlatformException – If platform responds with an HTTP error.

platform_api_version_impl = {'artifact': 'v1', 'config': 'v1', 'location-service-registry': 'v1', 'lookup': 'v1'}#