Schema library travel

Return a hotel-listing record from a public page.

Pass this JSON Schema and a public source URL to/extract/json. Normalize public property, room, amenity, location, price, and availability 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 hotel-listing record.

Hotel or lodging property listing with pricing, amenities, and availability from a booking platform.

Field	Type	What it holds
`property_name`	string, required	Name of the hotel or lodging property.
`chain_or_brand`	string	Hotel chain or brand affiliation.
`property_type`	string	Type of lodging property.
`star_rating`	number	Official star rating of the property.
`address`	string	Street address of the property.
`city`	string, required	City where the property is located.
`country`	string, required	Country where the property is located.
`latitude`	number	Latitude coordinate of the property.
`longitude`	number	Longitude coordinate of the property.
`amenities`	array	List of property amenities.
`room_types`	array	Available room types with pricing.
`cancellation_policy`	string	Cancellation policy description.
`check_in_time`	string	Standard check-in time.
`check_out_time`	string	Standard check-out time.
`pet_policy`	string	Pet policy description.
`parking_available`	boolean	Whether parking is available on-site.
`breakfast_included`	boolean	Whether breakfast is included in the rate.
`review_score`	number	Overall guest review score.
`review_count`	number	Total number of guest reviews.
`platform`	string, required	Booking platform where this listing was found.
`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.

hotel.tsTypeScript

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

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

tabstack extract json 'https://example.com/pricing' \
  --schema @./hotel-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: attraction & experience.
Same category: flight price snapshot.
Same category: restaurant listing.
The job rather than the object: the Extract API.