Zyte Data business place schema v1.0#

Documentation Powered by Redocly

Standard Business Place Schema (1.0)

Standard Business Place Schema used in Zyte offering. Covers the typical set of attributes present in business place descriptions.

Standard Business Place Schema v1.0

Responses

Response Schema: application/json
placeId
string

Unique identifier of the place on the website. Unique across dataset.

url
string (URL)

The main URL that the place data was extracted from.

The URL of the final response, after any redirects.

Required attribute.

In case there is no product data on the page or the page was not reached, the returned "empty" item would still contain url field and metadata field with dateDownloaded.

name
string

The name of the place.

Array of objects[ items ]

The actions that can be performed directly from the URLs on the place page, including URLs.

Array
name
string

The name of the action.

url
string (URL)

The URL of the action.

object

The address details of the place.

addressRaw
string

The raw address information, as it appears on the website.

streetAddress
string

The street address of the place.

addressCity
string

The city the place is located in.

addressLocality
string

The locality to which the place belongs.

addressRegion
string

The region of the place.

addressCountry
string

The country the place is located in. The country name or the two-letter ISO 3166-1 alpha-2 country code. https://en.wikipedia.org/wiki/ISO_3166-1

postalCode
string

The postal code of the address.

postalCodeAux
string

The auxiliary part of the postal code. It may include a state abbreviation or town name, depending on local standards.

latitude
number [ -90 .. 90 ]

Geographical latitute of the place.

longitude
number [ -180 .. 180 ]

Geographical longitude of the place.

Array of objects (A generic name:value field) [ items ]

Any additional properties specific to the place.

Array
name
required
string
value
string
object

The details of the reservation action, e.g. table reservation in case of restaurants or room reservation in case of hotels.

name
string

The name of the reservation action.

url
string (URL)

The URL of the reservation action.

categories
Array of strings

The list of categories the place belongs to.

description
string

The description of the place.

Format:

  • trimmed (no whitespace at the beginning or the end of the description string),
  • line breaks included,
  • no length limit,
  • no normalization of Unicode characters.
features
Array of strings

Frequently mentioned features of this place.

map
string (URL)

A URL to a map of the place.

Array of objects (Image) [ items ]

A list of URL values of all images of the place.

Array
url
required
string (URL)

A URL of an image

Array of objects[ items ]

List of amenities of the place.

Array
name
string

Name of amenity.

value
boolean

Is the amenity available.

object

The overall rating, based on a collection of reviews or ratings.

reviewCount
integer

The total number of reviews.

bestRating
number

The highest value allowed in this rating system.

ratingValue
number

The rating for the content.

object

Official star rating of the place.

raw
string

Star rating of the place, as it appears on the page, without processing.

ratingValue
number

Star rating value of the place.

object

If the place is located inside another place, these are the details of the parent place.

name
string

Name of the parent place.

placeId
string

Identifier of the parent place.

Array of objects[ items ]

Ordered specification of opening hours, including data for opening and closing time for each day of the week.

Array
dayOfWeek
string
Enum: "Monday" "Tuesday" "Wednesday" "Thursday" "Friday" "Saturday" "Sunday"

English weekday name.

opens
string

Opening time in ISO 8601 format, local time.

closes
string

Closing time in ISO 8601 format, local time.

rawDayOfWeek
string

Day of the week, as it appears on the page, without processing.

rawOpens
string

Opening time, as it appears on the page, without processing.

rawCloses
string

Closing time, as it appears on the page, without processing.

Array of objects[ items ]

List of partner review sites.

Array
name
string

Name of the partner.

url
string (URL)

URL of the place on the partner site or URL of the partner site landing page.

telephone
string

The phone number associated with the place, as it appears on the page.

priceRange
string

How is the price range of the place viewed by its customers (from z to zzzz).

timezone
string

Which timezone is the place situated in. Standard: Name compliant with IANA tz database (tzdata).

isVerified
boolean

Information verified by the owner of this place.

website
string (URL)

The URL pointing to the official website of the place.

tags
Array of str[ items ]

List of the tags associated with the place.

object

Contains metadata about the data extraction process.

searchText
string

The search text the place was found with.

dateDownloaded
string

The timestamp at which the product data was downloaded. Timezone: UTC. Format: ISO 8601 format. YYYY-MM-DDThh:mm:ssZ

probability
number [ 0 .. 1 ]

The probability that the page belongs to certain data type.

Response samples

Content type
application/json
{}