Skip to content

Route Matching API

RmeApi

A python interface into the RME API

__init__(self, api_key=None, timeout=None) special

Returns a RmeApi instance.

Parameters:

Name Type Description Default
api_key str

API key taken from HERE Developer Portal.

None
timeout int

Timeout limit for requests.

None
Source code in herepy/rme_api.py
16
17
18
19
20
21
22
23
24
25
26
27
28
def __init__(self,
             api_key: str=None,
             timeout: int=None):
    """Returns a RmeApi instance.
    Args:
      api_key (str):
        API key taken from HERE Developer Portal.
      timeout (int):
        Timeout limit for requests.
    """

    super(RmeApi, self).__init__(api_key, timeout)
    self._base_url = 'https://m.fleet.ls.hereapi.com/2/matchroute.json'

match_route(self, gpx_file_content, route_mode='car', pde_layers=[])

Retrieves misc information about the route given in gpx file

Parameters:

Name Type Description Default
gpxfile content (str

gpx file content as string

required
routemode str

route mode ('car')

required
pde_layers List[str]

PDE layers to retrieve e.g.: ROAD_GEOM_FCn(TUNNEL) SPEED_LIMITS_FCn(FROM_REF_SPEED_LIMIT,TO_REF_SPEED_LIMIT) ADAS_ATTRIB_FCn(SLOPES)

or e.g.,

ROAD_GEOM_FCn() SPEED_LIMITS_FCn()

[]

Returns:

Type Description
Optional[herepy.models.RmeResponse]

RmeResponse

Source code in herepy/rme_api.py
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
def match_route(self, gpx_file_content: str, route_mode: str='car', pde_layers: List[str]=[]) -> Optional[RmeResponse]:
    """Retrieves misc information about the route given in gpx file
    Args:
      gpxfile content (str):
        gpx file content as string
      routemode (str):
        route mode ('car')
      pde_layers (str list):
        PDE layers to retrieve e.g.:
          ROAD_GEOM_FCn(TUNNEL)
          SPEED_LIMITS_FCn(FROM_REF_SPEED_LIMIT,TO_REF_SPEED_LIMIT)
          ADAS_ATTRIB_FCn(SLOPES)

          or e.g.,

          ROAD_GEOM_FCn(*)
          SPEED_LIMITS_FCn(*)
    Returns:
      RmeResponse
    Raises:
      HEREError"""

    data = {'file': Utils.get_zipped_base64(gpx_file_content),
            'routemode': route_mode,
            'attributes': ','.join(pde_layers),
            'apikey': self._api_key}
    return self.__get(data)