# Map Match

## Match GPS coordinates to the road network

`client.mapMatch.match(MapMatchMatchParamsbody, RequestOptionsoptions?): MapMatchResult`

**post** `/api/v1/map-match`

Match GPS coordinates to the road network

### Parameters

- `body: MapMatchMatchParams`

  - `coordinates: Array<Coordinate>`

    GPS coordinates to match, in order of travel (max 50 points)

    - `lat: number`

      Latitude in decimal degrees (-90 to 90)

    - `lng: number`

      Longitude in decimal degrees (-180 to 180)

  - `radiuses?: Array<number> | null`

    Search radius per coordinate in meters. Must have the same length as `coordinates` or be omitted entirely. Default: 50m per point.

### Returns

- `MapMatchResult`

  Map matching result as a GeoJSON FeatureCollection. Each Feature is a snapped tracepoint. The top-level `matchings` array contains the matched sub-routes connecting consecutive tracepoints.

  - `features: Array<Feature>`

    Snapped tracepoint Features in input order

    - `geometry: GeoJsonGeometry`

      GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.

      - `coordinates: Array<number> | Array<Array<number>> | Array<Array<Array<number>>> | Array<Array<Array<Array<number>>>>`

        Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc.

        - `Array<number>`

        - `Array<Array<number>>`

        - `Array<Array<Array<number>>>`

        - `Array<Array<Array<Array<number>>>>`

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

        Geometry type

        - `"Point"`

        - `"LineString"`

        - `"Polygon"`

        - `"MultiPoint"`

        - `"MultiLineString"`

        - `"MultiPolygon"`

    - `properties: Properties`

      - `distance_m?: number`

        Distance from the original GPS point to the snapped point in meters

      - `edge_id?: number`

        Road edge ID the point was snapped to

      - `matchings_index?: number`

        Index into the `matchings` array indicating which matching sub-route this point belongs to

      - `name?: string | null`

        Road name at the snapped point

      - `original?: Array<number>`

        Original GPS coordinate as [lng, lat]

      - `waypoint_index?: number`

        Index of this tracepoint in the original `coordinates` array

    - `type: "Feature"`

      - `"Feature"`

  - `matchings: Array<Record<string, unknown>>`

    Matched sub-routes. Each matching connects a contiguous sequence of tracepoints that could be matched to roads.

  - `type: "FeatureCollection"`

    - `"FeatureCollection"`

### Example

```typescript
import Plaza from '@plazafyi/sdk';

const client = new Plaza({
  apiKey: process.env['PLAZA_API_KEY'], // This is the default and can be omitted
});

const mapMatchResult = await client.mapMatch.match({
  coordinates: [
    { lat: 48.8566, lng: 2.3522 },
    { lat: 48.857, lng: 2.353 },
    { lat: 48.8575, lng: 2.354 },
  ],
});

console.log(mapMatchResult.features);
```

#### Response

```json
{
  "features": [
    {
      "geometry": {
        "coordinates": [
          2.3522,
          48.8566
        ],
        "type": "Point"
      },
      "properties": {
        "distance_m": 0,
        "edge_id": 0,
        "matchings_index": 0,
        "name": "name",
        "original": [
          0,
          0
        ],
        "waypoint_index": 0
      },
      "type": "Feature"
    }
  ],
  "matchings": [
    {
      "foo": "bar"
    }
  ],
  "type": "FeatureCollection"
}
```

## Domain Types

### Map Match Request

- `MapMatchRequest`

  GPS trace to snap to the road network. Provide an array of coordinate objects representing the GPS points. Maximum 50 points per request.

  - `coordinates: Array<Coordinate>`

    GPS coordinates to match, in order of travel (max 50 points)

    - `lat: number`

      Latitude in decimal degrees (-90 to 90)

    - `lng: number`

      Longitude in decimal degrees (-180 to 180)

  - `radiuses?: Array<number> | null`

    Search radius per coordinate in meters. Must have the same length as `coordinates` or be omitted entirely. Default: 50m per point.

### Map Match Result

- `MapMatchResult`

  Map matching result as a GeoJSON FeatureCollection. Each Feature is a snapped tracepoint. The top-level `matchings` array contains the matched sub-routes connecting consecutive tracepoints.

  - `features: Array<Feature>`

    Snapped tracepoint Features in input order

    - `geometry: GeoJsonGeometry`

      GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.

      - `coordinates: Array<number> | Array<Array<number>> | Array<Array<Array<number>>> | Array<Array<Array<Array<number>>>>`

        Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc.

        - `Array<number>`

        - `Array<Array<number>>`

        - `Array<Array<Array<number>>>`

        - `Array<Array<Array<Array<number>>>>`

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

        Geometry type

        - `"Point"`

        - `"LineString"`

        - `"Polygon"`

        - `"MultiPoint"`

        - `"MultiLineString"`

        - `"MultiPolygon"`

    - `properties: Properties`

      - `distance_m?: number`

        Distance from the original GPS point to the snapped point in meters

      - `edge_id?: number`

        Road edge ID the point was snapped to

      - `matchings_index?: number`

        Index into the `matchings` array indicating which matching sub-route this point belongs to

      - `name?: string | null`

        Road name at the snapped point

      - `original?: Array<number>`

        Original GPS coordinate as [lng, lat]

      - `waypoint_index?: number`

        Index of this tracepoint in the original `coordinates` array

    - `type: "Feature"`

      - `"Feature"`

  - `matchings: Array<Record<string, unknown>>`

    Matched sub-routes. Each matching connects a contiguous sequence of tracepoints that could be matched to roads.

  - `type: "FeatureCollection"`

    - `"FeatureCollection"`