Schema library real-estate
Return a commercial-property record from a public page.
Pass this JSON Schema and a public source URL to/extract/json. Structure public commercial property details, pricing, location, and listing metadata.
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 commercial-property record.
Schema for commercial real estate property listings including office, retail, and industrial.
| Field | Type | What it holds |
|---|---|---|
address | string, required | Street address of the commercial property. |
city | string, required | City where the property is located. |
state | string, required | State or province of the property. |
zip_code | string, required | ZIP or postal code. |
latitude | number | Geographic latitude coordinate. |
longitude | number | Geographic longitude coordinate. |
price | number | Listing price or annual lease rate. |
price_type | string, required | Whether the property is listed for sale or lease. |
lease_type | string | Type of lease structure (Net, Gross, or Modified Gross). |
price_per_sqft | number | Price or rent per square foot. |
cap_rate | number | Capitalization rate as a percentage. |
noi | number | Net Operating Income (NOI) in dollars. |
building_class | string | Building class rating (A, B, or C). |
property_type | string, required | Type of commercial property. |
total_sqft | number | Total square footage of the building. |
available_sqft | number | Available square footage for lease. |
lot_size_sqft | number | Total lot size in square feet. |
year_built | number | Year the building was constructed. |
floors | number | Number of floors in the building. |
zoning | string | Zoning classification of the property. |
parking_ratio | number | Parking spaces per 1,000 square feet. |
loading_docks | number | Number of loading docks (industrial properties). |
clear_height_ft | number | Clear ceiling height in feet (industrial properties). |
occupancy_rate | number | Current building occupancy rate as a percentage. |
broker_name | string | Name of the listing broker or agent. |
broker_firm | string | Name of the brokerage firm. |
status | string | Current listing status. |
listing_date | string | Date the property was listed. |
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 './commercial-property.json'
const res = await client.extract.json({
url: 'https://example.com/pricing',
json_schema: schema,
})tabstack extract json 'https://example.com/pricing' \
--schema @./commercial-property.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: foreclosure & auction listing.
- Same category: property sold history.
- Same category: rental listing.
- The job rather than the object: the Extract API.