Schema library travel

Return a restaurant-listing record from a public page.

Pass this JSON Schema and a public source URL to/extract/json. Structure public restaurant, location, cuisine, hours, rating, and reservation 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 restaurant-listing record.

Restaurant profile and details from a dining review platform or local business directory.

Field	Type	What it holds
`name`	string, required	Name of the restaurant.
`cuisine_type`	array	Types of cuisine served.
`price_range`	number	Price range indicator (e.g., 1-4 dollar signs).
`address`	string	Street address of the restaurant.
`city`	string, required	City of the restaurant.
`state`	string	State or region of the restaurant.
`country`	string, required	Country of the restaurant.
`latitude`	number	Latitude coordinate.
`longitude`	number	Longitude coordinate.
`phone`	string	Restaurant phone number.
`website`	string	Restaurant website URL.
`accepts_reservations`	boolean	Whether the restaurant accepts reservations.
`reservation_url`	string	URL for making reservations.
`outdoor_seating`	boolean	Whether outdoor seating is available.
`delivery_available`	boolean	Whether delivery is available.
`delivery_platforms`	array	Delivery platforms the restaurant is on.
`takeout_available`	boolean	Whether takeout is available.
`alcohol_license`	boolean	Whether the restaurant serves alcohol.
`michelin_stars`	number	Number of Michelin stars.
`review_rating`	number	Average review rating.
`review_count`	number	Total number of reviews.
`top_dishes`	array	Most popular or recommended dishes.
`menu_url`	string	URL to the restaurant's menu.
`photos`	array	URLs of restaurant photos.
`attributes`	array	Additional attributes or tags.
`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.

restaurant.tsTypeScript

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

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

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