Skip to main content
Field Name
Data Type
Description
Example
Source
idstringThe Shovels ID for the permit”caf3b9d5ce317d53”Shovels
numberstringThe permit jurisdiction’s internal tracking number”No-15837”Permit Jurisdiction
jurisdictionstringThe jurisdiction that issued the permit”City of Oakland”Permit Jurisdiction
addressobjectThe property’s addressShovels
geo_idsobjectGeographic identifiersShovels
descriptionstringThe description of the work from the permit”Solar panel installation”Permit Jurisdiction
job_valuenumberThe estimated value of the work to be done”25000”Permit Jurisdiction
issue_datestringThe date the permit was issued (YYYY-MM-DD)“2023-01-31”Permit Jurisdiction
file_datestringThe date the permit was filed (YYYY-MM-DD)“2023-01-01”Permit Jurisdiction
statusstringThe status of the permit”active”Shovels
typestringThe type of permit”Residential accessory structure”Permit Jurisdiction
sub_typestringThe sub-type of permit”garage”Permit Jurisdiction
tagsarrayA list of tags associated with the permit["Solar", "Residential"]Shovels
contractor_idstringThe unique ID of the contractor associated with the permitShovels
property_census_tractstringThe property’s census tract”06075000100”Shovels
property_congressional_districtstringThe property’s congressional district”11”Shovels
property_typestringThe property’s type”Residential”Shovels
property_type_detailstringThe property’s sub-classification”Single Family Home”Shovels
property_legal_ownerstringThe property’s legal owner”Robert Johnson”Shovels
property_owner_typestringThe property’s owner classification”individual”Shovels
property_lot_sizeintegerThe property’s lot size (in square feet)“5000”Shovels
property_building_areaintegerThe property’s building area (in square feet)“1250”Shovels
property_story_countintegerThe property’s number of stories”2”Shovels
property_unit_countintegerThe property’s number of units”1”Shovels
property_year_builtintegerThe property’s year built”1978”Shovels
property_assess_market_valuenumberThe property’s assessed market value”750000”Shovels
Field Name
Data Type
Description
Example
Source
idstringThe Shovels ID for the contractor”c452b7d5cf317a76”Shovels
namestringThe name of the contractor”John Builder”Permit Jurisdiction
company_namestringThe name of the contractor’s company”Builder Co”Permit Jurisdiction
typestringThe type of contractor”General Contractor”Shovels
license_numberstringThe contractor’s license number”123456”Permit Jurisdiction
license_statestringThe state that issued the contractor’s license”CA”Permit Jurisdiction
addressobjectThe contractor’s addressShovels
Field Name
Data Type
Description
Example
Source
namestringName of the resident”Jane Doe”Shovels
emailstringEmail of the resident”jane.doe@example.com”Shovels
phonestringPhone number of the resident”123-456-7890”Shovels
linkedin_urlstringLinkedIn URL of the resident”linkedin.com/in/janedoe”Shovels
net_worthstringNet worth range of the resident”1,000,000-2,499,999”Shovels
income_rangestringIncome range of the resident”150,000-199,999”Shovels
is_homeownerbooleanWhether the resident is a homeowner”true”Shovels
street_nostringStreet number of the resident’s address”123”Shovels
streetstringStreet name of the resident’s address”Main St”Shovels
citystringCity of the resident’s address”Anytown”Shovels
statestringState of the resident’s address”CA”Shovels
zip_codestringZip code of the resident’s address”12345”Shovels
zip_code_extstringZip code extension of the resident’s address”6789”Shovels
Field Name
Data Type
Description
Example
Source
totalintegerThe total number of permits.”100”Shovels
activeintegerThe number of permits that are currently active.”50”Shovels
in_reviewintegerThe number of permits that are under review.”10”Shovels
inactiveintegerThe number of permits that have been completed or expired.”30”Shovels
finalizedintegerThe number of permits that have been finalized.”10”Shovels
Field Name
Data Type
Description
Example
Source
statestringThe state of the property.”CA”Shovels
countystringThe county of the property.”Santa Clara County”Shovels
citystringThe city of the property.”San Jose”Shovels
zip_codestringThe ZIP code of the property.”95112”Shovels
⌘I