/sharedstreets-api

Docs and examples for the SharedStreets REST API

MIT LicenseMIT

SharedStreets API

Global SharedStreets Tile Sets

SharedStreets generates and publishes a global OpenStreetMap-derived tile set of street segment references, geometries, intersections and metadata encoded in protocol bufffer format (see the SharedStreets Referencing System for details). These tiles are generated from periodic weekly planet.osm snapshots and converted to mercator z-12 tiles. The tiles are made available for download via the following endpoint:

https://tiles.sharedstreets.io/osm/{planet-yymmdd}/12-{x}-{y}.{geometry|reference|metadata|intersection}.6.pbf

For a givien planet tile build (e.g. planet-180430) a valid request looks like:

https://tiles.sharedstreets.io/osm/planet-180430/12-1171-1566.geometry.6.pbf

SharedStreets API

SharedStreets maintains an API that provides convenience functions on top of the tile data sets. These functions convert data to JSON and GeoJSON formats and allow dynamic map matching from point and line geometries.

Base URL + Versioning

The SharedStreets API calls described below can be made via the following semantically versioned endpoint:

https://api.sharedstreets.io/v0.1.0[/request]

All API endpoints require a valid key to be included in the request.

API Endpoints requiring API Key authorization

Geometries

Endpoints for requesting SharedStreets data as GeoJSON:

Point and Geometry Matching

Endpoints for dynamic map matching from point and line geometries: