Raw Labels API #

The Raw Labels API provides access to individual geo-located labels placed by Project Sidewalk users. Each label represents a sidewalk feature or barrier that has been identified and categorized in street view imagery.

This endpoint returns raw, unclustered data. For most applications, we recommend using the Label Clusters API as it groups potentially duplicate labels of the same feature using a custom clustering algorithm. Use this Raw Labels API when you need access to every individual label record, including metadata about the user (anonymized) and validation status.

Raw Labels API Preview #

Below is a live preview of raw labels from a sample region in New Taipei, Taiwan retrieved directly from the API. Compare this map to the Label Clusters equivalent to see the difference between clustered labels vs. raw labels. Depending on the number of labels in the region, it may take a bit to load.

Note: In this example, we are visualizing Project Sidewalk data only in a single region; however, the Raw Labels API can return data from all regions in the city or just a selected region—see the API query parameters below.

Endpoint #

Retrieve a list of raw labels, optionally filtered by various criteria.

GET /v3/api/rawLabels

Quick Download #

Download raw labels data directly in your preferred format:

Note: This downloads all raw labels. For filtered data, use the API query parameters described below.

Query Parameters#

Filter the raw labels 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). 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 raw label. Coordinate Reference System (CRS) is WGS84 (EPSG:4326).

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [-74.0243606567383, 40.8839912414551]
      },
      "properties": {
        "label_id": 8,
        "user_id": "18b26a38-24ab-402d-a64e-158fc0bb8a8a",
        "pano_id": "DsCvWstZYz9JL81V9NloOQ",
        "pano_source": "gsv",
        "label_type": "CurbRamp",
        "severity": 1,
        "tags": [],
        "description": null,
        "time_created": 1692227245041,
        "high_quality_user": true,
        "street_edge_id": 951,
        "osm_way_id": 11584845,
        "region_id": 1,
        "region_name": "Teaneck Community Charter School",
        "correct": true,
        "agree_count": 2,
        "disagree_count": 0,
        "unsure_count": 0,
        "validations": [
          {
            "user_id": "056df9f9-a7de-46f1-ae52-02c069f5829f",
            "validation": "1"
          },
          {
            "user_id": "de691775-ac79-45f9-b265-e867702adc1d",
            "validation": "1"
          }
        ],
        "audit_task_id": 6,
        "mission_id": 3,
        "image_capture_date": "2012-08",
        "heading": 94.3114318847656,
        "pitch": -24.6774997711182,
        "zoom": 2,
        "canvas_x": 395,
        "canvas_y": 151,
        "canvas_width": 480,
        "canvas_height": 720,
        "pano_x": 1781,
        "pano_y": 3980,
        "pano_width": 13312,
        "pano_height": 6656,
        "camera_heading": 228.928619384766,
        "camera_pitch": -0.998329997062683,
        "camera_roll": 0.888324597068312,
        "pano_url": "https://www.google.com/maps/@?api=1&map_action=pano&pano=DsCvWstZYz9JL81V9NloOQ&heading=94.3114318847656&pitch=-24.6774997711182"
      }
    },
    {
      "type": "Feature",
      "geometry": {
        "type": "Point",
        "coordinates": [-74.0243835449219, 40.8839416503906]
      },
      "properties": {
        "label_id": 9,
        "user_id": "18b26a38-24ab-402d-a64e-158fc0bb8a8a",
        "pano_id": "DsCvWstZYz9JL81V9NloOQ",
        "pano_source": "gsv",
        "label_type": "Crosswalk",
        "severity": 1,
        "tags": [],
        "description": null,
        "time_created": 1692227248747,
        "street_edge_id": 95,
        "osm_way_id": 11566031,
        "region_id": 1,
        "region_name": "Teaneck Community Charter School",
        "correct": true,
        "agree_count": 2,
        "disagree_count": 1,
        "unsure_count": 0,
        "validations": [
          {
            "user_id": "2e602097-9e49-4217-ba24-816b2093e491",
            "validation": "1"
          },
          {
            "user_id": "8af92eb8-fb84-4aa6-9539-abc95216dcd7",
            "validation": "1"
          },
          {
            "user_id": "be481045-4448-42ae-bbac-3455ce914202",
            "validation": "2"
          }
        ],
        "audit_task_id": 6,
        "mission_id": 3,
        "image_capture_date": "2012-08",
        "heading": 140.740005493164,
        "pitch": -18.1596431732178,
        "zoom": 2,
        "canvas_x": 246,
        "canvas_y": 225,
        "canvas_width": 480,
        "canvas_height": 720,
        "pano_x": 3038,
        "pano_y": 3948,
        "pano_width": 13312,
        "pano_height": 6656,
        "camera_heading": 228.928619384766,
        "camera_pitch": -0.998329997062683,
        "camera_roll": 0.888324597068312,
        "pano_url": "https://www.google.com/maps/@?api=1&map_action=pano&pano=DsCvWstZYz9JL81V9NloOQ&heading=140.740005493164&pitch=-18.1596431732178"
      }
    },
    ...
  ]
}

GeoJSON Field Descriptions #

Each feature in the GeoJSON response represents a single raw label with point 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 latitude and longitude columns derived from the geometry. CRS is WGS84 (EPSG:4326).

label_id,user_id,pano_id,pano_source,label_type,severity,tags,description,...,disagree_count,unsure_count,latitude,longitude
115,18b26a38-...,YQScv...,gsv,CurbRamp,2,[missing tactile warning],,...,1,0,40.715,-74.005
116,...,...,gsv,Obstacle,4,[construction],"Temporary fence",...,3,0,40.7151,-74.0051
...

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 file (.gpkg). This is an open standard format based on SQLite that contains both geometry and attributes in a single file, generally without the field name limitations of Shapefiles. CRS is typically WGS84 (EPSG:4326).

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 date format).
• 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.
• 503 Service Unavailable: The server is temporarily unable to handle the request (e.g., during maintenance).

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)
}

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.