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.

Streets API Preview #

Below is a live preview of street data from a sample region in Mexico City, Mexico 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.

Endpoint#

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

GET /v3/api/streets

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.

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",
                "user_ids": [
                    "18b26a38-24ab-402d-a64e-158fc0bb8a8a",
                    "53ad4d79-9a7b-4d3c-a753-63bbfca34c9b"
                ],
                "label_count": 23,
                "audit_count": 5,
                "user_count": 2,
                "first_label_date": "2023-06-20T14:32:45Z",
                "last_label_date": "2023-08-15T10:22:18Z"
            }
        },
        {
            "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",
                "user_ids": [
                    "8af92eb8-fb84-4aa6-9539-abc95216dcd7"
                ],
                "label_count": 8,
                "audit_count": 1,
                "user_count": 1,
                "first_label_date": "2023-06-22T11:12:24Z",
                "last_label_date": "2023-06-22T11:45:33Z"
            }
        },
        ...
    ]
}

GeoJSON Field Descriptions #

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

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,user_ids,label_count,audit_count,user_count,first_label_date,last_label_date,start_point,end_point
951,11584845,8,Teaneck Community Charter School,residential,"[18b26a38-24ab-402d-a64e-158fc0bb8a8a,53ad4d79-9a7b-4d3c-a753-63bbfca34c9b]",23,5,2,2023-06-20T14:32:45Z,2023-08-15T10:22:18Z,"-74.0243606567383,40.8839912414551","-74.0245123456789,40.8836789012345"
952,11566031,8,Teaneck Community Charter School,primary,[8af92eb8-fb84-4aa6-9539-abc95216dcd7],8,1,1,2023-06-22T11:12:24Z,2023-06-22T11:45:33Z,"-74.0245835449219,40.8835416503906","-74.0246123456789,40.8833789012345"
...

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.

Shapefile Format #

If filetype=shapefile is specified, the response body will be a ZIP archive containing the Shapefile components (.shp, .shx, .dbf, .prj). The attribute table (.dbf) contains fields corresponding to the GeoJSON properties object (field names may be truncated due to Shapefile limitations). 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 attributes. 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).
• 500 Internal Server Error: An unexpected error occurred on the server.

Error Response Body #

Error responses include a JSON body with the following structure:

{
    "status": 400, // HTTP Status Code repeated
    "code": "INVALID_PARAMETER", // Machine-readable error code
    "message": "Invalid value for bbox parameter. Expected format: minLng,minLat,maxLng,maxLat.", // Human-readable description
    "parameter": "bbox" // Optional: The specific parameter causing the error
}

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.