ROOTEDocs

ROOTE Map

Open, share and integrate ROOTE Map.

Page actions

ROOTE Map is publicly available at map.roote.ai.

Open ROOTE Map

Explore mobility data on the public ROOTE map.

Direct access

Use the standard URL:

https://map.roote.ai/

Without parameters, the map determines its initial view in this order:

  1. Authorized geolocation.
  2. Last saved view.
  3. Approximate location.
  4. Global fallback view.

Open with an address or place

Use the q parameter when the integration knows a textual location rather than exact coordinates. It accepts an address, city, or place to search.

https://map.roote.ai/?q=Place+de+la+République+Paris

Spaces can be encoded as + or %20. Accented and other special characters should be URL encoded.

const url = new URL("https://map.roote.ai/");
url.searchParams.set("q", "Place de la République Paris");

console.log(url.toString());

Position the camera with coordinates

Use lat, lon, and optionally zoom to control the map camera.

https://map.roote.ai/?lat=48.8555&lon=2.3447&zoom=14

Camera only

This format controls the map camera only. It does not automatically create a search origin, a search pin, a mobility mode, or a nearby search.

The coord=48.8555,2.3447 format is not used. The recommended coordinate format is lat together with lon.

Use search_lat, search_lon, search_label, zoom, and modes to restore a complete mobility-search context.

https://map.roote.ai/?search_lat=44.8416106&search_lon=-0.5810938&search_label=Bordeaux&zoom=12&modes=scooter

This opens ROOTE Map with Bordeaux as the search origin and restores the scooter mobility context.

search_lat and search_lon are used to:

  • restore the search origin;
  • position the search pin;
  • calculate distances;
  • launch the initial nearby search when a mobility mode is present;
  • initialize the camera when lat and lon are absent.

Avoid unnecessary duplication

In the common case, it is not necessary to duplicate the same coordinates in both lat/lon and search_lat/search_lon.

Mobility modes

ValueMeaning
bicycleBicycle
scooterKick scooter
mopedMoped or motor scooter
carCar
stationStation

Pass multiple modes as comma-separated values:

modes=bicycle,scooter,car

Unknown mode values are ignored.

Map and REST use different contracts

station is a supported ROOTE Map mode value. Do not merge it with the REST /v1/nearby mobility-mode contract: REST represents stations through the include result family, while ROOTE Map represents them in URL state with station.

Control camera and search separately

Camera coordinates and search-origin coordinates can coexist.

https://map.roote.ai/?lat=43.6045&lon=1.4440&zoom=13&search_lat=44.8416&search_lon=-0.5811&search_label=Bordeaux&modes=bicycle

In this example:

  • the camera opens over Toulouse;
  • the search origin remains Bordeaux;
  • distances remain calculated from Bordeaux;
  • the search context remains associated with Bordeaux.

Priority rules

SituationBehavior
lat and lon presentThey control the camera.
search_lat and search_lon presentThey control the search origin.
lat and lon absentThe search origin also initializes the camera.
User pans the mapThe search context is preserved.

This separation lets an integration show another geographic area without silently changing the origin used for distances and the mobility-search context.

Embed ROOTE Map

Use an iframe to embed the standard map:

<iframe
  title="ROOTE Map"
  src="https://map.roote.ai/"
  width="100%"
  height="600"
  loading="lazy"
  allow="geolocation"
  style="border: 0;"
></iframe>

An iframe can also restore a complete search context:

<iframe
  title="ROOTE Map — Trottinettes à Bordeaux"
  src="https://map.roote.ai/?search_lat=44.8416106&amp;search_lon=-0.5810938&amp;search_label=Bordeaux&amp;zoom=12&amp;modes=scooter"
  width="100%"
  height="600"
  loading="lazy"
  allow="geolocation"
  style="border: 0;"
></iframe>

Inside HTML attribute values, encode & as &amp;.

Geolocation in iframes

The iframe attribute allow="geolocation" allows the embedded map to request the user's location.

Geolocation remains subject to:

  • user consent;
  • browser permissions;
  • the parent site's permissions policy.

The allow="geolocation" attribute does not bypass browser permission.

URL parameter reference

ParameterRole
qSearch an address, city, or place.
latCamera latitude.
lonCamera longitude.
zoomCamera zoom.
search_latSearch-origin latitude.
search_lonSearch-origin longitude.
search_labelHuman-readable search label.
modesComma-separated mobility modes.

Camera view or mobility context?

Use lat and lon when you only want to restore what the user is looking at. Use search_lat and search_lon when you want to restore what the user's mobility search is about.

On this page