API Documentation - ProjectSidewalk/SidewalkWebpage GitHub Wiki

API Documentation has moved 📦

Project Sidewalk's API documentation now lives in the app itself as interactive, always-up-to-date docs — generated from the same routes and data structures the API serves, so it never drifts from the implementation:

➡️ projectsidewalk.org/api (or /api on any city deployment, e.g. sidewalk-sea.cs.washington.edu/api)

Every endpoint has its own page with parameters, output fields, and live examples — including the current AccessScore endpoints (GET /v3/api/accessScoreStreets and GET /v3/api/accessScoreRegions), whose severity-, quality-, and tag-aware scoring algorithm is documented there.

Note: the old /v2/access/score/* endpoints and their simpler significance-weighted algorithm that this page used to describe have been removed (issues #3855 / #3864). Use the /v3/api/... endpoints instead.

Please update your bookmarks. This page is kept only as a redirect. See issue #4252 for the broader effort to consolidate Project Sidewalk documentation.