Schema library gov-public-records
Return a building-permit record from a public page.
Pass this JSON Schema and a public source URL to/extract/json. Structure public permit identity, address, dates, status, and work description.
TEXT
MARKDOWN
LINKS
const res = await client.extract.json({
url: 'https://example.com/pricing',
json_schema: {
type: 'object',
properties: {
plan: { type: 'string' },
price: { type: 'number' },
},
},
})res = client.extract.json(
url='https://example.com/pricing',
json_schema={
'type': 'object',
'properties': {
'plan': {'type': 'string'},
'price': {'type': 'number'},
},
},
)tabstack extract json https://example.com/pricing \
--schema '{"type":"object","properties":{"plan":{"type":"string"},"price":{"type":"number"}}}'What it captures
Fields in this building-permit record.
Building or construction permit record from a municipal or county permitting authority.
| Field | Type | What it holds |
|---|---|---|
permit_number | string, required | Official permit number. |
permit_type | string, required | Type of permit. |
permit_status | string, required | Current status of the permit. |
address | string, required | Street address of the permitted property. |
city | string, required | City of the permitted property. |
county | string | County of the permitted property. |
state | string, required | State of the permitted property. |
zip_code | string | ZIP code of the permitted property. |
latitude | number | Latitude coordinate of the property. |
longitude | number | Longitude coordinate of the property. |
parcel_number | string | Assessor's parcel number (APN). |
project_description | string | Description of the construction project. |
estimated_valuation_usd | number | Estimated value of the construction work in USD. |
square_footage | number | Square footage of the construction area. |
contractor_name | string | Name of the licensed contractor. |
contractor_license_number | string | Contractor license number. |
owner_name | string | Name of the property owner. |
application_date | string | Date permit was applied for. |
issued_date | string | Date permit was issued. |
expiry_date | string | Date permit expires. |
final_date | string | Date permit was finaled. |
page_title | string | Title of the source page. Tabstack auto-fills this from page metadata when left empty. |
favicon | string | Favicon URL of the source page. Tabstack auto-fills this from page metadata when left empty. |
Example
Inspect and validate the response shape.
The example below is generated from the schema to demonstrate its structure. Edit the object or paste a real response to validate it in your browser.
What it checks
Pass or fail, and the first reason why.
Whether the text parses as JSON, whether the top level is an object, and whether each field the schema requires is present at the declared type. A null is allowed anywhere. Every key you ask for is present. A field the page does not state can come back null, empty, a placeholder number, or a guessed value. Validate values, not just keys.
Usage
Send the schema with your source URL.
The schema travels with the request rather than living on your account, so the same call can send a trimmed version for one page and the full one for another. Every key you ask for is present. A field the page does not state can come back null, empty, a placeholder number, or a guessed value. Validate values, not just keys.
import schema from './building-permit.json'
const res = await client.extract.json({
url: 'https://example.com/pricing',
json_schema: schema,
})tabstack extract json 'https://example.com/pricing' \
--schema @./building-permit.jsonAdaptation
Make the schema match your application.
The schema is a starting point, not a guarantee that every source page contains every field. Three things are worth doing before you write one into your system, and the schema-authoring guide covers the rest.
Remove what you do not need
A shorter schema is a smaller response and fewer fields to handle.
Describe the ambiguous ones
A description tells Extract what to look for when a label could mean two things.
Validate before you store
Check the returned object against the schema rather than trusting it.
Related
Related schemas
Other schemas in this category.
- Same category: business registration.
- Same category: court filing / case.
- Same category: government contract award.
- The job rather than the object: the Extract API.