Schema library real-estate

Return a residential-listing record from a public page.

Pass this JSON Schema and a public source URL to/extract/json. Structure public residential property, price, location, feature, and listing fields.

Use this schema The JSON file

tabstack.ai/pricing

TEXT

MARKDOWN

LINKS

extract.tsTypeScript

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 residential-listing record.

Schema for residential real estate listings including homes, condos, and townhouses for sale.

Field	Type	What it holds
`address`	string, required	Street address of the property.
`city`	string, required	City where the property is located.
`state`	string, required	State or province where the property is located.
`zip_code`	string, required	ZIP or postal code of the property.
`country`	string	Country where the property is located.
`latitude`	number	Geographic latitude coordinate of the property.
`longitude`	number	Geographic longitude coordinate of the property.
`price`	number, required	Listing price of the property in the listed currency.
`price_currency`	string	ISO 4217 currency code for the listing price (e.g. USD).
`price_per_sqft`	number	Price per square foot of the property.
`status`	string, required	Current listing status of the property.
`bedrooms`	number, required	Number of bedrooms.
`bathrooms_full`	number, required	Number of full bathrooms.
`bathrooms_half`	number	Number of half bathrooms.
`sqft`	number	Total interior square footage of the property.
`lot_size_sqft`	number	Lot size in square feet.
`year_built`	number	Year the property was built.
`property_type`	string, required	Type of residential property.
`stories`	number	Number of stories or floors in the property.
`garage_spaces`	number	Number of garage parking spaces.
`hoa_fee_monthly`	number	Monthly HOA (Homeowners Association) fee amount.
`days_on_market`	number	Number of days the property has been listed on the market.
`listing_date`	string	Date the property was listed.
`description`	string	Full text description of the property.
`features`	array	List of property features and amenities.
`images`	array	URLs of property images.
`agent_name`	string	Name of the listing agent.
`agent_phone`	string	Phone number of the listing agent.
`brokerage`	string	Name of the brokerage firm representing the listing.
`mls_id`	string	MLS (Multiple Listing Service) identifier for this listing.
`open_house_dates`	array	Scheduled open house dates and times.
`tax_assessed_value`	number	Tax assessed value of the property.
`annual_tax`	number	Annual property tax amount.
`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.

Example data, not a live response.

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.

residential.tsTypeScript

import schema from './residential-listing.json'

const res = await client.extract.json({
  url: 'https://example.com/pricing',
  json_schema: schema,
})

tabstack extract json 'https://example.com/pricing' \
  --schema @./residential-listing.json

Adaptation

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 schemas

Other schemas in this category.

Same category: commercial property.
Same category: foreclosure & auction listing.
Same category: property sold history.
The job rather than the object: the Extract API.