Schema library real-estate

Return a property-sale record from a public page.

Pass this JSON Schema and a public source URL to/extract/json. Normalize public sale dates, amounts, property identity, and source context.

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 property-sale record.

Schema for historical property sale transaction records.

Field	Type	What it holds
`address`	string, required	Street address of the sold property.
`city`	string, required	City of the sold property.
`state`	string, required	State or province of the sold property.
`zip_code`	string, required	ZIP or postal code of the sold property.
`latitude`	number	Geographic latitude coordinate.
`longitude`	number	Geographic longitude coordinate.
`sale_price`	number, required	Final sale price of the property.
`sale_currency`	string	ISO 4217 currency code for the sale price.
`sale_date`	string, required	Date the property sale closed.
`property_type`	string	Type of property (e.g., single_family, condo).
`bedrooms`	number	Number of bedrooms.
`bathrooms`	number	Number of bathrooms.
`sqft`	number	Total interior square footage.
`price_per_sqft`	number	Sale price per square foot.
`prior_sale_price`	number	Price from the prior sale of this property.
`prior_sale_date`	string	Date of the prior sale.
`price_change_pct`	number	Percentage change in price from prior sale.
`days_on_market`	number	Number of days the property was on the market before sale.
`list_price`	number	Original listing price before sale.
`list_to_sale_ratio`	number	Ratio of sale price to list price.
`financing_type`	string	Type of financing used in the transaction.
`mls_id`	string	MLS identifier for the listing.
`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.

property.tsTypeScript

import schema from './property-sold-history.json'

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

tabstack extract json 'https://example.com/pricing' \
  --schema @./property-sold-history.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: rental listing.
The job rather than the object: the Extract API.