For AI agents: a documentation index is available at /llms.txt. Markdown versions of all pages are available by appending .md to any URL.
Interface RoutingResponseOptions
interface RoutingResponseOptions {
additionalData?: { detailLevel?: RoutingDetailLevel };
alternates?: number;
language?: RoutingInstructionsLanguage;
units?: RoutingDistanceUnit;
}
additionalData?: { detailLevel?: RoutingDetailLevel };
alternates?: number;
language?: RoutingInstructionsLanguage;
units?: RoutingDistanceUnit;
}
Index
Properties
Properties
OptionaladditionalData
Additional data returned with the route
Type Declaration
OptionaldetailLevel?: RoutingDetailLevelLevel of detail: legs, steps or instructions
Optionalalternates
alternates?: number
Number of alternate routes to generate. Whole numbers only. Maximum: 3. Note that alternates are not generated when the request contains more than two locations.
Optionallanguage
Language of navigation instructions
Optionalunits
Units for distance
Response formatting options supported by both endpoints.