DataForSEO · Schema
DataForSEO Business Data API Schemas
SEOSERPKeywordsBacklinksDomain AnalyticsOn-Page SEOCompetitor ResearchSearch EnginesContent AnalysisE-CommerceApp StoreBusiness DataAI OptimizationSocial Media
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "DataForSEO Business Data API Schemas",
"definitions": {
"BusinessDataGoogleQuestionsAndAnswersLiveResponseInfo": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BaseResponseInfo"
},
{
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/BusinessDataGoogleQuestionsAndAnswersLiveTaskInfo"
}
],
"nullable": true
},
"description": "array of tasks",
"nullable": true
}
}
}
]
},
"BaseResponseInfo": {
"properties": {
"version": {
"type": "string",
"description": "the current version of the API",
"nullable": true
},
"status_code": {
"type": "integer",
"description": "general status code\nyou can find the full list of the response codes here",
"nullable": true
},
"status_message": {
"type": "string",
"description": "general informational message\nyou can find the full list of general informational messages here",
"nullable": true
},
"time": {
"type": "string",
"description": "total execution time, seconds",
"nullable": true
},
"cost": {
"type": "number",
"description": "total tasks cost, USD",
"format": "double",
"nullable": true
},
"tasks_count": {
"type": "integer",
"description": "the number of tasks in the tasks array",
"format": "int64",
"nullable": true
},
"tasks_error": {
"type": "integer",
"description": "the number of tasks in the tasks array returned with an error",
"format": "int64",
"nullable": true
}
}
},
"BusinessDataGoogleQuestionsAndAnswersLiveTaskInfo": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": "object",
"description": "array of results",
"nullable": true
}
}
}
]
},
"BaseResponseTaskInfo": {
"properties": {
"id": {
"type": "string",
"description": "task identifier\nunique task identifier in our system in the UUID format",
"nullable": true
},
"status_code": {
"type": "integer",
"description": "status code of the task\ngenerated by DataForSEO, can be within the following range: 10000-60000\nyou can find the full list of the response codes here",
"nullable": true
},
"status_message": {
"type": "string",
"description": "informational message of the task\nyou can find the full list of general informational messages here",
"nullable": true
},
"time": {
"type": "string",
"description": "execution time, seconds",
"nullable": true
},
"cost": {
"type": "number",
"description": "total tasks cost, USD",
"format": "double",
"nullable": true
},
"result_count": {
"type": "integer",
"description": "number of elements in the result array",
"format": "int64",
"nullable": true
},
"path": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "URL path",
"nullable": true
},
"data": {
"type": "object",
"additionalProperties": {
"type": "object",
"nullable": true
},
"description": "contains the same parameters that you specified in the POST request",
"nullable": true
}
}
},
"BusinessDataTripadvisorLanguagesResponseInfo": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BaseResponseInfo"
},
{
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/BusinessDataTripadvisorLanguagesTaskInfo"
}
],
"nullable": true
},
"description": "array of tasks",
"nullable": true
}
}
}
]
},
"BusinessDataTripadvisorLanguagesTaskInfo": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/BusinessDataTripadvisorLanguagesResultInfo"
}
],
"nullable": true
},
"description": "array of results",
"nullable": true
}
}
}
]
},
"BusinessDataTripadvisorLanguagesResultInfo": {
"type": "object",
"properties": {
"language_name": {
"type": "string",
"description": "language name",
"nullable": true
},
"language_code": {
"type": "string",
"description": "language code according to ISO 639-1",
"nullable": true
}
}
},
"BusinessDataGoogleHotelInfoLiveAdvancedResponseInfo": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BaseResponseInfo"
},
{
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/BusinessDataGoogleHotelInfoLiveAdvancedTaskInfo"
}
],
"nullable": true
},
"description": "array of tasks",
"nullable": true
}
}
}
]
},
"BusinessDataGoogleHotelInfoLiveAdvancedTaskInfo": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/BusinessDataGoogleHotelInfoLiveAdvancedResultInfo"
}
],
"nullable": true
},
"description": "array of results",
"nullable": true
}
}
}
]
},
"BusinessDataGoogleHotelInfoLiveAdvancedResultInfo": {
"type": "object",
"properties": {
"hotel_identifier": {
"type": "string",
"description": "identifier received in a POST array\nthis field will contain the hotel_identifier parameter specified when setting a task;\nexample:\nCgoI-KWyzenM_MV3EAE",
"nullable": true
},
"location_code": {
"type": "integer",
"description": "location code in a POST array",
"nullable": true
},
"language_code": {
"type": "string",
"description": "language code in a POST array",
"nullable": true
},
"check_url": {
"type": "string",
"description": "direct URL to search engine results\nyou can use it to make sure that we provided accurate results",
"nullable": true
},
"datetime": {
"type": "string",
"description": "date and time when the result was received\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00",
"nullable": true
},
"title": {
"type": "string",
"description": "hotel title\nthe title of the hotel entity for which the results are collected",
"nullable": true
},
"stars": {
"type": "integer",
"description": "hotel class rating\nclass rating that ranges between 1-5 stars and displayed after review ratings in hotel summary",
"nullable": true
},
"stars_description": {
"type": "string",
"description": "hotel class rating\nclass rating that ranges between 1-5 stars and displayed after review ratings in the hotel summary",
"nullable": true
},
"address": {
"type": "string",
"description": "hotel address\nphysical address of the hotel",
"nullable": true
},
"phone": {
"type": "string",
"description": "hotel phone number\ncontact phone number of the hotel",
"nullable": true
},
"about": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/HotelAboutInfo"
}
],
"description": "information about the hotel",
"nullable": true
},
"location": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/HotelLocationInfo"
}
],
"description": "information about the hotel location\ninformation about the location where the hotel is located",
"nullable": true
},
"reviews": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/HotelReviewInfo"
}
],
"description": "hotel reviews by criteria\ninformation about reviews of the hotel entity",
"nullable": true
},
"overview_images": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "images displayed in the hotel overview\narray containing URLs to images displayed in the hotel overview",
"nullable": true
},
"prices": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/HotelPriceInfo"
}
],
"description": "pricing details of the hotel entity\ncontains information about the hotel\u2019s prices",
"nullable": true
}
}
},
"HotelLocationInfo": {
"type": "object",
"properties": {
"neighborhood": {
"type": "string",
"description": "name of the neighborhood where the hotel is located",
"nullable": true
},
"neighborhood_description": {
"type": "string",
"description": "description of the neighborhood where the hotel is located",
"nullable": true
},
"maps_url": {
"type": "string",
"description": "url to the location of the hotel in google maps",
"nullable": true
},
"overall_score": {
"type": "number",
"description": "overall score of the hotel location\nindicates the overall score of the hotel\u2019s location in the range from 1 to 5;\ncalculated based on data from the hotel\u2019s proximity to nearby things to do and restaurants, transportation, and airports;\nnote that the criteria are not weighted equally in the overall score",
"nullable": true
},
"score_by_categories": {
"type": "object",
"additionalProperties": {
"type": "number",
"format": "double",
"nullable": true
},
"description": "category scores of the hotel location\nthe scores of the hotel\u2019s location tied to the categories that indicate the proximity to nearby things to do, restaurants, transportation, and airports;",
"nullable": true
},
"latitude": {
"type": "number",
"description": "hotel latitude\nlatitude coordinates of the hotel\u2019s location\nexample:\n39.4806397",
"nullable": true
},
"longitude": {
"type": "number",
"description": "hotel longitude\nlatitude coordinates of the hotel\u2019s location\nexample:\n-106.0512973",
"nullable": true
},
"location_chain": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/LocationChain"
}
],
"nullable": true
},
"description": "elements of the location chain\nadditional parameters of each element of the location chain",
"nullable": true
}
}
},
"LocationChain": {
"type": "object",
"properties": {
"card_id": {
"type": "string",
"description": "card identifier",
"nullable": true
},
"feature_id": {
"type": "string",
"description": "feature identifier\nlearn more about the identifier in this help center article",
"nullable": true
},
"cid": {
"type": "string",
"description": "client id\nlearn more about the identifier in this help center article",
"nullable": true
},
"title": {
"type": "string",
"description": "title of the element in the location chain",
"nullable": true
}
}
},
"HotelReviewInfo": {
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "overall hotel rating based on customer votes",
"nullable": true
},
"votes_count": {
"type": "integer",
"description": "number of customer votes\nthe number of customer votes included in the calculation of the hotel rating",
"format": "int64",
"nullable": true
},
"mentions": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/ReviewMentionInfo"
}
],
"nullable": true
},
"description": "hotel mentions\ninformation about hotel reviews by criteria",
"nullable": true
},
"rating_distribution": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "Int64",
"nullable": true
},
"description": "rating distribution by votes\nthe distribution of votes across the rating in the range from 1 to 5",
"nullable": true
},
"other_sites_reviews": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/OtherSitesReviewsInfo"
}
],
"nullable": true
},
"description": "reviews on third-party sites\nreviews from third-paty sites",
"nullable": true
}
}
},
"ReviewMentionInfo": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "title of the evaluated criterion",
"nullable": true
},
"positive_score": {
"type": "number",
"description": "positive score by criterion",
"nullable": true
},
"positive_count": {
"type": "integer",
"description": "count of positive reviews by criterion",
"format": "int64",
"nullable": true
},
"negative_count": {
"type": "integer",
"description": "count of negative reviews by criterion",
"format": "int64",
"nullable": true
},
"total_count": {
"type": "integer",
"description": "count of all reviews by criterion",
"format": "int64",
"nullable": true
},
"visible_by_default": {
"type": "boolean",
"description": "element is visible by default\nindicates whether the review element is visible by default",
"nullable": true
}
}
},
"OtherSitesReviewsInfo": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "review title\ncontains a name of the third-party site where review initially appeared",
"nullable": true
},
"url": {
"type": "string",
"description": "review url\nURL to the a third-party site where review initially appeared",
"nullable": true
},
"review_text": {
"type": "string",
"description": "review text\ntext of the review",
"nullable": true
},
"rating": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/RatingInfo"
}
],
"description": "rating in the review\ninformation about the rating enclosed in the review on a third-party site",
"nullable": true
}
}
},
"RatingInfo": {
"properties": {
"rating_type": {
"type": "string",
"description": "the type of rating\nhere you can find the following elements: Max5, Percents, CustomMax",
"nullable": true
},
"value": {
"type": "number",
"description": "the value of the rating",
"format": "double",
"nullable": true
},
"votes_count": {
"type": "integer",
"description": "the amount of feedback",
"format": "int64",
"nullable": true
},
"rating_max": {
"type": "integer",
"description": "the maximum value for a rating_type",
"nullable": true
}
}
},
"HotelAboutInfo": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "description of the hotel\nthe description of the hotel entity for which the results are collected",
"nullable": true
},
"sub_descriptions": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "additional description of the hotel\ndetails about the hotel provided in addition to the description",
"nullable": true
},
"check_in_time": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/TimeInfo"
}
],
"description": "hotel check-in time\ncheck-in time indicated in the hotel listing",
"nullable": true
},
"check_out_time": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/TimeInfo"
}
],
"description": "hotel check-out time\ncheck-out time indicated in the hotel listing",
"nullable": true
},
"full_address": {
"type": "string",
"description": "full address of the hotel\naddress of the hotel indicated in the standardised format",
"nullable": true
},
"domain": {
"type": "string",
"description": "hotel domain\ndomain of the hotel\u2019s website",
"nullable": true
},
"url": {
"type": "string",
"description": "hotel url\nURL to the hotel\u2019s website indicated in the listing",
"nullable": true
},
"amenities": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/HotelAmenityInfo"
}
],
"nullable": true
},
"description": "hotel amenities\ninformation about hotel amenities",
"nullable": true
},
"popular_amenities": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/HotelAmenityItemInfo"
}
],
"nullable": true
},
"description": "hotel amenities\ninformation about hotel amenities labelled as \u201cpopular\u201d",
"nullable": true
}
}
},
"HotelAmenityInfo": {
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "standardised category of the ammenity",
"nullable": true
},
"category_label": {
"type": "string",
"description": "label of the category",
"nullable": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/HotelAmenityItemInfo"
}
],
"nullable": true
},
"description": "specific amenities and details",
"nullable": true
}
}
},
"HotelAmenityItemInfo": {
"type": "object",
"properties": {
"amenity": {
"type": "string",
"description": "standardised amenity name",
"nullable": true
},
"amenity_label": {
"type": "string",
"description": "displayed amenity name",
"nullable": true
},
"hint": {
"type": "string",
"description": "standardised details about the amenity",
"nullable": true
},
"hint_label": {
"type": "string",
"description": "displayed details about the amenity",
"nullable": true
},
"is_available": {
"type": "boolean",
"description": "indicates whether the amenity is available in the hotel",
"nullable": true
}
}
},
"TimeInfo": {
"type": "object",
"properties": {
"hour": {
"type": "integer",
"description": "hours in the 24-hour format",
"nullable": true
},
"minute": {
"type": "integer",
"description": "minutes",
"nullable": true
}
}
},
"HotelPriceInfo": {
"type": "object",
"properties": {
"price": {
"type": "number",
"description": "price per night",
"nullable": true
},
"price_without_discount": {
"type": "number",
"description": "full price per night without a discount applied",
"format": "int64",
"nullable": true
},
"currency": {
"type": "string",
"description": "price currency\nUSD is applied by default, unless specified in the POST array",
"nullable": true
},
"discount_text": {
"type": "string",
"description": "text about a discount applied",
"nullable": true
},
"check_in": {
"type": "string",
"description": "check-in date and time\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00",
"nullable": true
},
"check_out": {
"type": "string",
"description": "check-out date and time\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nexample:\n2019-11-15 12:57:46 +00:00",
"nullable": true
},
"visitors": {
"type": "integer",
"description": "number of hotel visitors for this price",
"nullable": true
},
"items": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/HotelPriceItemInfo"
}
],
"nullable": true
},
"description": "encountered item types\ntypes of search engine results encountered in the items array;\npossible item types: hotel_search_item",
"nullable": true
},
"prices_by_dates": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/PricesByDates"
}
],
"nullable": true
},
"nullable": true
}
}
},
"HotelPriceItemInfo": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "type of element",
"nullable": true
},
"title": {
"type": "string",
"description": "title of the hotel",
"nullable": true
},
"price": {
"type": "number",
"description": "price per night",
"nullable": true
},
"currency": {
"type": "string",
"description": "price currency\nUSD is applied by default, unless specified in the POST array",
"nullable": true
},
"url": {
"type": "string",
"description": "third-party page url\nURL to the third-party website page with pricing information",
"nullable": true
},
"domain": {
"type": "string",
"description": "third-party domain\ndomain of the third-party website page with pricing information",
"nullable": true
},
"is_paid": {
"type": "boolean",
"description": "indicates a paid hotel listing\nif true, related hotel_search_item is a paid ad\nif false, related hotel_search_item is an organic hotel listing",
"nullable": true
},
"free_cancellation_until": {
"type": "string",
"description": "date until which free cancellation is available\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nequals null if free cancellation is not available for the selected dates",
"nullable": true
},
"offers": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/HotelInfoPriceOffer"
}
],
"nullable": true
},
"description": "featured price offers",
"nullable": true
}
}
},
"HotelInfoPriceOffer": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "type of element",
"nullable": true
},
"title": {
"type": "string",
"description": "title of the hotel",
"nullable": true
},
"price": {
"type": "number",
"description": "price per night",
"nullable": true
},
"currency": {
"type": "string",
"description": "price currency\nUSD is applied by default, unless specified in the POST array",
"nullable": true
},
"url": {
"type": "string",
"description": "url of the price offer\nURL to the page of the website where price offer appears",
"nullable": true
},
"max_visitors": {
"type": "integer",
"description": "the maximal number of visitors\nthe maximum number of visitors for which the price offer is valid",
"nullable": true
},
"offer_images": {
"type": "array",
"items": {
"type": "string",
"nullable": true
},
"description": "price offer images\nURLs of the images featured in the price offer",
"nullable": true
},
"free_cancellation_until": {
"type": "string",
"description": "date until free cancellation is available\nin the UTC format: \u201cyyyy-mm-dd hh-mm-ss +00:00\u201d\nequals null if free cancellation is not available for the selected dates",
"nullable": true
}
},
"description": "featured price offers"
},
"PricesByDates": {
"type": "object",
"properties": {
"price": {
"type": "number",
"description": "price per night",
"nullable": true
},
"currency": {
"type": "string",
"description": "price currency\nUSD is applied by default, unless specified in the POST array",
"nullable": true
},
"check_in_date": {
"type": "string",
"nullable": true
},
"check_out_date": {
"type": "string",
"nullable": true
}
}
},
"BusinessDataTripadvisorSearchTaskPostResponseInfo": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BaseResponseInfo"
},
{
"type": "object",
"properties": {
"tasks": {
"type": "array",
"items": {
"type": "object",
"oneOf": [
{
"$ref": "#/components/schemas/BusinessDataTripadvisorSearchTaskPostTaskInfo"
}
],
"nullable": true
},
"description": "array of tasks",
"nullable": true
}
}
}
]
},
"BusinessDataTripadvisorSearchTaskPostTaskInfo": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": "object",
"description": "array of results\nin this case, the value will be null",
"nullable": true
}
}
}
]
},
"BusinessDataGoogleHotelInfoLiveHtmlRequestInfo": {
"type": "object",
"properties": {
"hotel_identifier": {
"type": "string",
"description": "unique hotel identifier\nrequired field\nunique identifier of a hotel entity in Google search;\nyou can obtain the value by making a request to Advanced Google SERP API (enclosed in the hotels element of the response), or the Hotel Searches endpoint of Business Data API\nexample:\nChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE"
},
"priority": {
"type": "integer",
"description": "task priority\noptional field\ncan take the following values:\n1 \u2013 normal execution priority (set by default)\n2 \u2013 high execution priority\nYou will be additionally charged for the tasks with high execution priority.\nThe cost can be calculated on the Pricing page.",
"nullable": true
},
"location_name": {
"type": "string",
"description": "full name of search engine location\nrequired field if you don\u2019t specify location_code or location_coordinate\nif you use this field, you don\u2019t need to specify location_code or location_coordinate\nyou can receive the list of available locations with location_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/locations\nexample:\nLondon,England,United Kingdom",
"nullable": true
},
"location_code": {
"type": "integer",
"descrip
# --- truncated at 32 KB (370 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dataforseo/refs/heads/main/json-schema/dataforseo-business-data-schema.json