Schema library real-estate

Return a foreclosure-auction record from a public page.

Pass this JSON Schema and a public source URL to/extract/json. Capture public auction, property, date, amount, and notice fields. Check the official source before acting on it.

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 foreclosure-auction record.

Schema for foreclosure and property auction listings.

Field	Type	What it holds
`address`	string, required	Street address of the foreclosure property.
`city`	string, required	City of the foreclosure property.
`state`	string, required	State of the foreclosure property.
`zip_code`	string, required	ZIP code of the foreclosure property.
`latitude`	number	Geographic latitude coordinate.
`longitude`	number	Geographic longitude coordinate.
`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.
`foreclosure_stage`	string, required	Current stage of the foreclosure process.
`auction_date`	string	Scheduled date of the auction.
`minimum_bid`	number	Minimum bid required at auction.
`opening_bid`	number	Opening bid for the auction.
`estimated_value`	number	Estimated market value of the property.
`lien_amount`	number	Total amount of the lien(s) on the property.
`property_condition`	string	Reported condition of the property.
`occupancy_status`	string	Whether the property is currently vacant or occupied.
`inspection_allowed`	boolean	Whether property inspection is allowed prior to auction.
`trustee_name`	string	Name of the trustee managing the foreclosure.
`lender_name`	string	Name of the lender initiating the foreclosure.
`case_number`	string	Legal case or file number for the foreclosure.
`default_amount`	number	Amount the borrower has defaulted on.
`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.

foreclosure.tsTypeScript

import schema from './foreclosure-auction-listing.json'

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

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