<!--
{
  "availability" : [
    "MapKit JS: 5.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "MapKitJS",
  "identifier" : "/documentation/MapKitJS/DirectionsRequest",
  "metadataVersion" : "0.1.0",
  "role" : "Interface",
  "symbol" : {
    "kind" : "Interface",
    "modules" : [
      "MapKit JS"
    ],
    "preciseIdentifier" : "struct/mapkit.DirectionsRequest"
  },
  "title" : "DirectionsRequest"
}
-->

# DirectionsRequest

The requested start and end points for a route, as well as the planned mode of transportation.

```
interface DirectionsRequest
```

## Overview

Provide a `DirectionsRequest` object to the [`route(request)`](/documentation/MapKitJS/Directions/route) method to get directions between two points. You must provide [`origin`](/documentation/MapKitJS/DirectionsRequest/origin) and [`destination`](/documentation/MapKitJS/DirectionsRequest/destination).

```javascript
const myDirections = new mapkit.Directions();
const data = await myDirections.route({
    origin: "San Francisco, CA",
    destination: "Oakland, CA",
    transportType: mapkit.Directions.Transport.Automobile,
});
```

## Topics

### Directions request

[`origin: string | CoordinateData | Place;`](/documentation/MapKitJS/DirectionsRequest/origin)

The starting point for routing directions.

[`destination: string | CoordinateData | Place;`](/documentation/MapKitJS/DirectionsRequest/destination)

The end point for routing directions.

[`arrivalDate?: Date;`](/documentation/MapKitJS/DirectionsRequest/arrivalDate)

The arrival date for the trip.

[`departureDate?: Date;`](/documentation/MapKitJS/DirectionsRequest/departureDate)

The departure date for the trip.

[`requestsAlternateRoutes?: boolean;`](/documentation/MapKitJS/DirectionsRequest/requestsAlternateRoutes)

A Boolean value that indicates whether the server returns multiple routes when they’re available.

[`transportType?: TransportType;`](/documentation/MapKitJS/DirectionsRequest/transportType)

The mode of transportation the directions apply to.

[`avoidTolls?: boolean;`](/documentation/MapKitJS/DirectionsRequest/avoidTolls)

A Boolean value that prioritizes routes to avoid tolls.

[`signal?: AbortSignal;`](/documentation/MapKitJS/DirectionsRequest/signal)

A signal object allowing you to cancel the request.


---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)