Label Tags API #

The Label Tags API provides a comprehensive list of tags that can be applied to labels in Project Sidewalk. Each label type has its own set of tags, which can be used to provide additional information about the sidewalk barrier or feature.

Each city can also be customized with its own set of label tags, reflecting the unique needs and characteristics of the area.

Label Tags API Preview #

Below is a live preview of the label tags available in Mexico City, Mexico grouped by label type, retrieved directly from the API:

Loading label tags data...

Endpoint #

Retrieve a list of all label tags with their metadata.

GET /v3/api/labelTags

Examples#

/v3/api/labelTags Get all label tags available for Mexico City, Mexico (in JSON)

Quick Download #

Download label tags data directly in JSON:

Responses#

Success Response (200 OK)#

On success, the API returns an HTTP 200 OK status code and a JSON object containing an array of label tags.

{
    "status": "OK",
    "labelTags": [
        {
            "id": 1,
            "labelType": "CurbRamp",
            "tag": "narrow",
            "description": "TODO",
            "mutuallyExclusiveWith": []
        },
        {
            "id": 3,
            "labelType": "CurbRamp",
            "tag": "missing tactile warning",
            "description": "TODO",
            "mutuallyExclusiveWith": [
                "tactile warning"
            ]
        },
        // ... more label tags
    ]
}

Response Fields #

Field	Type	Description
`status`	`string`	Always "OK" for successful responses.
`labelTags`	`array`	Array of label tag objects.
`labelTags[].id`	`integer`	Unique identifier for the tag.
`labelTags[].labelType`	`string`	The label type this tag applies to (e.g., "CurbRamp", "Obstacle").
`labelTags[].tag`	`string`	Name of the tag (e.g., "narrow", "missing tactile warning").
`labelTags[].description`	`string`	Human-readable description of the tag.
`labelTags[].mutuallyExclusiveWith`	`array`	Array of tag names that cannot be applied simultaneously with this tag.

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.

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 #

Error responses include a JSON body with the following structure:

{
    "status": 500, // HTTP Status Code
    "code": "INTERNAL_SERVER_ERROR", // Machine-readable error code
    "message": "Failed to retrieve label tags: Database connection error" // Human-readable description
}

Terms of Use #

If you use Project Sidewalk data in your research, please cite the following paper (awarded 🏆 Best Paper at CHI 2019):

Manaswi Saha, Michael Saugstad, Hanuma Teja Maddali, Aileen Zeng, Ryan Holland, Steven Bower, Aditya Dash, Sage Chen, Anthony Li, Kotaro Hara, and Jon Froehlich. 2019. Project Sidewalk: A Web-based Crowdsourcing Tool for Collecting Sidewalk Accessibility Data At Scale. In Proceedings of the 2019 CHI Conference on Human Factors in Computing Systems (CHI '19). Association for Computing Machinery, New York, NY, USA, Paper 62, 1–14. https://doi.org/10.1145/3290605.3300292

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.