Skip to content
Contact us
  • There are no suggestions because the search field is empty.

Accessing Resident Demographic Data via the Shovels API

This article explains how to access resident data through the Shovels API, including the types of demographic information available and the process for retrieving it.

The Shovels API supports access to resident data, which includes demographic features such as gender, age range, and income range. This data is compiled from multiple sources and validated using consensus and observation methodologies.

Available Resident Data

  • Demographic Features: The API provides access to various demographic attributes, including:
    • Gender
    • Age range
    • Income range
  • Data Access Requirements: To access resident data, common linkages such as name, address, and workplace must be established.

API Endpoints for Resident Data

While the primary focus of the Shovels API documentation is on permits and contractors, resident demographic data is available through specialized endpoints. The resident data can be accessed via:

  • Specialized Data Endpoints: These endpoints are part of Shovels' extended data products, including the Universal Schema and Consumer Attributes dataset.

How to Access Resident Data

  1. API Subscription: To access resident demographic data, you need a Shovels API subscription.
  2. Documentation Review: For detailed information on the available resident data fields and schema, refer to the Data Dictionary.
  3. Data Extraction: You can extract resident data using the appropriate API endpoints as outlined in the documentation. This includes using specific parameters to retrieve the desired datasets.

Limitations

  • The API does not provide individual resident data through the basic permit and contractor endpoints. Instead, it focuses on properties and contractors, aligning with how permit data is collected and published by local jurisdictions.
  • Instead, use the geo_id to access the residents from our residents endpoint.

Conclusion

Accessing resident data through the Shovels API is possible with a subscription and by utilizing specialized endpoints. For comprehensive details on the data available and how to retrieve it, users should refer to the Universal Schema documentation. If you have specific use cases or need further assistance, consider reaching out for additional support.