shovels_permits_search
Pack: shovels · Endpoint: https://gateway.pipeworx.io/shovels/mcp
Search 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” })
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
geo_id | string | yes | Location scope: a US state code (“CA”), a ZIP code (“94103”), or a Shovels geo_id from shovels_address_search. |
permit_from | string | yes | Return permits that started on or after this date (YYYY-MM-DD). |
permit_to | string | yes | Return permits that started on or before this date (YYYY-MM-DD). |
permit_tags | array | no | Filter by work-type tags (e.g. [“solar”,“roofing”]). Prefix a tag with ”-” to exclude it. |
items | string | no | |
permit_status | array | no | Filter by status: final, in_review, inactive, active. |
items | string | no | |
permit_q | string | no | Free-text search over permit descriptions (max 50 chars). |
property_type | string | no | Filter by property type: residential, commercial, industrial, etc. |
permit_min_job_value | number | no | Minimum permit job value, in CENTS (dollars × 100). |
contractor_name | string | no | Filter permits by contractor name (partial match, min 3 chars). |
size | number | no | Results per page (1-100, default 50). |
cursor | string | no | Pagination cursor from a previous response next_cursor. |
include_count | boolean | no | Include an approximate total_count on the first page (default false). |
_apiKey | string | yes | Shovels API key (X-API-Key). Sign up at ${SIGNUP_URL} |
Example call
curl -X POST https://gateway.pipeworx.io/shovels/mcp \
-H 'Content-Type: application/json' \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"shovels_permits_search","arguments":{}}}'Connect
Add this to your MCP client config, or use one-click install buttons:
{
"mcpServers": {
"shovels": {
"url": "https://gateway.pipeworx.io/shovels/mcp"
}
}
}See Getting Started for client-specific install steps.