## Calculate a route between two points

`$ plaza routing route`

**post** `/api/v1/route`

Calculate a route between two points

### Parameters

- `--destination: object { coordinates, type }`

  Destination point (GeoJSON Point geometry)

- `--origin: object { coordinates, type }`

  Origin point (GeoJSON Point geometry)

- `--mode: optional "auto" or "foot" or "bicycle"`

### Returns

- `route_result: object { geometry, properties, type }`

  - `geometry: object { coordinates, type }`

    - `coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number`

      GeoJSON coordinates array (nesting depth varies by geometry type)

      - `union_member_0: array of number`

      - `union_member_1: array of array of number`

      - `union_member_2: array of array of array of number`

      - `union_member_3: array of array of array of array of number`

    - `type: "Point" or "LineString" or "Polygon" or 3 more`

      - `"Point"`

      - `"LineString"`

      - `"Polygon"`

      - `"MultiPoint"`

      - `"MultiLineString"`

      - `"MultiPolygon"`

  - `properties: object { distance, duration, mode }`

    - `distance: optional number`

      Total distance in meters

    - `duration: optional number`

      Estimated duration in seconds

    - `mode: optional string`

      Travel mode used

  - `type: "Feature"`

    - `"Feature"`

### Example

```cli
plaza routing route \
  --api-key 'My API Key' \
  --destination '{coordinates: [0], type: Point}' \
  --origin '{coordinates: [0], type: Point}'
```