{"id":21678219,"url":"https://github.com/sharedstreets/sharedstreets-api","last_synced_at":"2025-08-24T11:42:29.242Z","repository":{"id":57358053,"uuid":"136482094","full_name":"sharedstreets/sharedstreets-api","owner":"sharedstreets","description":"Docs and examples for the SharedStreets REST API","archived":false,"fork":false,"pushed_at":"2022-10-11T18:54:49.000Z","size":39,"stargazers_count":6,"open_issues_count":6,"forks_count":7,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-09T15:56:10.426Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sharedstreets.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-06-07T13:33:35.000Z","updated_at":"2024-01-06T05:29:59.000Z","dependencies_parsed_at":"2023-01-19T19:26:20.478Z","dependency_job_id":null,"html_url":"https://github.com/sharedstreets/sharedstreets-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/sharedstreets/sharedstreets-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sharedstreets%2Fsharedstreets-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sharedstreets%2Fsharedstreets-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sharedstreets%2Fsharedstreets-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sharedstreets%2Fsharedstreets-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sharedstreets","download_url":"https://codeload.github.com/sharedstreets/sharedstreets-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sharedstreets%2Fsharedstreets-api/sbom","scorecard":{"id":816387,"data":{"date":"2025-08-11","repo":{"name":"github.com/sharedstreets/sharedstreets-api","commit":"3a39b7e9786aab953b9ef1ba4e4516ee0704fc82"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Code-Review","score":0,"reason":"Found 0/28 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-23T14:21:30.617Z","repository_id":57358053,"created_at":"2025-08-23T14:21:30.617Z","updated_at":"2025-08-23T14:21:30.617Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271854475,"owners_count":24834453,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-24T02:00:11.135Z","response_time":111,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-25T14:27:19.656Z","updated_at":"2025-08-24T11:42:29.194Z","avatar_url":"https://github.com/sharedstreets.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# SharedStreets API\n\n## Global SharedStreets Tile Sets\n\nSharedStreets 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](https://github.com/sharedstreets/sharedstreets-ref-system) for details). These tiles are generated from periodic weekly [planet.osm](https://planet.openstreetmap.org/) snapshots and converted to mercator z-12 tiles. The tiles are made available for download via the following endpoint:\n\n`https://tiles.sharedstreets.io/osm/{planet-yymmdd}/12-{x}-{y}.{geometry|reference|metadata|intersection}.6.pbf` \n\nFor a givien planet tile build (e.g. planet-180430) a valid request looks like:\n\n`https://tiles.sharedstreets.io/osm/planet-180430/12-1171-1566.geometry.6.pbf`\n\n### Versioned OSM data sources\nSharedStreets maintains ~monthly global builds for OpenStreetMap, starting from March 2018. Currently available planet data sets are include:\n\n* planet-180312\n* planet-180430 (current default for API calls)\n* planet-180528\n* planet-180625\n* planet-180730\n* planet-180827\n* planet-180924\n* planet-181029\n* planet-181126\n* planet-181224\n\n\n\n## SharedStreets API \n\nSharedStreets 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. \n\n#### Base URL + Versioning\nThe SharedStreets API calls described below can be made via the following semantically versioned endpoint:\n\n`https://api.sharedstreets.io/v0.1.0[/request]`\n\nAll API endpoints require a valid key to be included in the request.\n\n#### Data source\nSharedStreets API calls target specific data sources for matching and ID look up. Current API calls default to the planet-180430 OSM data source, but can be set to use any available OSM data source by using the `\u0026dataSource=[osm/planet-yymmdd]` querystring parameter. Future versions of the API will allow selection of GIS and other non-OSM data sources.\n\n### Public API Endpoints \n\n#### Identifiers\n\n* [SharedStreets and OpenStreetMap ID lookup](query/id.md): `GET /id`\n\n### API Endpoints requiring API Key authorization\n\n#### Geometries\n\nEndpoints for requesting SharedStreets data as GeoJSON:\n\n* [Geometries within bbox](geom/within.md) : `GET /geom/within`\n\n\n#### Point and Geometry Matching\n\nEndpoints for dynamic map matching from point and line geometries:\n\n* [Match point](match/point.md) : `GET /match/point`\n* [Match points from GeoJSON](match/points.md) : `POST /match/points`\n* [Match geometries from GeoJSON](match/geoms.md) : `POST /match/geoms`\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsharedstreets%2Fsharedstreets-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsharedstreets%2Fsharedstreets-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsharedstreets%2Fsharedstreets-api/lists"}