Skip to content

point.md

Latest commit

 

History

History
49 lines (27 loc) · 1010 Bytes

point.md

File metadata and controls

49 lines (27 loc) · 1010 Bytes

Matched point

Returns GeoJSON data for ShareStreets point references using map matching filters.

  • URL

    /match/point/[lng],[lat]

    /match/point/[lng],[lat],[bearing]

  • Method:

    GET

  • URL Params

    Required

    authKey=[SharedStrets API Key]

    Optional:

    bearingTolerance=[decimalDegrees] Degrees tolerance (+/-) to allow for directional point queries.

    searchRadius=[meters] Search radius in meters for snapping points to SharedStreets references.

    maxCandidates=[integer] Maximum number of candidate matches to include in results.

  • Data Params

    [lat] Latitude in decimal degrees

    [lng] Longitude in decimal degrees

    [bearing] Bearing in decimal degrees (Optional)

  • Success Response:

    • Code: 200
      Content: {type:"FeatureCollection", features: [...]}

    • Code: 401 UNAUTHORIZED
      Content: { error : "You are unauthorized to make this request." }