Schema library real-estate

Return a rental-listing record from a public page.

Pass this JSON Schema and a public source URL to/extract/json. Return rent, location, terms, amenities, availability, and listing metadata present on the source.

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

Schema for residential rental property listings.

Field	Type	What it holds
`address`	string, required	Street address of the rental property.
`city`	string, required	City where the rental is located.
`state`	string, required	State or province of the rental.
`zip_code`	string, required	ZIP or postal code of the rental.
`latitude`	number	Geographic latitude coordinate.
`longitude`	number	Geographic longitude coordinate.
`rent_monthly`	number, required	Monthly rent amount.
`rent_currency`	string	ISO 4217 currency code for rent (e.g. USD).
`deposit_amount`	number	Security deposit amount.
`lease_term_months`	number	Lease duration in months.
`lease_type`	string	Type of lease agreement.
`available_date`	string	Date the rental is available for move-in.
`bedrooms`	number, required	Number of bedrooms.
`bathrooms`	number, required	Number of bathrooms.
`sqft`	number	Total interior square footage.
`unit_number`	string	Unit or apartment number.
`building_name`	string	Name of the apartment building or complex.
`pet_policy`	string	Pet policy for the rental.
`utilities_included`	array	List of utilities included in the rent.
`parking_included`	boolean	Whether parking is included with the rental.
`parking_fee`	number	Monthly parking fee if parking is not included.
`amenities`	array	List of amenities available with the rental.
`laundry_type`	string	Type of laundry facilities available.
`furnished`	boolean	Whether the unit is furnished.
`air_conditioning`	boolean	Whether the unit has air conditioning.
`description`	string	Full text description of the rental.
`images`	array	URLs of rental property images.
`contact_phone`	string	Contact phone number for the rental inquiry.
`contact_email`	string	Contact email address for the rental inquiry.
`listing_date`	string	Date the rental was listed.
`days_on_market`	number	Number of days the rental has been 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.

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.

rental.tsTypeScript

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

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

tabstack extract json 'https://example.com/pricing' \
  --schema @./rental-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.