Endpoint
FeatureCollection for one delivery stop, optionally with a rendered PNG.
The base URL is provided by your truemetrics contact.
Request
Query parameters
A request describes a single stop, addressed by up to two address identifiers — the entrance and the parking. They may be the same identifier (one address that has both) or two different identifiers (many systems store the entrance and parking under separate address ids). At least one of them must be provided.The address identifier (the
id_address / merge id you send as metadata) used to look up the
entrance — and its building footprint. Optional, but at least one of
identifier_entrance / identifier_parking is required.The address identifier used to look up the parking and the waypoint (these two share the
same id). Optional, but at least one of
identifier_entrance / identifier_parking is required.When
true, the response also contains a rendered PNG image of the geometry in a raster
block. Accepted truthy values: true, 1, yes, on.Only relevant together with
raster=true. When true, the PNG is drawn on a street basemap;
when false the PNG has a transparent background so you can overlay it on your own map.Draw the snapped building footprint highlight under the entrance. On by default — pass
building=false to suppress it.When
true, also plot your supplied reference location (“taskpoint”) as a small red point,
so you can compare the planned location against the detected entrance. Available for accounts
that send a reference coordinate with their metadata.Headers
Your API key. Identifies your account; you only receive your own data.
Response
A standard GeoJSONFeatureCollection with two extra top-level blocks, metadata and view
(and raster when requested).
Always
"FeatureCollection".The map features — see Feature types below. May be empty when the stop has
no data yet (this is a normal
200, not an error).{ "mode": "default", "system": "EPSG:4326" } — the coordinate reference system of all
geometry.A suggested camera fitted to all points:
{ center: { lat, lon }, zoom, orientation, position_fixed, zoomable }. null when the collection is empty.Present only when
raster=true and the collection is non-empty:
{ image, width, height, bbox, basemap }, where image is a data:image/png;base64,…
data-URI, bbox is [minLon, minLat, maxLon, maxLat], and basemap indicates whether a street
basemap was drawn.Feature types
Every feature carriesproperties.object_type (point | line | polygon), the identifier
it came from, and styling hints that map directly to map layer styles.
Point — entrance / parking / waypoint
| Property | Type | Description |
|---|---|---|
object_type | string | "point" |
point_type | string | entrance · parking · waypoint · taskpoint (your reference location, only with reference=true) |
color | string | Marker colour (red entrance, blue parking/waypoint, red taskpoint) → circle-color |
marker_size | number | Marker radius → circle-radius (the taskpoint is a small dot) |
icon | string | Icon name for the marker (absent for the taskpoint, which is a plain dot) |
Line — walking path / waypoint leg
| Property | Type | Description |
|---|---|---|
object_type | string | "line" |
line_type | string | parking_to_entrance (the dashed walking path) · parking_to_waypoint |
color | string | Line colour → line-color |
line_width | number | Line width → line-width |
line_style | string | "dashed" for the walking path; combine with line_dasharray (e.g. [2,2]) |
line_opacity | number | Opacity of the walking path (e.g. 0.6) → line-opacity |
line_fade / fade_start | string / number | parking_to_waypoint fades toward the waypoint after fade_start (e.g. 0.7) — render with a line-gradient |
Polygon — building footprint
| Property | Type | Description |
|---|---|---|
object_type | string | "polygon" |
point_type | string | "building" |
color | string | Fill / outline colour |
fill_opacity | number | Fill opacity (e.g. 0.2) → fill-opacity |
line_width | number | Outline width |
The entrance and parking can come from different identifiers. Pass each to its own parameter
(
identifier_entrance / identifier_parking) and they are joined into one stop — the dashed
walking path connects them and, when available, the entrance’s building is highlighted.Status codes
| Status | Meaning |
|---|---|
200 | Success. A 200 with an empty features array means the stop has no data yet. |
400 | Neither identifier_entrance nor identifier_parking was provided. |
403 | Missing or invalid x-api-key. |
Caching & limits
- Successful, non-empty responses are cacheable (
Cache-Control: public, max-age=3600). - CORS is open (
Access-Control-Allow-Origin: *) so the endpoint can be called from the browser. - Rate limit: 100 requests/second.