Contains details about each path between a pair of positions included along a route such as: StartPosition, EndPosition, Distance, DurationSeconds, Geometry, and Steps. The number of legs returned corresponds to one fewer than the total number of positions in the request.

For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:

The StartPosition is the departure position.
The EndPosition is the destination position.

A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:

Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.
Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.

",{"_1763":1771},[1772,1774],{"_1766":1773},"#/definitions/405613",{"_23":1775},"Contains information about the whole route, such as: RouteBBox, DataSource, Distance, DistanceUnit, and DurationSeconds.","Returns the result of the route calculation. Metadata includes legs and route summary.","x-apidog-orders",[1758,1759],"definitions",{"_1781":1782,"_1786":1787,"_1788":1789,"_1797":1798,"_1800":1801,"_1803":1804,"_1807":1808,"_1847":1848,"_1850":1851,"_1856":1857,"_1858":1859,"_1869":1870,"_1914":1915,"_1918":1919,"_1920":1921,"_1923":1924,"_1925":1926,"_1927":1928,"_1929":1930,"_1932":1933},"405511",{"_5":1783,"_1784":1785,"_30":596,"_22":596},"number","format","double","405517",{"_5":1755,"_1756":1757,"_1760":1761,"_23":1776,"_1777":1778,"_30":586,"_22":586},"405529",{"_5":1790,"_1791":1792,"_1794":1795,"_1796":1795,"_30":611,"_22":611},"array","items",{"_1766":1793},"#/definitions/405511","minItems",2,"maxItems","405560",{"_5":1799,"_30":826,"_22":826},"string","405605",{"_5":1790,"_1791":1802,"_1794":1709,"_1796":1709,"_30":1041,"_22":1041},{"_1766":1793},"405611",{"_5":1790,"_1791":1805,"_30":1076,"_22":1076},{"_1766":1806},"#/definitions/405656","405613",{"_5":1755,"_1756":1809,"_1760":1814,"_23":1845,"_1777":1846,"_30":1081,"_22":1081},[1810,1811,1051,1812,1813],"DataSource","Distance","DurationSeconds","RouteBBox",{"_1810":1815,"_1811":1821,"_1051":1827,"_1812":1833,"_1813":1839},{"_1763":1816},[1817,1819],{"_1766":1818},"#/definitions/405560",{"_23":1820},"

The data provider of traffic and road network data used to calculate the route. Indicates one of the available providers:

Esri
Here

For more information about data providers, see Amazon Location Service data providers.

",{"_1763":1822},[1823,1825],{"_1766":1824},"#/definitions/405614",{"_23":1826},"

The total distance covered by the route. The sum of the distance travelled between every stop on the route.

The route distance can't be greater than 250 km. If the route exceeds 250 km, the response returns a 400 RoutesValidationException error.

",{"_1763":1828},[1829,1831],{"_1766":1830},"#/definitions/405616",{"_23":1832},"The unit of measurement for the distance.",{"_1763":1834},[1835,1837],{"_1766":1836},"#/definitions/405617",{"_23":1838},"The total travel time for the route measured in seconds. The sum of the travel time between every stop on the route.",{"_1763":1840},[1841,1843],{"_1766":1842},"#/definitions/405605",{"_23":1844},"

Specifies a geographical box surrounding a route. Used to zoom into a route when displaying it in a map. For example, [min x, min y, max x, max y].

The first 2 bbox parameters describe the lower southwest corner:

The first bbox position is the X coordinate or longitude of the lower southwest corner.
The second bbox position is the Y coordinate or latitude of the lower southwest corner.

The next 2 bbox parameters describe the upper northeast corner:

The third bbox position is the X coordinate, or longitude of the upper northeast corner.
The fourth bbox position is the Y coordinate, or longitude of the upper northeast corner.

","A summary of the calculated route.",[1810,1811,1051,1812,1813],"405614",{"_5":1783,"_1784":1785,"_1849":185,"_30":1086,"_22":1086},"minimum","405616",{"_5":1799,"_1852":1853,"_30":1051,"_22":1051},"enum",[1854,1855],"Kilometers","Miles","405617",{"_5":1783,"_1784":1785,"_1849":185,"_30":1091,"_22":1091},"405655",{"_5":1755,"_1760":1860,"_23":1867,"_1777":1868,"_30":1296,"_22":1296},{"_1311":1861},{"_1763":1862},[1863,1865],{"_1766":1864},"#/definitions/405663",{"_23":1866},"

An ordered list of positions used to plot a route on a map.

The first position is closest to the start position for the leg, and the last position is the closest to the end position for the leg.

For example, [[-123.117, 49.284],[-123.115, 49.285],[-123.115, 49.285]]

","Contains the geometry details for each path between a pair of positions. Used in plotting a route leg on a map.",[1311],"405656",{"_5":1755,"_1756":1871,"_1760":1875,"_23":1912,"_1777":1913,"_30":1306,"_22":1306},[1811,1812,1872,1873,1874],"EndPosition","StartPosition","Steps",{"_1811":1876,"_1812":1882,"_1872":1888,"_1894":1895,"_1873":1901,"_1874":1906},{"_1763":1877},[1878,1880],{"_1766":1879},"#/definitions/405664",{"_23":1881},"

The distance between the leg's StartPosition and EndPosition along a calculated route.

The default measurement is Kilometers unless the request specifies a DistanceUnit of Miles.

",{"_1763":1883},[1884,1886],{"_1766":1885},"#/definitions/405662",{"_23":1887},"The estimated travel time between the leg's StartPosition and EndPosition. The travel mode and departure time that you specify in the request determines the calculated time.",{"_1763":1889},[1890,1892],{"_1766":1891},"#/definitions/405529",{"_23":1893},"

The terminating position of the leg. Follows the format [longitude,latitude].

If the EndPosition isn't located on a road, it's snapped to a nearby road.

","Geometry",{"_1763":1896},[1897,1899],{"_1766":1898},"#/definitions/405655",{"_23":1900},"Contains the calculated route's path as a linestring geometry.",{"_1763":1902},[1903,1904],{"_1766":1891},{"_23":1905},"

The starting position of the leg. Follows the format [longitude,latitude].

If the StartPosition isn't located on a road, it's snapped to a nearby road.

",{"_1763":1907},[1908,1910],{"_1766":1909},"#/definitions/405657",{"_23":1911},"Contains a list of steps, which represent subsections of a leg. Each step provides instructions for how to move to the next step in the leg such as the step's start position, end position, travel distance, travel duration, and geometry offset.","

Contains the calculated route's details for each path between a pair of positions. The number of legs returned corresponds to one fewer than the total number of positions in the request.

For example, a route with a departure position and destination position returns one leg with the positions snapped to a nearby road:

The StartPosition is the departure position.
The EndPosition is the destination position.

A route with a waypoint between the departure and destination position returns two legs with the positions snapped to a nearby road:

Leg 1: The StartPosition is the departure position . The EndPosition is the waypoint positon.
Leg 2: The StartPosition is the waypoint position. The EndPosition is the destination position.

",[1811,1812,1872,1894,1873,1874],"405657",{"_5":1790,"_1791":1916,"_30":1301,"_22":1301},{"_1766":1917},"#/definitions/405709","405662",{"_5":1783,"_1784":1785,"_1849":185,"_30":1291,"_22":1291},"405663",{"_5":1790,"_1791":1922,"_1794":1795,"_30":1311,"_22":1311},{"_1766":1891},"405664",{"_5":1783,"_1784":1785,"_1849":185,"_30":1286,"_22":1286},"405704",{"_5":1783,"_1784":1785,"_1849":185,"_30":1541,"_22":1541},"405707",{"_5":1783,"_1784":1785,"_1849":185,"_30":1546,"_22":1546},"405708",{"_5":1931,"_1849":185,"_30":1551,"_22":1551},"integer","405709",{"_5":1755,"_1756":1934,"_1760":1935,"_23":1965,"_1777":1966,"_30":1556,"_22":1556},[1811,1812,1872,1873],{"_1811":1936,"_1812":1942,"_1872":1948,"_1953":1954,"_1873":1960},{"_1763":1937},[1938,1940],{"_1766":1939},"#/definitions/405704",{"_23":1941},"The travel distance between the step's StartPosition and EndPosition.",{"_1763":1943},[1944,1946],{"_1766":1945},"#/definitions/405707",{"_23":1947},"The estimated travel time, in seconds, from the step's StartPosition to the EndPosition. . The travel mode and departure time that you specify in the request determines the calculated time.",{"_1763":1949},[1950,1951],{"_1766":1891},{"_23":1952},"The end position of a step. If the position the last step in the leg, this position is the same as the end position of the leg.","GeometryOffset",{"_1763":1955},[1956,1958],{"_1766":1957},"#/definitions/405708",{"_23":1959},"

Represents the start position, or index, in a sequence of steps within the leg's line string geometry. For example, the index of the first step in a leg geometry is 0.

Included in the response for queries that set IncludeLegGeometry to True.

",{"_1763":1961},[1962,1963],{"_1766":1891},{"_23":1964},"The starting position of a step. If the position is the first step in the leg, this position is the same as the start position of the leg."," Represents an element of a leg within a route. A step contains instructions for how to move to the next step in the leg. ",[1811,1812,1872,1953,1873],"extraData",{"_1969":1970,"_1971":1780,"_1972":1973,"_23":1776,"_1974":117},"apiFieldList",[],"dataSchemaDefinitions","example","{\n \"Legs\": [],\n \"Summary\": {\n \"DataSource\": \"string\",\n \"Distance\": 0,\n \"DistanceUnit\": \"Kilometers\",\n \"DurationSeconds\": 0,\n \"RouteBBox\": []\n }\n}","displayName","docsIdTypeData",{"_1977":1978,"_1979":1980,"_1981":1980,"_1982":1983,"_1984":1985,"_1986":1987,"_1988":117,"_1989":-7},"onlineType","APIDOC","onlineId",345847,"projectId","teamId",97,"branchId",308980,"visitType","customDomain","subdirectory","specialFileType","notification",[],"footerBanner",[],"projectSetting",{"_1996":1997,"_1998":1999,"_2014":2015,"_2016":2017,"_2018":2019,"_2020":2021},"auth",{},"advancedSettings",{"_2000":156,"_2001":156,"_2002":51,"_2003":2004,"_2005":156,"_2006":156,"_2007":2008},"enableJsonc","enableBigint","responseValidate","isDefaultUrlEncoding",3,"enableTestScenarioSetting","enableYAPICompatScript","publishedDocUrlRules",{"_2009":2010,"_2011":2012,"_2013":51},"defaultRule","RESOURCE_KEY_ONLY","resourceKeyStandard","LEGACY","enableResourceKeyStandard","securityScheme",{},"mockSettings",{},"preProcessors",[],"postProcessors",[],"environments",{"_2024":2025,"_2066":2067,"_2131":2132},"selectedEnvironment",{"_174":2026,"_22":2027,"_2028":2029,"_2030":2031,"_2032":2033,"_2034":2035,"_2036":2037,"_2038":2039,"_2040":2041,"_2050":2051,"_5":2052,"_2053":2054,"_1981":1980,"_2055":2056,"_2057":2058,"_2059":185,"_187":2060,"_2061":2058,"_2062":2063,"_2064":2063,"_1998":2065},356333,"The Amazon Location Service multi-region endpoint","baseUrl","http://geo.{region}.amazonaws.com","baseUrls",{"_1729":2029},"websocketBaseUrls",{},"socketioBaseUrls",{},"requestProxyAgentSettings",{},"variables",[],"parameters",{"_2042":2043,"_2044":2045,"_2046":2047,"_2048":2049},"cookie",[],"query",[],"header",[],"body",[],"registrationCenters",[],"normal","visibility","protected","projectType","HTTP","creatorId",345038,"ordering",[],"editorId","createdAt","2022-09-10T19:59:20.000Z","updatedAt",{},"environmentList",[2068,2082,2099,2115],{"_174":2026,"_22":2027,"_2028":2029,"_2030":2069,"_2032":2070,"_2034":2071,"_2036":2072,"_2038":2073,"_2040":2074,"_2050":2079,"_5":2052,"_2053":2054,"_1981":1980,"_2055":2056,"_2057":2058,"_2059":185,"_187":2080,"_2061":2058,"_2062":2063,"_2064":2063,"_1998":2081},{"_1729":2029},{},{},{},[],{"_2042":2075,"_2044":2076,"_2046":2077,"_2048":2078},[],[],[],[],[],[],{},{"_174":2083,"_22":2084,"_2028":2085,"_2030":2086,"_2032":2087,"_2034":2088,"_2036":2089,"_2038":2090,"_2040":2091,"_2050":2096,"_5":2052,"_2053":2054,"_1981":1980,"_2055":2056,"_2057":2058,"_2059":185,"_187":2097,"_2061":2058,"_2062":2063,"_2064":2063,"_1998":2098},356334,"The Amazon Location Service endpoint for China (Beijing) and China (Ningxia)","http://geo.{region}.amazonaws.com.cn",{"_1729":2085},{},{},{},[],{"_2042":2092,"_2044":2093,"_2046":2094,"_2048":2095},[],[],[],[],[],[],{},{"_174":2100,"_22":2027,"_2028":2101,"_2030":2102,"_2032":2103,"_2034":2104,"_2036":2105,"_2038":2106,"_2040":2107,"_2050":2112,"_5":2052,"_2053":2054,"_1981":1980,"_2055":2056,"_2057":2058,"_2059":185,"_187":2113,"_2061":2058,"_2062":2063,"_2064":2063,"_1998":2114},356335,"https://geo.{region}.amazonaws.com",{"_1729":2101},{},{},{},[],{"_2042":2108,"_2044":2109,"_2046":2110,"_2048":2111},[],[],[],[],[],[],{},{"_174":2116,"_22":2084,"_2028":2117,"_2030":2118,"_2032":2119,"_2034":2120,"_2036":2121,"_2038":2122,"_2040":2123,"_2050":2128,"_5":2052,"_2053":2054,"_1981":1980,"_2055":2056,"_2057":2058,"_2059":185,"_187":2129,"_2061":2058,"_2062":2063,"_2064":2063,"_1998":2130},356336,"https://geo.{region}.amazonaws.com.cn",{"_1729":2117},{},{},{},[],{"_2042":2124,"_2044":2125,"_2046":2126,"_2048":2127},[],[],[],[],[],[],{},"servers",[2133],{"_174":1729,"_22":2134},"Default Server","searchSettings",{},"versionSettings",[2139],{"_1984":1985,"_2140":51,"_22":1749,"_2141":1749,"_2022":2142},"isDefaultVersion","slug",{"_2143":2144,"_2145":2026},"environmentIds",[2026,2083,2100,2116],"defaultEnvironmentId","seoInfos",["M"],"itemPathPrefix",{"_2028":117,"_2150":117,"_1988":117,"_2151":156},"versionSlug","isSharedDocIndependentDomain","appEnvMap",{"_2154":129},"appBrowserExtensionAdapterKey","customCodes",{"_2157":117},"javascript","primaryColorVariable",{"_1654":2160,"_1658":2161},"--ui-primary-color-hover: var(--ui-primary-5);--ui-primary-color-active: var(--ui-primary-7);--ui-picker-basic-cell-hover-with-range-color: #36139c;--ui-picker-date-hover-range-border-color: #4e1be0;--ui-primary-base: #9373EE;--ui-primary-base-p: 147, 115, 238;--ui-primary-color-p: 147, 115, 238;--ui-primary-color: #9373EE;--ui-primary-10: #362b50;--ui-primary-9: #51407e;--ui-primary-8: #634e9b;--ui-primary-7: #7a60c4;--ui-primary-7-p: 122, 96, 196;--ui-primary-6: #9373EE;--ui-primary-6-p: 147, 115, 238;--ui-primary-5: #b499f4;--ui-primary-5-p: 180, 153, 244;--ui-primary-4: #cebaf8;--ui-primary-3: #dfd1fb;--ui-primary-2: #ebe2fc;--ui-primary-1: #f3eefe;--ui-primary-1-p: 243, 238, 254;--ui-primary-a: #f7f3fe;--ui-primary-b: #fbf9ff;--g-color-primary: #9373EE;--ui-btn-primary-color: #fff;--ui-lime-6-p: 160,217,17;--ui-orange-6-p: 250,140,22;--ui-yellow-6-p: 250,219,20;--ui-pink-6-p: 235,47,150;--ui-body-background: #ffffff;--theme-tars-item-active-bg: var(--ui-tree-node-selected-bg);--ifm-menu-color: var(--ui-text-color-sub);--ifm-menu-color-active: var(--ui-text-color-sub);--ifm-menu-color-background-hover: var(--ui-item-hover-bg);--theme-tars-border-color-split: var(--ui-border-color-split);","--ui-primary-color-hover: var(--ui-primary-7);--ui-primary-color-active: var(--ui-primary-5);--ui-picker-basic-cell-hover-with-range-color: #312865;--ui-picker-date-hover-range-border-color: #4b3d9c;--ui-primary-base: #8276C9;--ui-primary-base-p: 130, 118, 201;--ui-primary-color-p: 130, 118, 201;--ui-primary-color: #8276C9;--ui-primary-10: #dcd7f0;--ui-primary-9: #a69bd9;--ui-primary-8: #b0a5dd;--ui-primary-7: #9c90d4;--ui-primary-7-p: 156, 144, 212;--ui-primary-6: #8276C9;--ui-primary-6-p: 130, 118, 201;--ui-primary-5: #635a96;--ui-primary-5-p: 99, 90, 150;--ui-primary-4: #49436c;--ui-primary-3: #393452;--ui-primary-2: #312d46;--ui-primary-1: #252333;--ui-primary-1-p: 37, 35, 51;--ui-primary-a: #21202d;--ui-primary-b: #1e1c28;--g-color-primary: #8276C9;--ui-btn-primary-color: #fff;--ui-lime-6-p: 160,217,17;--ui-orange-6-p: 250,140,22;--ui-yellow-6-p: 250,219,20;--ui-pink-6-p: 235,47,150;--ui-body-background: #1a1922;--theme-tars-item-active-bg: var(--ui-tree-node-selected-bg);--ifm-menu-color: var(--ui-text-color-sub);--ifm-menu-color-active: var(--ui-text-color-sub);--ifm-menu-color-background-hover: var(--ui-item-hover-bg);--theme-tars-border-color-split: var(--ui-border-color-split);","routes/_index/route","actionData","errors"]

CalculateRouteResponse