Skip to main content
The base URL and your x-api-key are provided by your truemetrics contact. The examples below use https://geodata.truemetrics.cloud/V1 and YOUR_API_KEY as placeholders, and …ADDRESS_ID placeholders for the address identifiers you send as metadata.

1. A stop where entrance and parking share one identifier

The most common case: one address identifier holds both the entrance and the parking. Pass it to both parameters.
When the entrance is matched to a building, a polygon feature (point_type: "building") is also included and drawn beneath the markers.

2. Entrance and parking under different identifiers

If your entrance and parking live under separate address ids, pass each to its own parameter — they are joined into one stop and connected by the dashed walking path.

3. Rendered image — transparent

Add raster=true to also receive a PNG. With no basemap the image has a transparent background, so you can overlay it on your own map.

4. Rendered image — on a street basemap

Add basemap=true to draw the geometry on a street basemap.

5. Turning the image into a file

The raster.image value is a base64 data-URI. To save it as a PNG:
Save the PNG

6. Toggling the building highlight and the reference point

The building footprint is drawn by default. Pass building=false to suppress it:
If your account sends a reference location with its metadata, add reference=true to also plot it as a small red taskpoint — handy for comparing the planned location against the detected entrance:
The extra feature
The reference point appears as a small red dot next to the detected entrance — here the planned location sits a few metres from the entrance that was actually used:
If the stop has no data yet, the call still returns 200 with an empty features array (and no raster). This is expected — the geometry appears as soon as the stop has been processed.