Schema library real-estate
Return a short-term-rental record from a public page.
Pass this JSON Schema and a public source URL to/extract/json. Normalize public stay details, displayed price, availability context, and property attributes.
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 short-term-rental record.
Schema for short-term vacation rental listings (Airbnb, VRBO, etc.).
| Field | Type | What it holds |
|---|---|---|
listing_id | string | Platform-specific listing identifier. |
title | string, required | Title or name of the rental listing. |
platform | string, required | Platform hosting the listing (e.g., Airbnb, VRBO). |
host_name | string | Name of the property host. |
host_is_superhost | boolean | Whether the host has superhost or equivalent status. |
property_type | string, required | Type of space offered. |
city | string, required | City where the rental is located. |
state | string | State or region of the rental. |
country | string, required | Country where the rental is located. |
latitude | number | Geographic latitude coordinate. |
longitude | number | Geographic longitude coordinate. |
bedrooms | number, required | Number of bedrooms. |
bathrooms | number, required | Number of bathrooms. |
max_guests | number, required | Maximum number of guests allowed. |
nightly_rate | number, required | Base nightly rate in the listed currency. |
weekend_rate | number | Weekend nightly rate. |
cleaning_fee | number | One-time cleaning fee per booking. |
service_fee | number | Platform service fee per booking. |
minimum_nights | number | Minimum number of nights required per booking. |
maximum_nights | number | Maximum number of nights allowed per booking. |
review_count | number | Total number of guest reviews. |
review_rating | number | Average guest review rating. |
amenities | array | List of amenities available at the rental. |
cancellation_policy | string | Cancellation policy for the listing. |
images | array | URLs of listing images. |
description | string | Full text description of the rental. |
instant_book | boolean | Whether the listing supports instant booking. |
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 './short-term-rental.json'
const res = await client.extract.json({
url: 'https://example.com/pricing',
json_schema: schema,
})tabstack extract json 'https://example.com/pricing' \
--schema @./short-term-rental.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: commercial property.
- Same category: foreclosure & auction listing.
- Same category: property sold history.
- The job rather than the object: the Extract API.