points<\/code>) and the calculation mode (calculationMode<\/code>), we will use the following parameters:<\/p>\n\n\n\n\navoidanceTypes<\/code> \u2013 Types of roads or areas to be avoided on the route. We will use CITY<\/code> to avoid urban areas;<\/li>\n\n\n\navoidanceBehavior<\/code> \u2013 Behavior applied to the avoidanceTypes<\/code> restrictions. The possible values are FAIL<\/code>, RELAXED<\/code> and STRONG<\/code>. We will use STRONG<\/code>;<\/li>\n\n\n\ntoll<\/code> \u2013 Parameters related to the Toll API. To see all supported parameters, check the list of Toll API parameters<\/a>:\n\nvehicleType<\/code> \u2013 Vehicle type. We will use \"TRUCK_WITH_TWO_DOUBLE_AXLES\"<\/code>;<\/li>\n\n\n\ntransponderOperators<\/code> \u2013 Desired automatic payment operators. We will use CONECTCAR<\/code> to obtain this operator’s integration codes.<\/li>\n<\/ul>\n<\/li>\n\n\n\ncrossedBorders<\/code> \u2013 Parameters to identify the borders crossed by the route:\n\nlevel<\/code> \u2013 Level of the returned borders. We will use STATE<\/code> to obtain the states crossed;<\/li>\n\n\n\nreverseGeocode<\/code> \u2013 Defines for which points the address will be returned. We will use START_END_LEGS<\/code> to obtain the addresses of the start and end of the legs.<\/li>\n<\/ul>\n<\/li>\n\n\n\nplace<\/code> \u2013 Parameters to search for places along the route. To see all supported parameters, check the list of POIs API parameters<\/a>:\n\ncategories<\/code> \u2013 Categories of the places searched. We will use POSTOS_DE_COMBUSTIVEL<\/code>;<\/li>\n\n\n\nsubCategories<\/code> \u2013 Subcategories of the places searched, for example POSTO_FISCAL<\/code> and BALANCAS<\/code>, from the FISCALIZACAO<\/code> category. Optional parameter, not used in this example;<\/li>\n\n\n\nbufferRouteInMeters<\/code> \u2013 Maximum distance, in meters, between the place and the route. We will use 500<\/code>;<\/li>\n\n\n\nbufferStoppingPointsInMeters<\/code> \u2013 Maximum distance, in meters, between the place and the stopping points. We will use 500<\/code>;<\/li>\n\n\n\nonlyMyPlaces<\/code> \u2013 When true<\/code>, returns only the places registered by the client itself.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n{\n \"points\": [\n {\n \"siteId\": \"Point 1-Casa Branca\",\n \"latitude\": -21.780449,\n \"longitude\": -47.079822\n },\n {\n \"siteId\": \"Point 2-Guaxupe\",\n \"latitude\": -21.312320,\n \"longitude\": -46.717873\n }\n ],\n \"calculationMode\": \"THE_FASTEST\",\n \"avoidanceTypes\": [\n \"CITY\"\n ],\n \"avoidanceBehavior\": \"STRONG\",\n \"toll\": {\n \"vehicleType\": \"TRUCK_WITH_TWO_DOUBLE_AXLES\",\n \"transponderOperators\": [\n \"CONECTCAR\"\n ]\n },\n \"crossedBorders\": {\n \"level\": \"STATE\",\n \"reverseGeocode\": \"START_END_LEGS\"\n },\n \"place\": {\n \"categories\": [\n \"POSTOS_DE_COMBUSTIVEL\"\n ],\n \"bufferRouteInMeters\": 500,\n \"bufferStoppingPointsInMeters\": 500,\n \"onlyMyPlaces\": true\n }\n}<\/pre>\n\n\n\nBelow, the route displayed on the map:<\/p>\n\n\n\n![\"\"](\"https:\/\/developers.maplink.global\/wp-content\/uploads\/2026\/11\/image.png\")
Route between Casa Branca – SP and Guaxup\u00e9 – MG<\/figcaption><\/figure>\n\n\n\nResponse<\/h2>\n\n\n\n
Some response fields are always returned, while others only appear when the corresponding parameter is sent in the request. For example, toll fields are only returned if the toll<\/code> object is sent.<\/p>\n\n\n\nFields always returned<\/h3>\n\n\n\n\nid<\/code> \u2013 Unique identifier of the calculated route;<\/li>\n\n\n\nclientId<\/code> \u2013 Identifier of the client that made the request;<\/li>\n\n\n\ntotalDistance<\/code> \u2013 Total distance of the route, in meters;<\/li>\n\n\n\ntotalNominalDuration<\/code> \u2013 Total nominal duration of the route, in seconds;<\/li>\n\n\n\naverageSpeed<\/code> \u2013 Average speed of the route, in km\/h;<\/li>\n\n\n\nlegs<\/code> \u2013 Array of objects where each object represents a leg of the route. Each object contains the following fields, which are always returned:\n\ndistance<\/code> \u2013 Distance of the leg, in meters;<\/li>\n\n\n\nnominalDuration<\/code> \u2013 Nominal duration of the leg, in seconds;<\/li>\n\n\n\naverageSpeed<\/code> \u2013 Average speed of the leg, in km\/h;<\/li>\n\n\n\npoints<\/code> \u2013 Geometry of the leg. The format depends on the pointsMode<\/code> parameter of the request. To learn more, see how to change the return type of the route coordinates<\/a>.<\/li>\n<\/ul>\n<\/li>\n\n\n\nsource<\/code> \u2013 Origin of the map used to calculate the route. It will always be returned as MAPLINK<\/code>.<\/li>\n\n\n\ncreatedAt<\/code> \u2013 Date and time the route was created, in timestamp<\/em> format;<\/li>\n\n\n\nexpiryIn<\/code> \u2013 Date and time the route expires, in timestamp<\/em> format.<\/li>\n<\/ul>\n\n\n\nFields returned only if the toll<\/code> object is sent<\/h3>\n\n\n\n\ntollCosts<\/code> \u2013 Total toll cost for the entire route;<\/li>\n\n\n\nlegs[].tollCalculation<\/code> \u2013 Object, returned in each leg, with the toll values and information for that leg:\n\ntolls<\/code> \u2013 Array with the values and information of each toll on the leg. Each object returned in tolls<\/code> represents a toll and will contain the following information:\n\nid<\/code> \u2013 Unique identifier of the toll;<\/li>\n\n\n\ntype<\/code> \u2013 Toll type. The possible values are:\n\nTOLL_BOOTH<\/code> \u2013 Conventional toll booths;<\/li>\n\n\n\nMUNICIPAL_TOLL_BOOTH<\/code> \u2013 <\/strong>Similar to TOLL_BOOTH<\/code>, it only identifies that the toll booth is municipal;<\/li>\n\n\n\nTOLL_GANTRY<\/code> \u2013 Corresponds to conventional gantries;<\/li>\n\n\n\nENTRY_GANTRY<\/code> \u2013 Corresponds to entry gantries, used on roads with segment-based billing<\/a>;<\/li>\n\n\n\nEXIT_GANTRY<\/code> \u2013 Corresponds to exit gantries, used on roads with segment-based billing<\/a>.<\/li>\n<\/ul>\n<\/li>\n\n\n\nname<\/code> \u2013 Name of the toll;<\/li>\n\n\n\naddress<\/code> \u2013 Address of the toll;<\/li>\n\n\n\ncity<\/code> \u2013 City of the toll;<\/li>\n\n\n\nstate<\/code> \u2013 Object containing the state name (name<\/code>) and its abbreviation (code<\/code>);<\/li>\n\n\n\ncountry<\/code> \u2013 Country of the toll;<\/li>\n\n\n\nconcession<\/code> \u2013 Concessionaire responsible for the toll;<\/li>\n\n\n\ndirection<\/code> \u2013 Direction of the road in which the toll is charged (for example, NORTH<\/code>, EAST<\/code> or SOUTHEAST<\/code>);<\/li>\n\n\n\ncoordinates<\/code> \u2013 Coordinates (latitude and longitude) of the toll;<\/li>\n\n\n\nprice<\/code> \u2013 Price per toll;<\/li>\n\n\n\nconditions<\/code> \u2013 Array with differentiated toll values according to the billing type. Returned only for tolls that have this type of value:\n\nbillingsType<\/code> \u2013 Array with the billing types to which the value applies, for example TAG<\/code>;<\/li>\n\n\n\nvalue<\/code> \u2013 Toll value for the informed billing types.<\/li>\n<\/ul>\n<\/li>\n\n\n\ncurrency<\/code> \u2013 Currency used by the toll. The possible values are:\n\nBRL<\/code> \u2013 Brazilian real;<\/li>\n\n\n\nARS<\/code> \u2013 Argentine peso;<\/li>\n\n\n\nCLP<\/code> \u2013 Chilean peso;<\/li>\n\n\n\nCOP<\/code> \u2013 Colombian peso;<\/li>\n\n\n\nMXN<\/code> \u2013 Mexican peso.<\/li>\n<\/ul>\n<\/li>\n\n\n\nserviceTypes<\/code> \u2013 Array with codes for integration with automatic payment systems. Currently available only in Brazil. In addition to ANTTCODE<\/code>, the codes of the operators informed in toll.transponderOperators<\/code> are returned (in this example, CONECTCAR<\/code>);\n\nserviceId<\/code> \u2013 Code for the integration;<\/li>\n\n\n\nname<\/code> \u2013 Description of the service code.<\/li>\n<\/ul>\n<\/li>\n\n\n\nactive<\/code> \u2013 Indicates whether the toll is active (true<\/code>) or not (false<\/code>).<\/li>\n<\/ul>\n<\/li>\n\n\n\nlegTotalCost<\/code> \u2013 Total toll cost for the leg;<\/li>\n\n\n\nvehicleType<\/code> \u2013 Vehicle type considered for the leg. It may vary between legs when toll.variableAxles<\/code> is sent;<\/li>\n\n\n\ncalculationDate<\/code> \u2013 Date and time considered for the leg, in timestamp<\/em> format. The base date is the value of toll.calculationDate<\/code> (or the request time, if not sent), plus the nominal duration of the previous legs. Therefore, on routes with more than one leg, the value increases with each leg;<\/li>\n\n\n\ncondition<\/code> \u2013 Returned only if the toll.condition<\/code> parameter is used in the request. Contains which billingType<\/code> and period<\/code> were considered for the leg.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\nFields returned only if crossedBorders.level<\/code> is sent<\/h3>\n\n\n\n\ncrossedBorders<\/code> \u2013 Array of objects where each object represents a border crossed by the route, according to the level informed in crossedBorders.level<\/code> (in this example, STATE<\/code>), in the order in which they were crossed:\n\nstate<\/code> \u2013 State abbreviation;<\/li>\n\n\n\ncity<\/code> \u2013 City name. Returned when level<\/code> is CITY<\/code>;<\/li>\n\n\n\ncountry<\/code> \u2013 Country of the border.<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\nFields returned only if crossedBorders.reverseGeocode<\/code> is sent<\/h3>\n\n\n\nThese fields are independent of crossedBorders.level<\/code>. With START_END<\/code>, startAddress<\/code> and endAddress<\/code> are returned. With START_END_LEGS<\/code>, legs[].firstPointAddress<\/code> is also returned.<\/p>\n\n\n\n\nstartAddress<\/code> \u2013 Address of the route’s origin point. The object contains the following information:\n\nroad<\/code> \u2013 Street;<\/li>\n\n\n\ndistrict<\/code> \u2013 Neighborhood;<\/li>\n\n\n\nzipCode<\/code> \u2013 Postal code;<\/li>\n\n\n\ncity<\/code> \u2013 City;<\/li>\n\n\n\nstate<\/code> \u2013 Object containing the state name (name<\/code>) and its abbreviation (code<\/code>);<\/li>\n\n\n\nmainLocation<\/code> \u2013 Coordinates (lat<\/code> and lon<\/code>) of the address found;<\/li>\n\n\n\n- When available for the address,
geometry<\/code> (array of lat<\/code> and lon<\/code> coordinates of the road), leftZipCode<\/code> and rightZipCode<\/code> (postal code of each side of the road), leftFirstNumber<\/code>, leftLastNumber<\/code>, rightFirstNumber<\/code> and rightLastNumber<\/code> (first and last numbering of each side of the road) may also be returned.<\/li>\n<\/ul>\n<\/li>\n\n\n\nendAddress<\/code> \u2013 Address of the route’s destination point, with the same structure as the