From 2a744a7a3c80617fe4539f9dcfd84d3bd5f6a335 Mon Sep 17 00:00:00 2001 From: Mathias Hansen Date: Mon, 22 Dec 2025 17:47:24 +0100 Subject: [PATCH 1/2] docs: Added Distance API docs --- source.html.md | 632 ++++++++++++++++++++++++++++++ source/enterprise/index.html.md | 632 ++++++++++++++++++++++++++++++ source/index.html.md | 658 +++++++++++++++++++++++++++++++- 3 files changed, 1911 insertions(+), 11 deletions(-) diff --git a/source.html.md b/source.html.md index 9ef951872d1..a57153f987f 100644 --- a/source.html.md +++ b/source.html.md @@ -481,6 +481,16 @@ Parameter | Description `fields` | Optional parameter to request [additional data appends](#fields). `limit` | Optional parameter. The maximum number of results to return. The default is no limit. If set to 0, no limit will be applied. `format` | Optional parameter to change the JSON output format to a different pre-defined structure. Currently, "simple" is the only valid value. If not set, the default full JSON output structure is used. +`destinations[]` | Optional parameter. Array of destination locations for [distance calculation](#distance). Each destination can be a coordinate string (`"lat,lng"` or `"lat,lng,id"`) or a geocodable address. When provided, each result will include a `destinations` array with distance/duration to each destination. +`distance_mode` | Optional parameter. Distance calculation mode: `driving` (road network, includes duration) or `straightline` (great-circle distance, no duration). Default is `straightline`. +`distance_units` | Optional parameter. Unit of measurement: `miles` or `km`. Default is `miles`. +`distance_max_results` | Optional parameter. Maximum number of destinations to return per geocoded result. +`distance_max_distance` | Optional parameter. Filter out destinations beyond this distance (in specified units). +`distance_min_distance` | Optional parameter. Filter out destinations closer than this distance (in specified units). +`distance_max_duration` | Optional parameter. Filter out destinations with travel time exceeding this value in seconds (driving mode only). +`distance_min_duration` | Optional parameter. Filter out destinations with travel time below this value in seconds (driving mode only). +`distance_order_by` | Optional parameter. Sort destinations by `distance` or `duration`. Default is `distance`. +`distance_sort_order` | Optional parameter. Sort order: `asc` or `desc`. Default is `asc`.