Skip to content

Commit be3d3c2

Browse files
committed
Update docs
1 parent 21882cf commit be3d3c2

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/http.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,12 @@ In addition to the [general options](#general-options) the following options are
283283
|timestamp |`integer` UNIX-like timestamp |
284284
|radius |`double >= 0` (default 5m) |
285285

286+
The radius for each point should be the standard error of the location, measured in meters from the true location. Use
287+
`Location.getAccuracy()` on Android or `CLLocation.horizontalAccuracy` on iOS. This value is used to determine which
288+
points should be considered as candidates (larger radius means more candidates) and how likely each candidate is (larger
289+
radius means far-away candidates are penalized less). The area to search is chosen such that the correct candidate
290+
should be considered 99.9% of the time (for more details, see https://github.com/Project-OSRM/osrm-backend/pull/3184).
291+
286292
### Response
287293
- `code` if the request was successful `Ok` otherwise see the service dependent and general status codes.
288294
- `tracepoints`: Array of `Waypoint` objects representing all points of the trace in order.

0 commit comments

Comments
 (0)