Shovels Permits Search
shovels_permits_searchSearch US building permits scoped to a location. Requires a geo_id (a US state code like "CA", a ZIP code, or a Shovels geo_id from shovels_address_search) plus a permit date range (permit_from / permit_to, YYYY-MM-DD). Monetary values (job_value, fees, market value) are returned in both cents and dollars. Example: shovels_permits_search({ geo_id: "CA", permit_from: "2024-01-01", permit_to: "2024-12-31", property_type: "residential", _apiKey: "your-key" })
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| size | No | Results per page (1-100, default 50). | |
| cursor | No | Pagination cursor from a previous response `next_cursor`. | |
| geo_id | Yes | Location scope: a US state code ("CA"), a ZIP code ("94103"), or a Shovels geo_id from shovels_address_search. | |
| _apiKey | Yes | Shovels API key (X-API-Key). Sign up at https://app.shovels.ai/create-account/ | |
| permit_q | No | Free-text search over permit descriptions (max 50 chars). | |
| permit_to | Yes | Return permits that started on or before this date (YYYY-MM-DD). | |
| permit_from | Yes | Return permits that started on or after this date (YYYY-MM-DD). | |
| permit_tags | No | Filter by work-type tags (e.g. ["solar","roofing"]). Prefix a tag with "-" to exclude it. | |
| include_count | No | Include an approximate total_count on the first page (default false). | |
| permit_status | No | Filter by status: final, in_review, inactive, active. | |
| property_type | No | Filter by property type: residential, commercial, industrial, etc. | |
| contractor_name | No | Filter permits by contractor name (partial match, min 3 chars). | |
| permit_min_job_value | No | Minimum permit job value, in CENTS (dollars × 100). |