Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.shovels.ai/llms.txt

Use this file to discover all available pages before exploring further.

Use the 2-letter state abbreviation as the geo_id to search for permits in a specific state.

​
State Abbreviation Format

Use standard 2-letter US state abbreviations:
  • California = CA
  • Texas = TX
  • Florida = FL
  • New York = NY

​
Example Request

curl -X GET \
  "https://api.shovels.ai/v2/permits/search?geo_id=CA&permit_from=2024-01-01&permit_to=2024-12-31&size=100" \
  -H "X-API-Key: YOUR_API_KEY_HERE"
State-level searches can return many results. Consider adding filters: 
# Add property type filter
?geo_id=CA&property_type=residential

# Add permit type filter
?geo_id=CA&tags=solar

# Combine with date range
?geo_id=CA&permit_from=2024-01-01&permit_to=2024-03-31
State-level searches may return large result sets. Use pagination and filters to manage the data effectively.

​
Geography Levels

The same geo_id parameter works at multiple levels:
LevelExample
Stategeo_id=CA
Zip Codegeo_id=94103
CityUse city-specific geo_id
AddressUse address-specific geo_id