Skip to content
This repository has been archived by the owner on Nov 21, 2024. It is now read-only.

Latest commit

 

History

History
49 lines (31 loc) · 3.64 KB

MatrixApi.md

File metadata and controls

49 lines (31 loc) · 3.64 KB

LocationIq\MatrixApi

All URIs are relative to https://eu1.locationiq.com/v1

Method HTTP request Description
matrix Get /matrix/driving/{coordinates} Matrix Service

matrix

crate::models::DirectionsMatrix matrix(coordinates, bearings, radiuses, generate_hints, approaches, exclude, annotations, sources, destinations, fallback_speed, fallback_coordinate) Matrix Service

Computes duration of the fastest route between all pairs of supplied coordinates. Returns the durations or distances or both between the coordinate pairs. Note that the distances are not the shortest distance between two coordinates, but rather the distances of the fastest routes.

Parameters

Name Type Description Required Notes
coordinates String String of format {longitude},{latitude};{longitude},{latitude}[;{longitude},{latitude} ...] or polyline({polyline}) or polyline6({polyline6}). polyline follows Google's polyline format with precision 5 [required]
bearings Option<String> Limits the search to segments with given bearing in degrees towards true north in clockwise direction. List of positive integer pairs separated by semi-colon and bearings array should be equal to length of coordinate array. Input Value :- {bearing};{bearing}[;{bearing} ...] Bearing follows the following format : bearing {value},{range} integer 0 .. 360,integer 0 .. 180
radiuses Option<String> Limits the search to given radius in meters Radiuses array length should be same as coordinates array, eaach value separated by semi-colon. Input Value - {radius};{radius}[;{radius} ...] Radius has following format :- double >= 0 or unlimited (default)
generate_hints Option<String> Adds a Hint to the response which can be used in subsequent requests, see hints parameter. Input Value - true (default), false Format - Base64 String
approaches Option<String> Keep waypoints on curb side. Input Value - {approach};{approach}[;{approach} ...] Format - curb or unrestricted (default)
exclude Option<String> Additive list of classes to avoid, order does not matter. input Value - {class}[,{class}] Format - A class name determined by the profile or none.
annotations Option<String> Returns additional metadata for each coordinate along the route geometry. [ true, false (default), nodes, distance, duration, datasources, weight, speed ]
sources Option<i32> Use location with given index as source. [ {index};{index}[;{index} ...] or all (default) ] => index 0 <= integer < #locations
destinations Option<i32> Use location with given index as destination. [ {index};{index}[;{index} ...] or all (default) ]
fallback_speed Option<f32> If no route found between a source/destination pair, calculate the as-the-crow-flies distance, then use this speed to estimate duration. double > 0
fallback_coordinate Option<String> When using a fallback_speed, use the user-supplied coordinate (input), or the snapped location (snapped) for calculating distances. [ input (default), or snapped ] [default to "input"]

Return type

crate::models::DirectionsMatrix

Authorization

key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]