Project Sidewalk

Welcome back

Project Sidewalk

Join Project Sidewalk

Map sidewalks. Help make your city accessible to everyone.

3–30 characters — letters, numbers, hyphens, and underscores

Pick a nickname — you don't have to use your real name. It's shown publicly on the leaderboard and your profile, and you can change it anytime.

  • At least 8 characters
  • One uppercase letter
  • One lowercase letter
  • One number
Passwords match

Streets API

The Streets API provides access to Project Sidewalk's street segment data, including auditing statistics, accessibility label counts, and geographic information. Project Sidewalk uses OpenStreetMap for street data, filtered to particular way types. Users are routed through these streets to find and label sidewalk accessibility features and barriers. Each street also carries its running grade, measured from an elevation model rather than labeled, so unaudited streets have it too (see Street grade). OSM-derived fields (street geometry, way_type, max_speed) are © OpenStreetMap contributors, available under the Open Database License.

Streets API Preview

Below is a live preview of street data from a sample region in Virden, IL retrieved directly from the API. We show visualizations of user counts per street, the most recent label date per street, and the number of labels per street. You can hover and click on individual street segments to view more information.

Note: In these examples, we are visualizing Project Sidewalk data only in a single region; however, the Streets API can return data from all regions in the city or just a selected region—see the API Query Parameters below.

User Count Visualization

Visualizes user counts per street segment. More specifically, streets are color-coded by the number of users who added at least one label to the segments. You can hover and click on streets to view more information.

Audit Age Visualization

Displays the age of audits for each street segment. Streets are color-coded based on how recently they were audited, helping identify areas that may need fresh accessibility assessments. You can hover and click on streets to view more information.

Label Count Visualization

Shows the total number of accessibility labels placed on each street segment. Streets are color-coded by label density, indicating areas with more or fewer accessibility annotations. You can hover and click on streets to view more information.

Street grade

Every street carries ten grade fields, mean_grade through dem_source: its running grade (how steep it is along its length), sampled along its centerline from a bare-earth elevation model. Grade needs no labeling, so it is there for unaudited streets too, and it is null on a street that has not been sampled, including every street in a city whose grades have not been imported. The same fields, from the same source, ride on the AccessScore: Streets API, where they also feed each street's score. This API says grade and never slope, which accessibility standards also use for a sidewalk's cross slope: that cannot be measured from a centerline and is not reported.

A bare-earth model removes bridges and knows nothing of tunnels, so a street on a structure reports grade_quality: "structure" and no grade, not the grade of the ground beneath it. How grades are sampled, and how accurate they are, is on the Street Grade API page, which also serves one street's elevation profile, the one grade field too heavy for a city-wide file.

Elevation model credits

Each street names the model it was sampled from in dem_source. If you publish the grade fields, credit the model as below, and cite it where you would cite data; /v3/api/accessScoreConfig lists the ones this city uses under grade.sources, with the same credit lines and citations. A city sampled from rasters that are not in this table yet is credited by its dem_source alone.

dem_sourceElevation modelCreditLicenceCitation
usgs-3dep-10m USGS 3DEP 1/3 arc-second seamless DEM Elevation: U.S. Geological Survey, 3D Elevation Program Public domain U.S. Geological Survey, 2024, 1/3rd arc-second Digital Elevation Models (DEMs) - USGS National Map 3DEP Downloadable Data Collection: U.S. Geological Survey.
swissalti3d-2m swissALTI3D (2 m) Elevation: © swisstopo (Federal Office of Topography), swissALTI3D swisstopo OGD terms of use (attribution required) —
linz-nz-1m New Zealand LiDAR 1m DEM (LINZ) Elevation: Sourced from the LINZ Data Service and licensed by Toitū Te Whenua Land Information New Zealand, for re-use under CC BY 4.0 CC BY 4.0 New Zealand Elevation was accessed from https://registry.opendata.aws/nz-elevation.
nrcan-hrdem-mosaic-2m High Resolution Digital Elevation Model Mosaic (HRDEM Mosaic), CanElevation Series (2 m) Elevation: Natural Resources Canada, HRDEM Mosaic. Contains information licensed under the Open Government Licence – Canada Open Government Licence – Canada 2.0 —
gedtm30 Global Ensemble Digital Terrain Model 30m (GEDTM30), v1.1 Elevation: GEDTM30 © OpenGeoHub, Ho & Hengl (CC BY 4.0) CC BY 4.0 Ho, Y.-F., Grohmann, C.H., Lindsay, J., Reuter, H.I., Parente, L., Witjes, M., & Hengl, T. (2025). Global Ensemble Digital Terrain modeling and parametrization at 30 m resolution (GEDTM30): a data fusion approach based on ICESat-2, GEDI and multisource data. PeerJ 13, e19673. https://doi.org/10.7717/peerj.19673
inegi-mdt-5m Modelo Digital de Elevación de Alta Resolución, tipo Terreno, 5 m (INEGI) Elevation: Fuente: INEGI, Modelo Digital de Elevación de Alta Resolución tipo Terreno 5 m (LiDAR 2011-2012; derivado de sensores remotos satelitales y aerotransportados 2018 en adelante). Street grades derived by Project Sidewalk, not by INEGI Términos de Libre Uso de la Información del INEGI —
ign-lidarhd-mnt-05m MNT LiDAR HD, 0,5 m (IGN) Elevation: IGN, MNT LiDAR HD, data as of 2026-10 (Licence Ouverte / Open Licence 2.0) Licence Ouverte / Open Licence 2.0 (Etalab) —
ahn4-dtm-05m Actueel Hoogtebestand Nederland (AHN4) DTM 0,5 m Elevation: Actueel Hoogtebestand Nederland (AHN4), Rijkswaterstaat via PDOK, CC0 1.0 CC0 1.0 —

Endpoint

Retrieves a list of street segments, optionally filtered by the Query Parameters below.

GET /v3/api/streets

Examples

/v3/api/streets?filetype=geojson Get all streets in GeoJSON format (default)

/v3/api/streets?filetype=geojson&inline=true Get all streets in GeoJSON but opened in the browser

/v3/api/streets?filetype=csv Get all streets in CSV format

/v3/api/streets?minLabelCount=5 Get streets with at least 5 accessibility labels

/v3/api/streets?wayType=residential,primary Get only residential and primary roads

/v3/api/streets?status=no_imagery Get only streets that lack street-view imagery

/v3/api/streets?minAuditCount=2&minUserCount=2 Get streets audited at least twice by at least two different users

Quick Download

Download street data directly in your preferred format:

Note: This downloads all street data. For filtered data, use the API Query Parameters described below.

Query Parameters

Filter the streets returned by this endpoint using the following query parameters. All parameters are optional. Combine multiple filter parameters to narrow down results (filters are applied using AND logic).

Note: When multiple location filters are provided (bbox, regionId, and regionName), bbox takes precedence over region filters, and regionId takes precedence over regionName.

Parameter Type Description
bbox string Filter streets by bounding box. Coordinates should be provided as a comma-separated string in the format: minLongitude,minLatitude,maxLongitude,maxLatitude (e.g., -74.01,40.71,-74.00,40.72). Uses WGS84 (EPSG:4326) coordinates. If omitted, results are not spatially filtered (potentially very large response).
regionId integer Filter streets by region ID. Returns only streets within the specified region. Note: If both bbox and regionId are provided, bbox takes precedence.
regionName string Filter streets by region name. Returns only streets within the specified region. Note: If bbox or regionId are provided, they take precedence over regionName.
minLabelCount integer Filter for streets with at least this many accessibility labels. Useful for focusing on well-documented streets.
minAuditCount integer Filter for streets that have been audited (virtually walked) at least this many times. Higher values indicate more thoroughly examined streets.
minUserCount integer Filter for streets that have been audited by at least this many different users. Higher values indicate streets with more diverse input.
wayType string Filter by one or more way types (road classifications, mostly following OSM's highway values). Provide comma-separated values (e.g., wayType=residential,primary). Valid values: motorway, motorway_link, trunk, trunk_link, primary, primary_link, secondary, secondary_link, tertiary, tertiary_link, unclassified, residential, living_street, pedestrian, service, road, track, raceway, footway, cycleway, path, bridleway, steps, corridor, crossing, construction, border, subway, and unknown (streets from non-OSM imports). The types present in a given city are listed by the Street Types API. Unrecognized values return a 400 error.
status string Filter by one or more street statuses. Provide comma-separated values (e.g., status=open,no_imagery). Valid values: open (usable for auditing), no_imagery (no street-view imagery available), closed (in a region not yet opened to the public), disabled (manually hidden, e.g. an OSM miscategorization). By default all statuses are returned.
filetype string Specify the output format. Options: geojson (default), csv, shapefile, geopackage.
inline boolean Whether to display the file inline or as an attachment. Default: false (attachment). Set to true to view data in the browser instead of downloading.

Responses

Success Response (200 OK)

On success, the API returns an HTTP 200 OK status code and the requested data in the specified filetype format.

GeoJSON Format (Default)

Returns a GeoJSON FeatureCollection where each feature represents a single street segment. Coordinate Reference System (CRS) is WGS84 (EPSG:4326).

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
      "type": "LineString",
      "coordinates": [
        [-74.0243606567383, 40.8839912414551],
        [-74.0244835449219, 40.8838416503906],
        [-74.0245123456789, 40.8836789012345]
      ]
      },
      "properties": {
        "street_edge_id": 951,
        "osm_way_id": 11584845,
        "region_id": 8,
        "region_name": "Teaneck Community Charter School",
        "way_type": "residential",
        "max_speed": "25 mph",
        "status": "open",
        "user_ids": [
          "18b26a38-24ab-402d-a64e-158fc0bb8a8a",
          "53ad4d79-9a7b-4d3c-a753-63bbfca34c9b"
        ],
        "label_count": 23,
        "audit_count": 5,
        "outdated": false,
        "user_count": 2,
        "first_label_date": "2023-06-20T14:32:45Z",
        "last_label_date": "2023-08-15T10:22:18Z",
        "osm_ways": [
          {
            "osm_way_id": 11584845,
            "street_from_frac": 0,
            "street_to_frac": 0.62,
            "way_from_frac": 0.4,
            "way_to_frac": 1,
            "same_direction": true
          },
          {
            "osm_way_id": 11584846,
            "street_from_frac": 0.62,
            "street_to_frac": 1,
            "way_from_frac": 0.75,
            "way_to_frac": 1,
            "same_direction": false
          }
        ],
        "mean_grade": 0.0412,
        "max_grade": 0.0687,
        "net_grade": -0.0398,
        "total_climb_meters": 0.4,
        "total_descent_meters": 5.1,
        "meters_over_5pct": 32.5,
        "meters_over_8pct": 0.0,
        "grade_confidence": "high",
        "grade_quality": "measured",
        "dem_source": "usgs-3dep-10m"
      }
    },
    {
      "type": "Feature",
      "geometry": {
      "type": "LineString",
      "coordinates": [
        [-74.0245835449219, 40.8835416503906],
        [-74.0246123456789, 40.8833789012345]
      ]
      },
      "properties": {
        "street_edge_id": 952,
        "osm_way_id": 11566031,
        "region_id": 8,
        "region_name": "Teaneck Community Charter School",
        "way_type": "primary",
        "max_speed": null,
        "status": "open",
        "user_ids": [
          "8af92eb8-fb84-4aa6-9539-abc95216dcd7"
        ],
        "label_count": 8,
        "audit_count": 1,
        "outdated": false,
        "user_count": 1,
        "first_label_date": "2023-06-22T11:12:24Z",
        "last_label_date": "2023-06-22T11:45:33Z",
        "osm_ways": [
          {
            "osm_way_id": 11566031,
            "street_from_frac": 0,
            "street_to_frac": 1,
            "way_from_frac": 0.18,
            "way_to_frac": 0.31,
            "same_direction": true
          }
        ],
        "mean_grade": null,
        "max_grade": null,
        "net_grade": null,
        "total_climb_meters": null,
        "total_descent_meters": null,
        "meters_over_5pct": null,
        "meters_over_8pct": null,
        "grade_confidence": "high",
        "grade_quality": "structure",
        "dem_source": "usgs-3dep-10m"
      }
    },
    ...
  ]
}
GeoJSON Field Descriptions

Each feature in the GeoJSON response represents a single street segment with LineString geometry and detailed properties:

Field Path Type Description
geometry.coordinates array[number] Array of coordinate pairs forming the street segment's path, in [longitude, latitude] format using WGS84 (EPSG:4326) coordinate system.
properties.street_edge_id integer Project Sidewalk's unique identifier for this street segment.
properties.osm_way_id integer OpenStreetMap Way ID for the street segment: the way covering most of it, when it spans several (see osm_ways).
properties.osm_ways array Every OpenStreetMap way the street lies on, in street order: a street can be built from several consecutive ways, and osm_way_id is the one covering most of it. Each entry has osm_way_id; street_from_frac and street_to_frac, the stretch of the street (0 at its first coordinate, 1 at its last) that way covers; way_from_frac and way_to_frac, the stretch of the way, in the way's own drawn direction; and same_direction, whether the street's coordinate order runs the way in its drawn direction (when false, the street's left side is the way's :right). The positions are null on a link recorded without them.
properties.region_id integer Identifier for the region where the street segment is located.
properties.region_name string Name of the region where the street segment is located, as defined in Project Sidewalk's regions.
properties.way_type string OpenStreetMap classification of the road type (e.g., residential, primary, secondary, service, footway).
properties.max_speed string Speed limit of the street, as the raw OpenStreetMap maxspeed tag (e.g., 25 mph, 30; a bare number means km/h per OSM convention). null when the way is untagged or the value is not yet cached.
properties.status string Availability of the street in Project Sidewalk. One of open (usable for auditing), no_imagery (no street-view imagery available), closed (in a region not yet opened to the public), or disabled (manually hidden, e.g. an OSM miscategorization). A street is auditable only when its status is open.
properties.user_ids array[string] Array of anonymized user identifiers (UUIDs) who have applied labels to this street segment.
properties.label_count integer Total number of accessibility labels applied to this street segment, excluding deleted and tutorial labels.
properties.audit_count integer Number of completed audits (virtual walk-throughs) of this street segment.
properties.outdated boolean Whether this street was audited before but every audit predates newer street-view imagery, so it needs re-auditing. Always false when audit_count is 0.
properties.user_count integer Number of unique users who have contributed labels to this street segment (derived from user_ids.length).
properties.first_label_date string Timestamp when the first accessibility label was applied to this street segment, in ISO 8601 format. May be null if no labels exist.
properties.last_label_date string Timestamp when the most recent accessibility label was applied to this street segment, in ISO 8601 format. May be null if no labels exist.
properties.mean_grade number The street's mean absolute running grade over every 10 m baseline, as a fraction (0.05 is a 5% grade). Like every grade field it comes from an elevation model, not from labels, so an unaudited street has it too; see Street grade. null where the street has not been sampled or has no usable profile (grade_quality says which).
properties.max_grade number The steepest absolute grade over any 30 m baseline (any 10 m baseline on a street shorter than 30 m), as a fraction. Never below mean_grade.
properties.net_grade number End-to-end grade as a fraction, signed in the direction of the street's geometry: negative where the street runs downhill from its first coordinate to its last. The one grade field a coarse (30 m) elevation model supports, so it can be set while the others are null.
properties.total_climb_meters number Summed rise along the street in the direction of its geometry, in meters.
properties.total_descent_meters number Summed fall along the street in the same direction, in meters.
properties.meters_over_5pct number Meters of the street steeper than 5% (1:20), the ADA / PROWAG running-slope limit for a walking surface.
properties.meters_over_8pct number Meters of the street steeper than 8.33% (1:12), the limit for a ramp; the field is named for the round figure. Never more than meters_over_5pct.
properties.grade_confidence string high for an elevation model at 10 m or finer, medium to 20 m, low beyond. null where the street has not been sampled.
properties.grade_quality string measured; structure (a bridge, tunnel, or covered way, which a bare-earth model cannot see, so every grade is null); suspect (the sampled profile was implausible, so the grades come from a straight line between the street's ends, or are null); or no_data (the model has nothing under the street). null where the street has not been sampled.
properties.dem_source string The elevation model the street was sampled from, which is what its credit is keyed on. null where the street has not been sampled.

CSV Format

If filetype=csv is specified, the response body will be CSV data. The first row contains the headers, corresponding to the fields in the GeoJSON properties object, plus geometry representation. CRS is WGS84 (EPSG:4326).

street_edge_id,osm_way_id,region_id,region_name,way_type,max_speed,status,user_ids,label_count,audit_count,outdated,user_count,first_label_date,last_label_date,osm_ways,start_point,end_point,mean_grade,max_grade,net_grade,total_climb_meters,total_descent_meters,meters_over_5pct,meters_over_8pct,grade_confidence,grade_quality,dem_source
951,11584845,8,Teaneck Community Charter School,residential,25 mph,open,"[""18b26a38-24ab-402d-a64e-158fc0bb8a8a"",""53ad4d79-9a7b-4d3c-a753-63bbfca34c9b""]",23,5,false,2,2023-06-20T14:32:45Z,2023-08-15T10:22:18Z,"[{""osm_way_id"":11584845,""street_from_frac"":0,""street_to_frac"":0.62,""way_from_frac"":0.4,""way_to_frac"":1,""same_direction"":true},{""osm_way_id"":11584846,""street_from_frac"":0.62,""street_to_frac"":1,""way_from_frac"":0.75,""way_to_frac"":1,""same_direction"":false}]","-74.0243606567383,40.8839912414551","-74.0245123456789,40.8836789012345",0.0412,0.0687,-0.0398,0.4,5.1,32.5,0.0,high,measured,usgs-3dep-10m
952,11566031,8,Teaneck Community Charter School,primary,,open,"[""8af92eb8-fb84-4aa6-9539-abc95216dcd7""]",8,1,false,1,2023-06-22T11:12:24Z,2023-06-22T11:45:33Z,"[{""osm_way_id"":11566031,""street_from_frac"":0,""street_to_frac"":1,""way_from_frac"":0.18,""way_to_frac"":0.31,""same_direction"":true}]","-74.0245835449219,40.8835416503906","-74.0246123456789,40.8833789012345",,,,,,,,high,structure,usgs-3dep-10m
...

Note: The complete LineString geometry is simplified to start and end points in the CSV format due to the tabular nature of CSV. For full geometry data, use the GeoJSON format.

The ten grade columns come after start_point and end_point, so a reader that goes by column position keeps the columns it already knew.

Shapefile Format

If filetype=shapefile is specified, the response body will be a ZIP archive containing the Shapefile components (.shp, .shx, .dbf, .prj, .cpg). Text longer than 254 bytes is truncated. That limit is why osmWays is not the JSON list but one way:from-to:mark entry per way, comma-separated: the way id, the stretch of the street it covers to three places, and :+ where the way runs the street's direction and :- where it runs the other way; a way with no position is its id alone. The attribute table (.dbf) contains fields corresponding to the GeoJSON properties object. Because the DBF format truncates column names at 10 characters, the grade fields use short names: meanGrade, maxGrade, netGrade, climbM, descentM, mOver5pct, mOver8pct, gradeConf, gradeQual and demSource, the same as the AccessScore: Streets shapefile's; the GeoJSON, CSV, and GeoPackage formats keep the full names. The included .prj file defines the Coordinate Reference System (CRS), typically WGS84 (EPSG:4326).

GeoPackage Format

If filetype=geopackage is specified, the response body will be a GeoPackage (.gpkg) file containing the street data with full geometry and the same field names as the GeoJSON properties. GeoPackage is a modern, open standard geospatial format that supports complex geometries and is widely supported by GIS software.

Error Responses

If an error occurs, the API will return an appropriate HTTP status code and a JSON response body containing details about the error.

  • 400 Bad Request: Invalid parameter values (e.g., malformed bounding box, invalid region ID).
  • 404 Not Found: The requested resource does not exist (e.g., incorrect base URL path).
  • 429 Too Many Requests: The same file is already being built for an earlier request; wait Retry-After seconds and try again. A HEAD request gets the same answer without building anything.
  • 500 Internal Server Error: An unexpected error occurred on the server.

Response Headers

  • X-File-Size: On a Shapefile, GeoPackage or zipped-CSV download, the file's size in bytes. Sent alongside Content-Length, and still present when the response is gzipped, which drops it — use it to show download progress.

Error Response Body

All errors are returned as RFC 7807 “problem details” with the application/problem+json content type and the following structure:

{
  "type": "about:blank",          // RFC 7807 problem-type URI ("about:blank" means no type beyond the status)
  "title": "Invalid Parameter",   // Short, human-readable summary of the problem type (stable for a given code)
  "status": 400,                  // HTTP status code (also repeated in the body)
  "detail": "Invalid value for the bbox parameter. Expected format: minLng,minLat,maxLng,maxLat.", // This occurrence
  "code": "INVALID_PARAMETER",    // Stable, machine-readable error code you can branch on
  "parameter": "bbox"             // Extension member: the specific parameter at fault (omitted when not applicable)
}

Best Practices

When working with the Streets API, consider these recommendations:

  • Filter by activity level: Use minLabelCount, minAuditCount, or minUserCount to focus on well-documented streets with higher data quality.
  • Consider way types: Use the wayType filter to focus on specific road classifications relevant to your analysis (e.g., only major roads or only pedestrian paths).
  • Choose the right format: Use geojson for web mapping applications, csv for basic data analysis, shapefile for traditional GIS software, and geopackage for modern GIS workflows.
  • Combine with other APIs: Use the Streets API alongside the Label Clusters API and Raw Labels API to get a complete picture of accessibility data for specific streets.

Contribute

Project Sidewalk is an open-source project created by the Makeability Lab and hosted on GitHub. We welcome your contributions! If you found a bug or have a feature request, please open an issue on GitHub.

You can also email us at sidewalk@cs.uw.edu

Project Sidewalk in Your City!

If you are interested in bringing Project Sidewalk to your city, please read our Wiki page.

On This Page