How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Route API

The Route API from Microsoft Azure — 4 operation(s) for route.

Microsoft Azure Route API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Route. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 5 operations across 4 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

5 operations 4 paths 34 schemas 2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Route 5
POST
/route/matrix/{format}
Microsoft Azure Post Route Matrix Format
microsoftAzureRoutePostroutematrix 22 params body → 200202400401403404500
GET
/route/directions/{format}
Microsoft Azure Get Route Directions Format
microsoftAzureRouteGetroutedirections 46 params → 200400401403404500
POST
/route/directions/{format}
Microsoft Azure Post Route Directions Format
microsoftAzureRoutePostroutedirections 46 params body → 200400401403404500
GET
/route/range/{format}
Microsoft Azure Get Route Range Format
microsoftAzureRouteGetrouterange 37 params → 200400401403404500
POST
/route/directions/batch/{format}
Microsoft Azure Post Route Directions Batch Format
microsoftAzureRoutePostroutedirectionsbatch 4 params body → 200202400401403404500

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are RouteResultInstruction (19 properties), RouteResultLegSummary (10 properties), RouteResultSection (9 properties), RouteDirectionsSummary (5 properties). Each schema is shown below with its type and property counts.

RouteResultSectionTecCause
object
The cause of the traffic event. Can contain mainCauseCode and subCauseCode elements. Can be used to define iconography and descriptions.
2 properties
Point
object
A valid GeoJSON Point geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946section-3.1.2) for details.
RouteResponseReport
object
Reports the effective settings used in the current call.
1 property
MultiPolygon
object
A valid GeoJSON MultiPolygon object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946section-3.1.7) for details.
RouteRange
object
Reachable Range
2 properties
RouteMatrixResultResponse
object
Response object of the current cell in the input matrix.
1 property
RouteResultInstruction
object
A set of attributes describing a maneuver, e.g. 'Turn right', 'Keep left', 'Take the ferry', 'Take the motorway', 'Arrive'.
19 properties
RouteResultGuidance
object
Contains guidance related elements. This field is present only when guidance was requested and is available.
2 properties
RouteDirectionsResult
object
4 properties
RouteResultInstructionGroup
object
Groups a sequence of instruction elements which are related to each other. The sequence range is constrained with firstInstructionIndex and lastInstructionInde…
4 properties
RouteResponseReportEffectiveSetting
object
Effective parameter or data used when calling this Route API.
2 properties
BatchResponse
object
This object is returned from a successful Batch service call
2 properties
RouteRangeResponse
object
This object is returned from a successful Route Reachable Range call
3 properties
GeoJSONLinearRing
array
Though a linear ring is not explicitly represented as a GeoJSON geometry type, it helps in defining the polygon as an array of linear rings. Please refer to [R…
GeoJSONGeometry
object
A valid GeoJSON geometry object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946section-3.1) for details.
1 property 1 required
RouteDirectionsSummary
object
Summary object
5 properties
RouteResultSectionTec
object
Details of the traffic event, using definitions in the [TPEG2-TEC](https://www.iso.org/standard/63116.html) standard. Can contain effectCode and causes element…
2 properties
GeoJSONPosition
array
A valid GeoJSON Position geometry type. A Position is an array of numbers with two or more elements. The first two elements are longitude and latitude, precise…
RouteMatrixSummary
object
Summary object
2 properties
RouteMatrixResult
object
Matrix result object
2 properties
RouteOptimizedWaypoint
object
Optimized way point object.
2 properties
RouteDirectionsResponse
object
This object is returned from a successful Route Directions call
4 properties
Coordinate
object
A location represented as a latitude and longitude.
2 properties
RouteMatrixRequestBody
object
An object with a matrix of coordinates.
2 properties
RouteMatrixResponse
object
This object is returned from a successful Route Matrix call. For ex, if 2 origins and 3 destinations are provided, there are going to 2 arrays with 3 elements…
3 properties
MultiPoint
object
A valid GeoJSON MultiPoint geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946section-3.1.3) for details.
BatchRequestBody
object
This type represents the request body for the Batch service.
1 property
RouteDirectionsRequestBody
object
Post body parameters for Route directions.
4 properties
ODataErrorResponse
object
This response object is returned when an error occurs in the Azure Maps API.
1 property
RouteResultLeg
object
2 properties
RouteResultLegSummary
object
Summary object for route section.
10 properties
GeoJSONGeometryCollection
object
A valid GeoJSON GeometryCollection object type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946section-3.1.8) for details.
2 properties 1 required
ODataError
object
This object is returned when an error occurs in the Azure Maps API.
4 properties
RouteResultSection
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-route-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Route API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.