## Calculate a route between two points

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

Calculate a route between two points

### Body Parameters

- `destination: GeoJsonGeometry`

  Destination point (GeoJSON Point geometry)

  - `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)

    - `array of number`

    - `array of array of number`

    - `array of array of array of number`

    - `array of array of array of array of number`

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

    - `"Point"`

    - `"LineString"`

    - `"Polygon"`

    - `"MultiPoint"`

    - `"MultiLineString"`

    - `"MultiPolygon"`

- `origin: GeoJsonGeometry`

  Origin point (GeoJSON Point geometry)

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

  - `"auto"`

  - `"foot"`

  - `"bicycle"`

### Returns

- `RouteResult = object { geometry, properties, type }`

  - `geometry: GeoJsonGeometry`

    - `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)

      - `array of number`

      - `array of array of number`

      - `array of array of array of number`

      - `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

```http
curl https://plaza.fyi/api/v1/route \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $PLAZA_API_KEY" \
    -d '{
          "destination": {
            "coordinates": [
              0
            ],
            "type": "Point"
          },
          "origin": {
            "coordinates": [
              0
            ],
            "type": "Point"
          }
        }'
```