Contractors
Addresses
Counties
Jurisdictions
Zipcodes
States
curl --request GET \
--url https://api.shovels.ai/v2/contractors/{id}/permits \
--header 'X-API-Key: <api-key>'{
"items": [
{
"property_census_tract": "101",
"property_congressional_district": "1",
"property_type": "residential",
"property_type_detail": "single_family_home",
"property_legal_owner": "OAKLAND HOUSING AUTHORITY",
"property_owner_type": "individual",
"property_lot_size": 4000,
"property_building_area": 1000,
"property_story_count": 1,
"property_unit_count": 1,
"property_year_built": 1970,
"property_assess_market_value": 1050000,
"id": "caf3b9d5ce317d53",
"number": "RE2303928",
"description": "Battery backup",
"jurisdiction": "Berkeley",
"type": "Re) - electrical - 1 & 2 unit residential (building)",
"fees": 61960,
"status": "active",
"file_date": "2023-10-02",
"issue_date": "2023-10-11",
"final_date": "2023-12-11",
"start_date": "2022-10-19",
"end_date": "2023-12-11",
"total_duration": 230,
"construction_duration": 61,
"approval_duration": 9,
"contractor_id": "KOm4dMLIuT",
"tags": [
"solar",
"battery"
],
"address": {
"street_no": "3360",
"street": "DWIGHT WAY",
"city": "OAKLAND",
"zip_code": "94704",
"state": "CA",
"latlng": [
37.868443,
-122.24374
]
},
"geo_ids": {
"address_id": "asd8a8b19",
"city_id": "KLais31",
"county_id": "ALa2s33",
"jurisdiction_id": "BLa2s33"
}
},
{
"property_census_tract": "101",
"property_congressional_district": "1",
"property_type": "residential",
"property_type_detail": "single_family_home",
"property_legal_owner": "OAKLAND HOUSING AUTHORITY",
"property_owner_type": "individual",
"property_lot_size": 4000,
"property_building_area": 1000,
"property_story_count": 1,
"property_unit_count": 1,
"property_year_built": 1970,
"property_assess_market_value": 1050000,
"id": "71c02bd70f7ce1c9",
"number": "E2304692",
"description": "Install 27 kwh back-up batteries in cabinet ",
"jurisdiction": "Berkeley",
"type": "E) - electrical - 3+ residential units or commercial",
"fees": 61506,
"status": "in_review",
"file_date": "2023-11-29",
"start_date": "2022-11-29",
"end_date": "2023-11-29",
"total_duration": 0,
"construction_duration": 154,
"approval_duration": 204,
"tags": [
"solar"
],
"address": {
"street_no": "544",
"street": "DWIGHT PL",
"city": "OAKLAND",
"zip_code": "94704",
"state": "CA",
"latlng": [
37.8671,
-122.24461
]
},
"geo_ids": {
"address_id": "1sd8a8b19",
"city_id": "KLais31",
"county_id": "ALa2s33",
"jurisdiction_id": "BLa2s33"
}
},
{
"property_census_tract": "101",
"property_congressional_district": "1",
"property_type": "residential",
"property_type_detail": "single_family_home",
"property_legal_owner": "OAKLAND HOUSING AUTHORITY",
"property_owner_type": "individual",
"property_lot_size": 4000,
"property_building_area": 1000,
"property_story_count": 1,
"property_unit_count": 1,
"property_year_built": 1970,
"property_assess_market_value": 1050000,
"id": "9525a96a93e0cdb7",
"number": "B2303829",
"description": "Install 27 kwh back-up batteries in cabinet",
"jurisdiction": "Berkeley",
"job_value": 500100,
"type": "Building alteration: 3+ residential units or commercial",
"fees": 795300,
"status": "in_review",
"file_date": "2023-11-29",
"start_date": "2022-11-29",
"end_date": "2023-11-29",
"total_duration": 0,
"construction_duration": 154,
"approval_duration": 204,
"tags": [
"solar"
],
"address": {
"street_no": "544",
"street": "DWIGHT PL",
"city": "OAKLAND",
"zip_code": "94704",
"state": "CA",
"latlng": [
37.8671,
-122.24461
]
},
"geo_ids": {
"address_id": "1sd8a8b19",
"city_id": "KLais31",
"county_id": "ALa2s33",
"jurisdiction_id": "BLa2s33"
}
}
],
"size": 3
}Get Permits By Contractor Id
Retrieves all permits associated with a single contractor.
curl --request GET \
--url https://api.shovels.ai/v2/contractors/{id}/permits \
--header 'X-API-Key: <api-key>'{
"items": [
{
"property_census_tract": "101",
"property_congressional_district": "1",
"property_type": "residential",
"property_type_detail": "single_family_home",
"property_legal_owner": "OAKLAND HOUSING AUTHORITY",
"property_owner_type": "individual",
"property_lot_size": 4000,
"property_building_area": 1000,
"property_story_count": 1,
"property_unit_count": 1,
"property_year_built": 1970,
"property_assess_market_value": 1050000,
"id": "caf3b9d5ce317d53",
"number": "RE2303928",
"description": "Battery backup",
"jurisdiction": "Berkeley",
"type": "Re) - electrical - 1 & 2 unit residential (building)",
"fees": 61960,
"status": "active",
"file_date": "2023-10-02",
"issue_date": "2023-10-11",
"final_date": "2023-12-11",
"start_date": "2022-10-19",
"end_date": "2023-12-11",
"total_duration": 230,
"construction_duration": 61,
"approval_duration": 9,
"contractor_id": "KOm4dMLIuT",
"tags": [
"solar",
"battery"
],
"address": {
"street_no": "3360",
"street": "DWIGHT WAY",
"city": "OAKLAND",
"zip_code": "94704",
"state": "CA",
"latlng": [
37.868443,
-122.24374
]
},
"geo_ids": {
"address_id": "asd8a8b19",
"city_id": "KLais31",
"county_id": "ALa2s33",
"jurisdiction_id": "BLa2s33"
}
},
{
"property_census_tract": "101",
"property_congressional_district": "1",
"property_type": "residential",
"property_type_detail": "single_family_home",
"property_legal_owner": "OAKLAND HOUSING AUTHORITY",
"property_owner_type": "individual",
"property_lot_size": 4000,
"property_building_area": 1000,
"property_story_count": 1,
"property_unit_count": 1,
"property_year_built": 1970,
"property_assess_market_value": 1050000,
"id": "71c02bd70f7ce1c9",
"number": "E2304692",
"description": "Install 27 kwh back-up batteries in cabinet ",
"jurisdiction": "Berkeley",
"type": "E) - electrical - 3+ residential units or commercial",
"fees": 61506,
"status": "in_review",
"file_date": "2023-11-29",
"start_date": "2022-11-29",
"end_date": "2023-11-29",
"total_duration": 0,
"construction_duration": 154,
"approval_duration": 204,
"tags": [
"solar"
],
"address": {
"street_no": "544",
"street": "DWIGHT PL",
"city": "OAKLAND",
"zip_code": "94704",
"state": "CA",
"latlng": [
37.8671,
-122.24461
]
},
"geo_ids": {
"address_id": "1sd8a8b19",
"city_id": "KLais31",
"county_id": "ALa2s33",
"jurisdiction_id": "BLa2s33"
}
},
{
"property_census_tract": "101",
"property_congressional_district": "1",
"property_type": "residential",
"property_type_detail": "single_family_home",
"property_legal_owner": "OAKLAND HOUSING AUTHORITY",
"property_owner_type": "individual",
"property_lot_size": 4000,
"property_building_area": 1000,
"property_story_count": 1,
"property_unit_count": 1,
"property_year_built": 1970,
"property_assess_market_value": 1050000,
"id": "9525a96a93e0cdb7",
"number": "B2303829",
"description": "Install 27 kwh back-up batteries in cabinet",
"jurisdiction": "Berkeley",
"job_value": 500100,
"type": "Building alteration: 3+ residential units or commercial",
"fees": 795300,
"status": "in_review",
"file_date": "2023-11-29",
"start_date": "2022-11-29",
"end_date": "2023-11-29",
"total_duration": 0,
"construction_duration": 154,
"approval_duration": 204,
"tags": [
"solar"
],
"address": {
"street_no": "544",
"street": "DWIGHT PL",
"city": "OAKLAND",
"zip_code": "94704",
"state": "CA",
"latlng": [
37.8671,
-122.24461
]
},
"geo_ids": {
"address_id": "1sd8a8b19",
"city_id": "KLais31",
"county_id": "ALa2s33",
"jurisdiction_id": "BLa2s33"
}
}
],
"size": 3
}Authorizations
Path Parameters
Filter by the specified contractor ID.
Query Parameters
Cursor for pagination
1 <= x <= 100Response
A list of permits associated with the contractor and grouped by address
Schema for paginated permits details response.
The list of items returned in the response following given criteria.
Show child attributes
Show child attributes
The census tract identifier.
The congressional district identifier.
The type of property.
The detail type of property.
The legal owner of the property.
The type of property owner.
The lot size of the property.
The building area of the property.
The number of stories in the property.
The number of units in the property.
The year the property was built.
The assessed market value of the property.
The permit identifier.
The permit number provided by the jurisdiction.
The jurisdiction where permit was filled.
The address of the property.
Show child attributes
Show child attributes
The number of the street of the address.
The name of the street of the address.
The city of the address.
The county of the address.
The ZIP code of the address.
The extension of the ZIP code of the address.
The state of the address.
The jurisdiction the address belongs to.
The latitude and longitude of the property.
Geographic identifiers.
The description on the permit. This is a free-form text field that can contain any information about the permit.
The reported job value on the permit in cents (integer value representing dollars × 100).
The type of permit.
The subtype of permit.
The fees charged by the jurisdiction in cents (integer value representing dollars × 100).
The status of the permit.
The date the permit was filed.
The date the permit was issued.
The date the permit was finalized.
The earliest date out of file_date, issue_date and final_date that's found on the permit.
The latest date out of file_date, issue_date and final_date that's found on the permit.
The number of days it took from start_date to end_date.
The number of days it took to complete the project.
The number of days it took to approve the permit.
The inspection pass rate as a percentage (0-100)
The contractor identifier.
The tags associated with the permit.
The number of items returned in the response.
The cursor for retrieving the next page of results.
Was this page helpful?