xyzspaces.iml.apis.lookup_api module

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 xyzspaces.iml.apis.lookup_api.LookupApi(auth, proxies=None)[source]

Bases: xyzspaces.iml.apis.api.Api

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.

Parameters
api_version_impl = {'interactive': 'v1', 'lookup': 'v1'}
platform_api_version_impl = {'artifact': 'v1', 'config': 'v1', 'lookup': 'v1'}
__init__(auth, proxies=None)[source]
Parameters
get_resource_api_list(hrn, region=None)[source]

Lookup all available APIs for given HRN.

Parameters
  • hrn (str) – a HERE Resource Name identifying the resource

  • region (Optional[str]) – 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

Return type

dict

get_resource_api(hrn, api, version, region=None)[source]

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

Parameters
  • hrn (str) – a HERE Resource Name identifying the resource

  • api (str) – The identifier of the API

  • version (str) – The version of the API

  • region (Optional[str]) – an Optional param to look up a specific region for a given resource

Returns

Details of the requested API for the resource

Return type

dict