openapi: 3.0.1 info: title: DataForSEO AiOptimization BusinessData API description: DataForSEO API is the starting point on your journey towards building powerful SEO software. With DataForSEO you can get all the data you need to build an efficient application while also saving your time and budget. DataForSEO API is using the REST technology for interchanging data between your application and our service. The data exchange is made through the widely used HTTP protocol, which allows applying our API to almost all programming languages. version: 1.0.0 servers: - url: https://api.dataforseo.com - url: https://sandbox.dataforseo.com tags: - name: BusinessData paths: /v3/business_data/id_list: post: tags: - BusinessData description: 'This endpoint is designed to provide you with a list of IDs and metadata for all Business Data tasks created within the specified time period, including both successful and uncompleted tasks. for more info please visit ''https://docs.dataforseo.com/v3/business_data/id_list/?bash''' operationId: BusinessDataIdList requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataIdListRequestInfo' nullable: true example: - datetime_from: '2026-04-12 04:39:39 +00:00' datetime_to: '2026-04-14 04:39:39 +00:00' limit: 100 offset: 0 sort: desc include_metadata: true responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataIdListResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/errors: post: tags: - BusinessData description: 'By calling this endpoint you will receive information about the Business Data API tasks that returned an error within the past 7 days. for more info please visit ''https://docs.dataforseo.com/v3/business_data/errors/?bash''' operationId: BusinessDataErrors requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataErrorsRequestInfo' nullable: true example: - limit: 10 offset: 0 filtered_function: pingback_url responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataErrorsResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/business_listings/locations: get: tags: - BusinessData description: 'You will receive the list of locations by this API call. You can also download the full list of supported locations in the CSV format (last updated 2026-04-06). for more info please visit ''https://docs.dataforseo.com/v3/business_data/business_listings/locations/?bash''' operationId: BusinessListingsLocations responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataBusinessListingsLocationsResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/business_listings/categories: get: tags: - BusinessData description: 'This endpoint will provide you with the list of top categories by business count. for more info please visit ''https://docs.dataforseo.com/v3/business_data/business_listings/categories/?bash''' operationId: BusinessListingsCategories responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataBusinessListingsCategoriesResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/business_listings/available_filters: get: tags: - BusinessData description: 'Here you will find all the necessary information about filters that can be used with Business Listings API. for more info please visit ''https://docs.dataforseo.com/v3/business_data/business_listings/filters/?bash''' operationId: BusinessListingsAvailableFilters responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataBusinessListingsAvailableFiltersResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/business_listings/search/live: post: tags: - BusinessData description: 'Business Listings Search API provides results containing information about business entities listed on Google Maps in the specified categories. You will receive the address, contacts, rating, working hours, and other relevant data. The provided results are specific to the selected location (see the List of Locations) settings. for more info please visit ''https://docs.dataforseo.com/v3/business_data/business_listings/search/live/?bash''' operationId: BusinessListingsSearchLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataBusinessListingsSearchLiveRequestInfo' nullable: true example: - categories: - pizza_restaurant description: pizza title: pizza is_claimed: true location_coordinate: 53.476225,-2.243572,10 order_by: - rating.value,desc filters: - - rating.value - '>' - 3 limit: 3 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataBusinessListingsSearchLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/business_listings/categories_aggregation/live: post: tags: - BusinessData description: 'Business Listings Categories Aggregation endpoint provides results containing information about groups of related categories along with the number of entities in each category. The provided results are specific to the specified parameters. for more info please visit ''https://docs.dataforseo.com/v3/business_data/business_listings/categories_aggregation/live/?bash''' operationId: BusinessListingsCategoriesAggregationLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataBusinessListingsCategoriesAggregationLiveRequestInfo' nullable: true example: - categories: - pizza_restaurant description: pizza title: pizza is_claimed: true location_coordinate: 53.476225,-2.243572,10 initial_dataset_filters: - - rating.value - '>' - 3 limit: 3 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataBusinessListingsCategoriesAggregationLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/locations: get: tags: - BusinessData description: 'You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/locations/?bash''' operationId: BusinessDataGoogleLocations responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleLocationsResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/locations/{country}: get: tags: - BusinessData description: 'You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/locations/?bash''' operationId: BusinessDataGoogleLocationsCountry parameters: - name: country in: path description: 'country ISO code optional field specify the ISO code if you want to filter the list of locations by country example: us' required: true schema: type: string example: us responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleLocationsCountryResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/languages: get: tags: - BusinessData description: 'You will receive the list of languages by calling this API. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/languages/?bash''' operationId: BusinessDataGoogleLanguages responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleLanguagesResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/my_business_info/task_post: post: tags: - BusinessData description: 'Business Data API provides results containing information about specific business entity from Google. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/my_business_info/task_post/?bash''' operationId: GoogleMyBusinessInfoTaskPost requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoTaskPostRequestInfo' nullable: true example: - language_code: en location_name: New York,New York,United States keyword: RustyBrick, Inc. responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoTaskPostResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/my_business_info/tasks_ready: get: tags: - BusinessData description: 'The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/my_business_info/tasks_ready/?bash''' operationId: GoogleMyBusinessInfoTasksReady responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoTasksReadyResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/tasks_ready: get: tags: - BusinessData description: 'The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/my_business_info/tasks_ready/?bash''' operationId: BusinessDataTasksReady responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTasksReadyResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/my_business_info/task_get/{id}: get: tags: - BusinessData description: for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/my_business_info/task_get/?bash' operationId: GoogleMyBusinessInfoTaskGet parameters: - name: id in: path description: 'task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time' required: true schema: type: string example: 00000000-0000-0000-0000-000000000000 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoTaskGetResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/my_business_info/live: post: tags: - BusinessData description: 'Business Data API provides results containing information about specific business entity from Google. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/my_business_info/live/?bash''' operationId: GoogleMyBusinessInfoLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoLiveRequestInfo' nullable: true example: - language_code: en location_name: New York,New York,United States keyword: RustyBrick, Inc. responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/my_business_updates/task_post: post: tags: - BusinessData description: 'This endpoints provides the latest updates of a specific business entity from Google SERP. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/my_business_updates/task_post/?bash''' operationId: GoogleMyBusinessUpdatesTaskPost requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTaskPostRequestInfo' nullable: true example: - language_code: en location_name: New York,New York,United States keyword: RustyBrick, Inc. responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTaskPostResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/my_business_updates/tasks_ready: get: tags: - BusinessData description: 'The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/my_business_updates/tasks_ready/?bash''' operationId: GoogleMyBusinessUpdatesTasksReady responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTasksReadyResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/my_business_updates/task_get/{id}: get: tags: - BusinessData description: for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/my_business_updates/task_get/?bash' operationId: GoogleMyBusinessUpdatesTaskGet parameters: - name: id in: path description: 'task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time' required: true schema: type: string example: 00000000-0000-0000-0000-000000000000 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTaskGetResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/hotel_searches/task_post: post: tags: - BusinessData description: 'Hotel Searches API provides results containing information about different hotels listed on Google. The provided results are specific to the keyword, selected location (see the List of Locations) and language (see the List of Languages) settings. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/hotel_searches/task_post/?bash''' operationId: GoogleHotelSearchesTaskPost requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesTaskPostRequestInfo' nullable: true example: - language_code: en location_name: New York,New York,United States keyword: cheap hotel check_in: '2026-05-15' check_out: '2026-05-16' currency: USD adults: 2 children: - 14 sort_by: highest_rating priority: 2 tag: example responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesTaskPostResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/hotel_searches/tasks_ready: get: tags: - BusinessData description: 'The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/hotel_searches/tasks_ready/?bash''' operationId: GoogleHotelSearchesTasksReady responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesTasksReadyResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/hotel_searches/task_get/{id}: get: tags: - BusinessData description: for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/hotel_searches/task_get/?bash' operationId: GoogleHotelSearchesTaskGet parameters: - name: id in: path description: 'task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time' required: true schema: type: string example: 00000000-0000-0000-0000-000000000000 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesTaskGetResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/hotel_searches/live: post: tags: - BusinessData description: 'Hotel Searches API provides results containing information about different hotels listed on Google Hotels. The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/hotel_searches/live/?bash''' operationId: GoogleHotelSearchesLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesLiveRequestInfo' nullable: true example: - language_code: en location_name: New York,New York,United States keyword: cheap hotel check_in: '2026-05-15' check_out: '2026-05-16' currency: USD adults: 2 children: - 14 sort_by: highest_rating tag: example responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/hotel_info/task_post: post: tags: - BusinessData description: 'Google Hotel Info will provide you with structured data available for a specific hotel entity on the Google Hotels platform: such as service description, location details, rating, amenities, reviews, images, prices, and more. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/hotel_info/task_post/?bash''' operationId: GoogleHotelInfoTaskPost requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTaskPostRequestInfo' nullable: true example: - language_code: en location_name: New York,New York,United States hotel_identifier: ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE tag: some_string_123 postback_url: https://your-server.com/postbackscript.php postback_data: advanced responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTaskPostResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/hotel_info/tasks_ready: get: tags: - BusinessData description: 'The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/hotel_info/tasks_ready/?bash''' operationId: GoogleHotelInfoTasksReady responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTasksReadyResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/hotel_info/task_get/advanced/{id}: get: tags: - BusinessData description: for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/hotel_info/task_get/advanced/?bash' operationId: GoogleHotelInfoTaskGetAdvanced parameters: - name: id in: path description: 'task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time' required: true schema: type: string example: 00000000-0000-0000-0000-000000000000 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTaskGetAdvancedResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/hotel_info/task_get/html/{id}: get: tags: - BusinessData description: for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/hotel_info/task_get/html/?bash' operationId: GoogleHotelInfoTaskGetHtml parameters: - name: id in: path description: 'task identifier unique task identifier in our system in the UUID format you will be able to use it within 7 days to request the results of the task at any time' required: true schema: type: string example: 00000000-0000-0000-0000-000000000000 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTaskGetHtmlResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/hotel_info/live/advanced: post: tags: - BusinessData description: 'Google Hotel Info will provide you with structured data available for a specific hotel entity on the Google Hotels platform: such as service description, location details, rating, amenities, reviews, images, prices, and more. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/hotel_info/live/advanced/?bash''' operationId: GoogleHotelInfoLiveAdvanced requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoLiveAdvancedRequestInfo' nullable: true example: - language_code: en location_name: New York,New York,United States hotel_identifier: CgoI-KWyzenM_MV3EAE responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoLiveAdvancedResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/hotel_info/live/html: post: tags: - BusinessData description: 'Google Hotel Info will provide you with unstructured HTML data available for a specific hotel entity on the Google Hotels platform: such as service description, location details, rating, amenities, reviews, images, prices, and more. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/hotel_info/live/html/?bash''' operationId: GoogleHotelInfoLiveHtml requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoLiveHtmlRequestInfo' nullable: true example: - language_code: en location_name: New York,New York,United States hotel_identifier: ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoLiveHtmlResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/reviews/task_post: post: tags: - BusinessData description: 'This endpoint provides results from the “Reviews” element of Google SERPs. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) parameters. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/reviews/task_post/?bash''' operationId: GoogleReviewsTaskPost requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleReviewsTaskPostRequestInfo' nullable: true example: - location_name: London,England,United Kingdom language_name: English keyword: hedonism wines depth: 50 sort_by: highest_rating responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleReviewsTaskPostResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/reviews/tasks_ready: get: tags: - BusinessData description: 'The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/reviews/tasks_ready/?bash''' operationId: GoogleReviewsTasksReady responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleReviewsTasksReadyResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/reviews/task_get/{id}: get: tags: - BusinessData description: 'The returned results are specific to the indicated local establishment name, search engine, location and language parameters. We emulate set location and search engine with the highest accuracy so that the results you receive will match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus would not be reflected in the returned results. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/reviews/task_get/?bash''' operationId: GoogleReviewsTaskGet parameters: - name: id in: path description: 'task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time' required: true schema: type: string example: 00000000-0000-0000-0000-000000000000 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleReviewsTaskGetResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/extended_reviews/task_post: post: tags: - BusinessData description: 'This endpoint provides results from the “Reviews” element of Google SERPs, including not only Google user reviews but also reviews from other reputable sources (e.g., TripAdvisor, Yelp, Trustpilot). The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) parameters. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/extended_reviews/task_post/?bash''' operationId: GoogleExtendedReviewsTaskPost requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleExtendedReviewsTaskPostRequestInfo' nullable: true example: - location_name: London,England,United Kingdom language_name: english cid: '17626775537598922320' responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleExtendedReviewsTaskPostResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/extended_reviews/tasks_ready: get: tags: - BusinessData description: 'The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/extended_reviews/tasks_ready/?bash''' operationId: GoogleExtendedReviewsTasksReady responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleExtendedReviewsTasksReadyResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/extended_reviews/task_get/{id}: get: tags: - BusinessData description: 'The returned results are specific to the indicated local establishment name, search engine, location and language parameters. We emulate set location and search engine with the highest accuracy so that the results you receive will match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus would not be reflected in the returned results. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/extended_reviews/task_get/?bash''' operationId: GoogleExtendedReviewsTaskGet parameters: - name: id in: path description: 'task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time' required: true schema: type: string example: 00000000-0000-0000-0000-000000000000 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleExtendedReviewsTaskGetResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/questions_and_answers/task_post: post: tags: - BusinessData description: 'This endpoint will provide you with a detailed overview of questions and answers associated with a specific business entity listed on Google My Business. By submitting a request to this endpoint, you can access comprehensive data on the inquiries and responses related to a particular business, including the full text of the questions and answers, as well as metadata such as timestamps, user information.   The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.   Your account will be billed for every 20 questions, the maximum number of answers returned for each question is 5. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/questions_and_answers/task_post/?bash''' operationId: GoogleQuestionsAndAnswersTaskPost requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTaskPostRequestInfo' nullable: true example: - language_code: en location_name: Los Angeles,California,United States keyword: The Last Bookstore responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTaskPostResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/questions_and_answers/tasks_ready: get: tags: - BusinessData description: 'The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/questions_and_answers/tasks_ready/?bash''' operationId: GoogleQuestionsAndAnswersTasksReady responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTasksReadyResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/questions_and_answers/task_get/{id}: get: tags: - BusinessData description: for more info please visit 'https://docs.dataforseo.com/v3/business_data/google/questions_and_answers/task_get/?bash' operationId: GoogleQuestionsAndAnswersTaskGet parameters: - name: id in: path description: 'task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time' required: true schema: type: string example: 00000000-0000-0000-0000-000000000000 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTaskGetResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/google/questions_and_answers/live: post: tags: - BusinessData description: 'This endpoint will provide you with a detailed overview of questions and answers associated with a specific business entity listed on Google My Business. By submitting a request to this endpoint, you can access comprehensive data on the inquiries and responses related to a particular business, including the full text of the questions and answers, as well as metadata such as timestamps, user information.   The provided results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.   Your account will be billed for every 20 questions, the maximum number of answers returned for each question is 5. for more info please visit ''https://docs.dataforseo.com/v3/business_data/google/questions_and_answers/live/?bash''' operationId: GoogleQuestionsAndAnswersLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersLiveRequestInfo' nullable: true example: - language_code: en location_name: Los Angeles,California,United States keyword: The Last Bookstore responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/trustpilot/search/task_post: post: tags: - BusinessData description: 'This endpoint provides a list of business profiles listed on the Trustpilot platform. The returned results are relevant to the specified keyword. for more info please visit ''https://docs.dataforseo.com/v3/business_data/trustpilot/search/task_post/?bash''' operationId: TrustpilotSearchTaskPost requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTrustpilotSearchTaskPostRequestInfo' nullable: true example: - keyword: pizza restaurant depth: 20 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTrustpilotSearchTaskPostResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/trustpilot/search/tasks_ready: get: tags: - BusinessData description: 'The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. for more info please visit ''https://docs.dataforseo.com/v3/business_data/trustpilot/search/tasks_ready/?bash''' operationId: TrustpilotSearchTasksReady responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTrustpilotSearchTasksReadyResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/trustpilot/search/task_get/{id}: get: tags: - BusinessData description: 'This endpoint provides a list of business profiles listed on the Trustpilot platform. The returned results are relevant to the keyword specified in a POST request. We emulate set parameters with the highest accuracy so that the results you receive match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus will not be reflected in the returned results. for more info please visit ''https://docs.dataforseo.com/v3/business_data/trustpilot/search/task_get/?bash''' operationId: TrustpilotSearchTaskGet parameters: - name: id in: path description: 'task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time' required: true schema: type: string example: 00000000-0000-0000-0000-000000000000 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTrustpilotSearchTaskGetResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/trustpilot/reviews/task_post: post: tags: - BusinessData description: 'This endpoint provides reviews published on the Trustpilot platform for the local establishment specified in the domain field. for more info please visit ''https://docs.dataforseo.com/v3/business_data/trustpilot/reviews/task_post/?bash''' operationId: TrustpilotReviewsTaskPost requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTrustpilotReviewsTaskPostRequestInfo' nullable: true example: - domain: www.thepearlsource.com depth: 40 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTrustpilotReviewsTaskPostResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/trustpilot/reviews/tasks_ready: get: tags: - BusinessData description: 'The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. for more info please visit ''https://docs.dataforseo.com/v3/business_data/trustpilot/reviews/tasks_ready/?bash''' operationId: TrustpilotReviewsTasksReady responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTrustpilotReviewsTasksReadyResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/trustpilot/reviews/task_get/{id}: get: tags: - BusinessData description: 'This endpoint provides reviews published on the Trustpilot platform The returned results are specific to the indicated business entity. We emulate set parameters with the highest accuracy so that the results you receive will match the actual search results for the specified parameters at the time of task setting. You can always check the returned results accessing the check_url in the Incognito mode to make sure the received data is entirely relevant. Note that user preferences, search history, and other personalized search factors are ignored by our system and thus would not be reflected in the returned results. for more info please visit ''https://docs.dataforseo.com/v3/business_data/trustpilot/reviews/task_get/?bash''' operationId: TrustpilotReviewsTaskGet parameters: - name: id in: path description: 'task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time' required: true schema: type: string example: 00000000-0000-0000-0000-000000000000 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTrustpilotReviewsTaskGetResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/tripadvisor/locations: get: tags: - BusinessData description: 'You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task. Note that supported location types in Tripadvisor Business Data API are City and Region only. for more info please visit ''https://docs.dataforseo.com/v3/business_data/tripadvisor/locations/?bash''' operationId: TripadvisorLocations responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorLocationsResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/tripadvisor/locations/{country}: get: tags: - BusinessData description: 'You will receive the list of locations by this API call. You can filter the list of locations by country when setting a task. Note that supported location types in Tripadvisor Business Data API are City and Region only. for more info please visit ''https://docs.dataforseo.com/v3/business_data/tripadvisor/locations/?bash''' operationId: TripadvisorLocationsCountry parameters: - name: country in: path description: 'country ISO code optional field specify the ISO code if you want to filter the list of locations by country example: us' required: true schema: type: string example: us responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorLocationsCountryResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/tripadvisor/languages: get: tags: - BusinessData description: 'You will receive the list of languages by calling this API. for more info please visit ''https://docs.dataforseo.com/v3/business_data/tripadvisor/languages/?bash''' operationId: TripadvisorLanguages responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorLanguagesResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/tripadvisor/search/task_post: post: tags: - BusinessData description: 'This endpoint provides a list of business profiles listed on the Tripadvisor platform. The returned results are relevant to the specified keyword and the selected location (see the List of Locations). for more info please visit ''https://docs.dataforseo.com/v3/business_data/tripadvisor/search/task_post/?bash''' operationId: TripadvisorSearchTaskPost requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorSearchTaskPostRequestInfo' nullable: true example: - keyword: pizza location_code: 1003854 depth: 30 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorSearchTaskPostResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/tripadvisor/search/tasks_ready: get: tags: - BusinessData description: 'The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. for more info please visit ''https://docs.dataforseo.com/v3/business_data/tripadvisor/search/tasks_ready/?bash''' operationId: TripadvisorSearchTasksReady responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorSearchTasksReadyResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/tripadvisor/search/task_get/{id}: get: tags: - BusinessData description: 'This endpoint will provide you with data on businesses listed on the Tripadvisor platform. The results obtained through this endpoint are specific to the location (see the List of Tripadvisor Locations) and keyword parameters used in the POST request. for more info please visit ''https://docs.dataforseo.com/v3/business_data/tripadvisor/search/task_get/?bash''' operationId: TripadvisorSearchTaskGet parameters: - name: id in: path description: 'task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time' required: true schema: type: string example: 00000000-0000-0000-0000-000000000000 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorSearchTaskGetResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/tripadvisor/reviews/task_post: post: tags: - BusinessData description: 'This endpoint provides results from the “Reviews” element on the Tripadvisor platform. The results are specific to the URL path or keyword you indicate, and and the selected location (see the List of Locations). for more info please visit ''https://docs.dataforseo.com/v3/business_data/tripadvisor/reviews/task_post/?bash''' operationId: TripadvisorReviewsTaskPost requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorReviewsTaskPostRequestInfo' nullable: true example: - url_path: Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html location_code: 1003854 pingback_url: https://your-server.com/pingback.php?id=$id&tag=$tag tag: some_string_123 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorReviewsTaskPostResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/tripadvisor/reviews/tasks_ready: get: tags: - BusinessData description: 'The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you don’t use the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint. for more info please visit ''https://docs.dataforseo.com/v3/business_data/tripadvisor/reviews/tasks_ready/?bash''' operationId: TripadvisorReviewsTasksReady responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorReviewsTasksReadyResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/tripadvisor/reviews/task_get/{id}: get: tags: - BusinessData description: 'This endpoint provides feedback data on businesses listed on the Tripadvisor platform, including their locations, ratings, review content and count. The results are specific to the URL path indicated in the POST request. for more info please visit ''https://docs.dataforseo.com/v3/business_data/tripadvisor/reviews/task_get/?bash''' operationId: TripadvisorReviewsTaskGet parameters: - name: id in: path description: 'task identifier unique task identifier in our system in the UUID format you will be able to use it within 30 days to request the results of the task at any time' required: true schema: type: string example: 00000000-0000-0000-0000-000000000000 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorReviewsTaskGetResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/social_media/pinterest/live: post: tags: - BusinessData description: 'Social Media Pinterest API will provide you with data on pins made from the specified URLs. Pins on Pinterest correspond to content saves. For each specified page URL, you will get the number of content saves to Pinterest made using the Pinterest Save Button placed on that page. for more info please visit ''https://docs.dataforseo.com/v3/business_data/social_media/pinterest/live/?bash''' operationId: SocialMediaPinterestLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataSocialMediaPinterestLiveRequestInfo' nullable: true example: - targets: - https://www.simplyrecipes.com/recipes/grilled_salmon_with_cucumber_mango_salsa/ - https://tasty.co/recipe/classic-lasagna - https://www.allrecipes.com/recipe/255263/sicilian-roasted-chicken/ tag: some_string_123 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataSocialMediaPinterestLiveResponseInfo' nullable: true security: - basicAuth: [] /v3/business_data/social_media/reddit/live: post: tags: - BusinessData description: 'Social Media Reddit API provides information for each share of the target webpage on Reddit. For each specified Reddit URL, you will get subreddit and author names, permalink, title, and the number of subreddit members. for more info please visit ''https://docs.dataforseo.com/v3/business_data/social_media/reddit/live/?bash''' operationId: SocialMediaRedditLive requestBody: content: application/json: schema: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataSocialMediaRedditLiveRequestInfo' nullable: true example: - targets: - https://vk.com/ - https://ahrefs.com/ - https://google.com/ - https://twitter.com/ - https://reddit.com/ - https://facebook.com/ tag: some_string_123 responses: '200': description: Successful operation content: application/json: schema: type: object oneOf: - $ref: '#/components/schemas/BusinessDataSocialMediaRedditLiveResponseInfo' nullable: true security: - basicAuth: [] components: schemas: BusinessDataGoogleLocationsCountryResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleLocationsCountryTaskInfo' 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 BaseResponseTaskInfo: properties: id: type: string description: 'task identifier unique task identifier in our system in the UUID format' nullable: true status_code: type: integer description: 'status code of the task generated by DataForSEO, can be within the following range: 10000-60000 you can find the full list of the response codes here' nullable: true status_message: type: string description: 'informational message of the task you 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 BusinessDataTripadvisorReviewsTasksReadyResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorReviewsTasksReadyTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataGoogleMyBusinessInfoTasksReadyTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoTasksReadyResultInfo' nullable: true description: array of results nullable: true BusinessDataTripadvisorSearchTaskPostTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: object description: 'array of results in this case, the value will be null' nullable: true BusinessDataTripadvisorSearchTasksReadyTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorSearchTasksReadyResultInfo' nullable: true description: array of results nullable: true BusinessDataTripadvisorSearchTasksReadyResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorSearchTasksReadyTaskInfo' nullable: true description: array of tasks nullable: true 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 BusinessDataTripadvisorReviewsTaskPostResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorReviewsTaskPostTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataSocialMediaRedditLiveResultInfo: type: object properties: type: type: string description: type of element nullable: true page_url: type: string description: 'URL of the page the data is provided for corresponding URL you specified in the targets array when setting a task' nullable: true reddit_reviews: type: array items: type: object oneOf: - $ref: '#/components/schemas/RedditReviews' nullable: true description: reddit reviews for the page_url nullable: true GoogleBusinessPost: type: object properties: type: type: string description: type of element nullable: true rank_group: type: integer description: 'position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group' nullable: true rank_absolute: type: integer description: 'absolute rank among all the listed updates absolute position among all present elements' nullable: true position: type: string description: 'the alignment of the element in SERP can take the following values: right' nullable: true xpath: type: string description: the XPath of the element nullable: true author: type: string description: author of the post nullable: true snippet: type: string description: additional content of a post nullable: true post_text: type: string description: main content of a post nullable: true url: type: string description: url of a post nullable: true images_url: type: string description: url of an image included in the post nullable: true post_date: type: string description: 'date when a post was published in the following format: "mm/dd/yyyy hh:mm:ss"' nullable: true timestamp: type: string description: 'time when a post was published in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true links: type: array items: type: object oneOf: - $ref: '#/components/schemas/LinkElement' nullable: true description: links included in the post nullable: true BusinessDataTripadvisorReviewsTasksReadyTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorReviewsTasksReadyResultInfo' nullable: true description: array of results nullable: true BusinessDataGoogleHotelSearchesTaskPostTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: object description: 'array of results in this case, the value will be null' nullable: true PopularWorkTimeInfo: type: object properties: time: type: object oneOf: - $ref: '#/components/schemas/TimeInfo' description: hours in the 24-hour format nullable: true popular_index: type: integer description: 'popularity index relative time-bound popularity index measured from 0 to 100; higher value corresponds to a busier time of a day' nullable: true TripadvisorSearchOrganic: type: object properties: type: type: string description: type of element nullable: true rank_group: type: integer description: 'position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group' nullable: true rank_absolute: type: integer description: 'absolute rank among all the listed results absolute position among all reviews on the list' nullable: true title: type: string description: name of the business entity nullable: true url_path: type: string description: 'URL path of the business entity URL path to the Tripadvisor page of the business entity you can use this identifier to collect reviews for the business entity using Tripadvisor Reviews' nullable: true is_sponsored: type: boolean description: 'indicates a sponsored placement if true, related tripadvisor_search_organic item is a paid advertising on Tripadvisor' nullable: true reviews_count: type: integer description: the total number of reviews format: int64 nullable: true category: type: string description: place category nullable: true price_rate: type: string description: average price rate nullable: true rating: type: object oneOf: - $ref: '#/components/schemas/RatingInfo' description: the rating score of the establishment submitted by the reviewers nullable: true BusinessDataErrorsRequestInfo: type: object properties: limit: type: integer description: 'the maximum number of returned tasks that responded with an error optional field default value: 1000 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned tasks optional field default value: 0 if you specify the 10 value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks' nullable: true filtered_function: type: string description: 'return tasks with a certain function use this field to obtain a list of tasks that returned an error filtered by a certain function you can filter the results by the values you receive in the function fields of the API response i.e., once you receive unfiltered results, you can call this API again to filter them by function example: hotel_searches/task_post, postback_url, pingback_url' nullable: true datetime_from: type: string description: 'start time for filtering results optional field allows filtering results by the datetime parameter within the range of the last 7 days; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2021-11-15 12:57:46 +00:00' nullable: true datetime_to: type: string description: 'finish time for filtering results optional field allows filtering results by the datetime parameter within the range of the last 7 days; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2021-11-15 13:57:46 +00:00' nullable: true example: - limit: 10 offset: 0 filtered_function: pingback_url BusinessDataGoogleHotelInfoTaskGetAdvancedTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTaskGetAdvancedResultInfo' nullable: true description: array of results nullable: true ItemsGoogleBusinessInfo: type: object properties: type: type: string description: type of element nullable: true rank_group: type: integer description: 'position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group' nullable: true rank_absolute: type: integer description: absolute rank among all the elements nullable: true position: type: string description: the alignment in SERP nullable: true title: type: string description: 'title of the element in SERP the name of the business entity for which the results are collected' nullable: true original_title: type: string description: 'original title of the element original title not translated by Google' nullable: true description: type: string description: 'description of the element in SERP the description of the business entity for which the results are collected' nullable: true category: type: string description: 'business category Google My Business general category that best describes the services provided by the business entity' nullable: true category_ids: type: array items: type: string nullable: true description: 'global category IDs universal category IDs that do not change based on the selected country' nullable: true additional_categories: type: array items: type: string nullable: true description: 'additional business categories additional Google My Business categories that describe the services provided by the business entity in more detail' nullable: true cid: type: string description: 'google-defined client id unique id of a local establishment; can be used with Google Reviews API to get a full list of reviews learn more about the identifier in this help center article' nullable: true feature_id: type: string description: 'the unique identifier of the element in SERP learn more about the identifier in this help center article' nullable: true address: type: string description: address of the business entity nullable: true address_info: type: object oneOf: - $ref: '#/components/schemas/AddressInfo' description: object containing address components of the business entity nullable: true place_id: type: string description: 'unique place identifier place id of the local establishment featured in the element learn more about the identifier in this help center article' nullable: true phone: type: string description: phone number of the business entity nullable: true url: type: string description: absolute url of the business entity nullable: true contact_url: type: string description: URL of the preferred contact page nullable: true contributor_url: type: string description: URL of the user’s or entity’s Local Guides profile, if available nullable: true book_online_url: type: string description: 'URL in the ‘book online’ button of the element URL directing users to the online booking or order page of the business entity' nullable: true domain: type: string description: domain of the business entity nullable: true logo: type: string description: URL of the logo featured in Google My Business profile nullable: true main_image: type: string description: URL of the main image featured in Google My Business profile nullable: true total_photos: type: integer description: total count of images featured in Google My Business profile format: int64 nullable: true snippet: type: string description: additional information on the business entity nullable: true latitude: type: number description: 'latitude coordinate of the local establishments in google maps example: "latitude": 51.584091' nullable: true longitude: type: number description: 'longitude coordinate of the local establishment in google maps example: "longitude": -0.31365919999999997' nullable: true is_claimed: type: boolean description: shows whether the entity is verified by its owner on Google Maps nullable: true attributes: type: object oneOf: - $ref: '#/components/schemas/BusinessDataAttributesInfo' description: 'service details in a form of user-reviewed checks; service details of a business entity displayed in a form of checks and based on user feedback and business category' nullable: true place_topics: type: object additionalProperties: type: integer format: int64 nullable: true description: "keywords mentioned in customer reviews\ncontains most popular keywords related to products/services mentioned in customer reviews of a business entity and the number of reviews mentioning each keyword\nexample: \n\"place_topics\": {\n\"egg roll\": 48,\n\"birthday\": 33\n}" nullable: true rating: type: object oneOf: - $ref: '#/components/schemas/RatingInfo' description: "the element’s rating \nthe popularity rate based on reviews and displayed in SERP" nullable: true hotel_rating: type: string description: 'hotel class rating class ratings range between 1-5 stars, learn more if there is no hotel class rating information, the value will be null' nullable: true price_level: type: string description: 'property price level can take values: inexpensive, moderate, expensive, very_expensive if there is no price level information, the value will be null' nullable: true rating_distribution: type: object additionalProperties: type: integer format: Int64 nullable: true description: 'the distribution of ratings of the business entity the object displays the number of 1-star to 5-star ratings, as reviewed by users' nullable: true people_also_search: type: array items: type: object oneOf: - $ref: '#/components/schemas/PeopleAlsoSearch' nullable: true description: related business entities nullable: true work_time: type: object oneOf: - $ref: '#/components/schemas/BusinessWorkHoursInfo' description: 'work time details information related to operational hours of the business entity' nullable: true popular_times: type: object description: 'popular times information related to busy hours of the business entity' nullable: true local_business_links: type: object description: 'available interactions with the business list of options to interact with the business directly from search results' nullable: true is_directory_item: type: boolean description: 'business establishment is a part of the directory indicates whether the business establishment is a part of the directory; if true, the item is a part of the larger directory of businesses with the same address (e.g., a mall or a business centre); note: if the business establishment is a parent item in the directory, the value will be null' nullable: true directory: type: object description: 'items of the directory includes information about businesses that are located within the target business establishment and have the same address' nullable: true BusinessDataGoogleExtendedReviewsTaskPostTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: object description: 'array of results in this case, the value will be null' nullable: true BusinessDataGoogleHotelSearchesLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesLiveResultInfo' nullable: true description: array of results nullable: true BusinessDataBusinessListingsSearchLiveItem: type: object properties: type: type: string description: type of element nullable: true title: type: string description: 'title of the element in SERP the name of the business entity for which the results are collected' nullable: true original_title: type: string description: 'original title of the element original title not translated by Google' nullable: true description: type: string description: 'description of the element in SERP the description of the business entity for which the results are collected' nullable: true category: type: string description: 'business category Google My Business general category that best describes the services provided by the business entity' nullable: true category_ids: type: array items: type: string nullable: true description: 'global category IDs universal category IDs that do not change based on the selected country' nullable: true additional_categories: type: array items: type: string nullable: true description: 'additional business categories additional Google My Business categories that describe the services provided by the business entity in more detail' nullable: true cid: type: string description: 'google-defined client id unique id of a local establishment learn more about the identifier in this help center article' nullable: true feature_id: type: string description: 'the unique identifier of the element in SERP learn more about the identifier in this help center article' nullable: true address: type: string description: address of the business entity nullable: true address_info: type: object oneOf: - $ref: '#/components/schemas/AddressInfo' description: object containing address components of the business entity nullable: true place_id: type: string description: 'unique place identifier place id of the local establishment featured in the element learn more about the identifier in this help center article' nullable: true phone: type: string description: phone number of the business entity nullable: true url: type: string description: absolute url of the business entity nullable: true domain: type: string description: domain of the business entity nullable: true logo: type: string description: URL of the logo featured in Google My Business profile nullable: true main_image: type: string description: URL of the main image featured in Google My Business profile nullable: true total_photos: type: integer description: total count of images featured in Google My Business profile format: int64 nullable: true snippet: type: string description: additional information on the business entity nullable: true latitude: type: number description: 'latitude coordinate of the local establishments in google maps example: "latitude": 51.584091' nullable: true longitude: type: number description: 'longitude coordinate of the local establishment in google maps example: "longitude": -0.31365919999999997' nullable: true is_claimed: type: boolean description: shows whether the entity is verified by its owner on Google Maps nullable: true attributes: type: object oneOf: - $ref: '#/components/schemas/BusinessDataAttributesInfo' description: 'service details in a form of user-reviewed checks; service details of a business entity displayed in a form of checks and based on user feedback and business category' nullable: true place_topics: type: object additionalProperties: type: integer format: int64 nullable: true description: "keywords mentioned in customer reviews\ncontains most popular keywords related to products/services mentioned in customer reviews of a business entity and the number of reviews mentioning each keyword\nexample: \n\"place_topics\": {\n\"egg roll\": 48,\n\"birthday\": 33\n}" nullable: true rating: type: object oneOf: - $ref: '#/components/schemas/RatingInfo' properties: rating_type: type: string description: 'the type of rating here 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: number description: the maximum value for a rating_type format: double nullable: true description: "the element’s rating \nthe popularity rate based on reviews and displayed in SERP" nullable: true hotel_rating: type: integer description: 'hotel class rating class ratings range between 1-5 stars, learn more if there is no hotel class rating information, the value will be null' nullable: true price_level: type: string description: 'property price level can take values: inexpensive, moderate, expensive, very_expensive if there is no price level information, the value will be null' nullable: true rating_distribution: type: object additionalProperties: type: integer format: Int64 nullable: true description: 'the distribution of ratings of the business entity the object displays the number of 1-star to 5-star ratings, as reviewed by users' nullable: true people_also_search: type: array items: type: object oneOf: - $ref: '#/components/schemas/PeopleAlsoSearch' nullable: true description: related business entities nullable: true work_time: type: object oneOf: - $ref: '#/components/schemas/BusinessWorkHoursInfo' description: 'work time details information related to operational hours of the business entity' nullable: true popular_times: type: object oneOf: - $ref: '#/components/schemas/PopularTimes' description: 'popular times information related to busy hours of the business entity' nullable: true local_business_links: type: array items: type: object oneOf: - $ref: '#/components/schemas/BaseLocalBusinessLink' nullable: true description: 'available interactions with the business list of options to interact with the business directly from search results' nullable: true contact_info: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataContactInfo' nullable: true description: 'available contacts of the business list of contacts to interact with the business' nullable: true check_url: type: string description: 'direct URL to search engine results you can use it to make sure that we provided accurate results' nullable: true last_updated_time: type: string description: 'date and time when the data was last updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-26 09:03:15 +00:00' nullable: true first_seen: type: string description: 'date and time when our crawler found the business listing element for the first time in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-03-11 10:04:11 +00:00' nullable: true TrustpilotSearchOrganic: type: object properties: type: type: string description: type of element nullable: true rank_group: type: integer description: 'position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group' nullable: true rank_absolute: type: integer description: 'absolute rank among all the listed reviews absolute position among all reviews on the list' nullable: true title: type: string description: title of the establishment nullable: true domain: type: string description: domain of the establishment nullable: true url: type: string description: URL to the establishment nullable: true reviews_count: type: integer description: the total number of reviews format: int64 nullable: true rating: type: object oneOf: - $ref: '#/components/schemas/RatingInfo' description: the rating score of the establishment submitted by reviewers nullable: true BusinessDataGoogleHotelInfoLiveAdvancedRequestInfo: type: object properties: hotel_identifier: type: string description: 'unique hotel identifier required field unique identifier of a hotel entity in Google search; you 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 example: ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE' location_name: type: string description: 'full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you 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 example: London,England,United Kingdom' nullable: true location_code: type: integer description: 'search engine location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations example: 2840' nullable: true location_coordinate: type: string description: 'GPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter should be specified in the “latitude, longitude” format the maximum number of decimal digits for “latitude” and “longitude”: 7 Note: if the coordinates are used to set a location, the search will occur in the nearest settlement; example: 53.476225,-2.243572' nullable: true language_name: type: string description: 'full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages example: English' nullable: true language_code: type: string description: 'search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages example: en' nullable: true check_in: type: string description: 'check-in date optional field if you don’t specify this field, tomorrow’s date will be used by default; the value must not be earlier than today’s date date format: "yyyy-mm-dd" example: "2019-01-15"' nullable: true check_out: type: string description: 'check-out date optional field if you don’t specify this field, our system will apply the date of two days from now by default; Note: the value cannot be less than or equal to check_in; the range between check_in and check_out values cannot exceed 30 days date format: "yyyy-mm-dd" example: "2019-01-15"' nullable: true currency: type: string description: 'currency optional field example: "USD"' nullable: true adults: type: integer description: 'number of adults optional field if you don’t specify this field, two adults will be used by default example: 1' nullable: true children: type: array items: type: string description: 'number and age of children optional field if you don’t specify this field, no children will be included in the search; set the following value if you want to include one 14-years-old child: [14] set the following value if you want to include one 13-years-old child and one 8-years-old child: [13,8]' nullable: true load_prices_by_dates: type: boolean description: 'load hotel stay prices by dates optional field if you specify this parameter with true, the response will include the prices_by_dates array with hotel stay prices divided by dates if you use this parameter, you will be charged double the base price for a request' nullable: true prices_start_date: type: string description: 'start date to load prices by dates optional field to use this parameter, you must specify load_prices_by_dates with true if this parameter is not specified, the start date is set to check_in date date format: yyyy-mm-dd example: 2025-05-20' nullable: true prices_end_date: type: string description: 'end date to load prices by dates optional field to use this parameter, you must specify load_prices_by_dates with true if this parameter is not specified, you will get prices by date for the month date format: yyyy-mm-dd example: 2025-05-21' nullable: true prices_date_range: type: string description: 'predefined period for retrieving daily price data optional field to use this parameter, you must specify load_prices_by_dates with true if the prices_start_date is not specified, the start date is set to check_in date possible values: month, three_months, six_months, year default value: month' nullable: true tag: type: string description: 'user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response' nullable: true example: - language_code: en location_name: New York,New York,United States hotel_identifier: CgoI-KWyzenM_MV3EAE BusinessDataGoogleMyBusinessInfoLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoLiveResultInfo' nullable: true description: array of results nullable: true BusinessDataIdListResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataIdListTaskInfo' nullable: true description: array of tasks nullable: true MapsSearch: type: object properties: type: type: string description: type of element nullable: true rank_group: type: integer description: 'position within a group of elements with identical type values positions of elements with different type values are omitted from the rank_group' nullable: true rank_absolute: type: integer description: absolute rank among all the elements nullable: true domain: type: string description: domain of the business entity nullable: true title: type: string description: 'directory title can take the following values: At this place, Directory' nullable: true url: type: string description: URL to view the menu nullable: true rating: type: object oneOf: - $ref: '#/components/schemas/RatingInfo' description: "the element’s rating \nthe popularity rate based on reviews and displayed in SERP" nullable: true rating_distribution: type: object additionalProperties: type: integer format: Int64 nullable: true description: 'the distribution of ratings of the business entity the object displays the number of 1-star to 5-star ratings, as reviewed by users' nullable: true snippet: type: string description: additional information about the business entity nullable: true address: type: string description: address of the business entity nullable: true address_info: type: object oneOf: - $ref: '#/components/schemas/AddressInfo' description: object containing address components of the business entity nullable: true place_id: type: string description: 'unique place identifier place id of the local establishment featured in the element learn more about the identifier in this help center article' nullable: true phone: type: string description: phone number of the business entity nullable: true main_image: type: string description: URL of the main image featured in Google My Business profile nullable: true total_photos: type: string description: total count of images featured in Google My Business profile format: int64 nullable: true category: type: string description: 'business category Google My Business general category that best describes the services provided by the business entity' nullable: true additional_categories: type: array items: type: string description: 'additional business categories additional Google My Business categories that describe the services provided by the business entity in more detail' nullable: true price_level: type: string description: 'property price level can take values: inexpensive, moderate, expensive, very_expensive if there is no price level information, the value will be null' nullable: true hotel_rating: type: string description: 'hotel class rating class ratings range between 1-5 stars, learn more if there is no hotel class rating information, the value will be null' nullable: true category_ids: type: array items: type: string description: 'global category IDs universal category IDs that do not change based on the selected country' nullable: true work_hours: type: object oneOf: - $ref: '#/components/schemas/BusinessWorkHoursInfo' description: 'open hours information about work hours of the local establishment' nullable: true feature_id: type: string description: 'the unique identifier of the element in SERP learn more about the identifier in this help center article' nullable: true cid: type: string description: 'google-defined client id unique id of a local establishment; can be used with Google Reviews API to get a full list of reviews learn more about the identifier in this help center article' nullable: true latitude: type: number description: 'latitude coordinate of the local establishments in google maps example: "latitude": 51.584091' nullable: true longitude: type: number description: 'longitude coordinate of the local establishment in google maps example: "longitude": -0.31365919999999997' nullable: true is_claimed: type: boolean description: shows whether the entity is verified by its owner on Google Maps nullable: true local_justifications: type: array items: type: string description: 'Google local justifications snippets of text that “justify” why the business is showing up for search query' nullable: true is_directory_item: type: boolean description: 'business establishment is a part of the directory indicates whether the business establishment is a part of the directory; if true, the item is a part of the larger directory of businesses with the same address (e.g., a mall or a business centre); note: if the business establishment is a parent item in the directory, the value will be null' nullable: true BusinessDataGoogleHotelInfoLiveHtmlTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoLiveHtmlResultInfo' nullable: true description: array of results nullable: true BusinessDataTrustpilotSearchTaskGetTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTrustpilotSearchTaskGetResultInfo' nullable: true description: array of results nullable: true BusinessDataGoogleHotelSearchesLiveRequestInfo: type: object properties: keyword: type: string description: 'keyword optional field the keyword you specify is used to search for the list of hotels; if you don’t use this field, we will return the list of hotels found in a specified location; you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; Note: in order to obtain accurate search results, the location name is appended to the keyword automatically learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article' nullable: true location_name: type: string description: 'full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you 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 example: London,England,United Kingdom Note: in order to obtain accurate search results, the location_name you specify will be automatically appended to the keyword' nullable: true location_code: type: integer description: 'search engine location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations example: 2840' nullable: true location_coordinate: type: string description: 'GPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter should be specified in the “latitude,longitude” format the maximum number of decimal digits for “latitude” and “longitude”: 7 Note: if the coordinates are used to set a location, the search will occur in the nearest settlement example: 53.476225,-2.243572' nullable: true search_this_area: type: boolean description: 'show hotels from the displayed area optional field can take the values: true, false default value: true if set to false the search_this_area mode will be turned off Note: if the search_this_area mode is turned off, the location_name won’t be appended to the keyword during search learn more about this parameter on our Help Center' nullable: true language_name: type: string description: 'full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages example: English' nullable: true language_code: type: string description: 'search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages example: en' nullable: true depth: type: integer description: 'parsing depth optional field number of results in Google Hotels default value: 20 organic results max value: 140 Note: your account will be billed per each 20 organic results regardless of paid listings in the response; thus, setting a depth above 20 may result in additional charges if Google Hotels return more than 20 results; if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance' nullable: true check_in: type: string description: 'check-in date optional field if you don’t specify this field, tomorrow’s date will be used by default; date format: "yyyy-mm-dd" example: "2019-01-15" Note: the value cannot precede the today’s date' nullable: true check_out: type: string description: 'check-out date optional field if you don’t specify this field, our system will apply the date of two days from now by default; date format: "yyyy-mm-dd" example: "2019-01-15" Note: the value cannot be less than or equal to check_in; the range between check_in and check_out values cannot exceed 30 days' nullable: true currency: type: string description: 'currency optional field example: "USD"' nullable: true adults: type: integer description: 'number of adults optional field if you don’t specify this field, the default value of 2 will be applied; note that you can specify up to 6 persons including both adults and children example: 1' nullable: true children: type: array items: type: string description: 'number and age of children optional field if you don’t specify this field, no children will be included in the search; age of child can be from 0 to 17; note that you can specify up to 6 persons including both adults and children set the following value if you want to include one 14-year-old child: [14] set the following value if you want to include one 13-year-old child and one 8-year-old child: [13,8]' nullable: true stars: type: array items: type: string description: 'hotel stars optional field set this field to [5] if you want to get the list of 5-star hotels only example: [3,4,5]' nullable: true min_rating: type: number description: 'minimum rating optional field you can use this field to specify guest rating higher than a certain value example: 2.5' nullable: true sort_by: type: string description: 'results sorting parameters optional field you can use this field to sort the results possible types of sorting: relevance – sort by most relevant lowest_price – sort by the lowest price highest_rating – sort by highest rating most_reviewed – sort by most reviewed default value: relevance' nullable: true min_price: type: integer description: 'minimum price per night optional field the currency of this value depends on the currency field example: 100' nullable: true max_price: type: integer description: 'maximum price per night optional field the currency of this value depends on the currency field example: 600' nullable: true free_cancellation: type: boolean description: 'hotels with a free cancellation optional field set this field to true if you want to get the list of hotels with free cancellation of reservations default value: false' nullable: true is_vacation_rentals: type: boolean description: 'search for vacation rentals optional field set this field to true if you want to get the list of vacation rentals instead of hotels default value: false' nullable: true amenities: type: array items: type: string description: "hotel amenities\noptional field\nyou can use this field to specify different hotel amenities\nexample:\n [\n \"free_parking\",\n \"pets_allowed\"\n ]\n\npossible values:\n\"air_conditioning\",\n\"all_inclusive_available\",\n\"bar\",\n\"free_breakfast\",\n\"fitness_center\",\n\"kid_friendly\",\n\"free_parking\",\n\"pets_allowed\",\n\"pool\",\n\"restaurant\",\n\"room_service\",\n\"spa\",\n\"free_wifi\",\n\"parking\",\n\"indoor_pool\",\n\"outdoor_pool\",\n\"wheelchair_accessible\",\n\"beach_access\"" nullable: true tag: type: string description: 'user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response' nullable: true example: - language_code: en location_name: New York,New York,United States keyword: cheap hotel check_in: '2026-05-15' check_out: '2026-05-16' currency: USD adults: 2 children: - 14 sort_by: highest_rating tag: example BusinessDataTasksReadyResultInfo: type: object properties: id: type: string description: 'task identifier of the completed task unique task identifier in our system in the UUID format' nullable: true se: type: string description: 'search engine specified when setting the task can take the following values: tripadvisor' nullable: true se_type: type: string description: search engine type nullable: true date_posted: type: string description: date when the task was posted (in the UTC format) nullable: true tag: type: string description: user-defined task identifier nullable: true endpoint: type: string description: URL for collecting the results of the task nullable: true BusinessDataGoogleMyBusinessUpdatesTasksReadyResultInfo: type: object properties: id: type: string description: 'task identifier of the completed task unique task identifier in our system in the UUID format' nullable: true se: type: string description: 'search engine specified when setting the task can take the following values: google' nullable: true se_type: type: string description: search engine type nullable: true date_posted: type: string description: date when the task was posted (in the UTC format) nullable: true tag: type: string description: user-defined task identifier nullable: true endpoint: type: string description: URL for collecting the results of the task nullable: true BusinessDataTripadvisorSearchTaskGetResultInfo: type: object properties: keyword: type: string description: 'keyword received in a POST array this field will contain the alias parameter if it was specified in a POST array' nullable: true se_domain: type: string description: search engine domain in a POST array 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 Tripadvisor results you 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 in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true item_types: type: array items: type: string nullable: true description: 'item types encountered in the result possible item types: tripadvisor_search_organic' nullable: true se_results_count: type: integer description: the total number of results format: int64 nullable: true items_count: type: integer description: 'the number of items in the results array you can get more results by using the depth parameter when setting a task' format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/TripadvisorSearchOrganic' nullable: true description: 'Tripadvisor search listing results you can get more results by using the depth parameter when setting a task' nullable: true BusinessDataTripadvisorReviewsTasksReadyResultInfo: type: object properties: id: type: string description: 'task identifier of the completed task unique task identifier in our system in the UUID format' nullable: true se: type: string description: 'search engine specified when setting the task can take the following values: tripadvisor' nullable: true se_type: type: string description: search engine type nullable: true date_posted: type: string description: date when the task was posted (in the UTC format) nullable: true tag: type: string description: user-defined task identifier nullable: true endpoint: type: string description: URL for collecting the results of the task nullable: true BusinessDataTripadvisorLocationsTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorLocationsResultInfo' nullable: true description: array of results nullable: true BusinessDataTrustpilotReviewsTaskGetResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTrustpilotReviewsTaskGetTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataGoogleLocationsResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleLocationsTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataSocialMediaRedditLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataSocialMediaRedditLiveTaskInfo' nullable: true description: array of tasks nullable: true PeopleAlsoSearch: type: object properties: cid: type: string description: 'google-defined client id unique id of a local establishment learn more about the identifier in this help center article' nullable: true feature_id: type: string description: 'the unique identifier of the element in SERP learn more about the identifier in this help center article' nullable: true title: type: string description: 'title of the element in SERP the name of the business entity for which the results are collected' nullable: true rating: type: object oneOf: - $ref: '#/components/schemas/RatingInfo' description: "the element’s rating \nthe popularity rate based on reviews and displayed in SERP" nullable: true BusinessDataGoogleHotelInfoTaskGetHtmlTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTaskGetHtmlResultInfo' nullable: true description: array of results nullable: true BusinessDataGoogleExtendedReviewsTasksReadyResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleExtendedReviewsTasksReadyTaskInfo' nullable: true description: array of tasks 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 ReviewHighlights: type: object properties: feature: type: string description: reviewed feature nullable: true assessment: type: string description: feature assessment nullable: true BusinessDataBusinessListingsCategoriesAggregationLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataBusinessListingsCategoriesAggregationLiveResultInfo' nullable: true description: array of results nullable: true PricesByDates: type: object properties: price: type: number description: price per night nullable: true currency: type: string description: 'price currency USD 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 BusinessDataGoogleReviewsTasksReadyResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleReviewsTasksReadyTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataBusinessListingsAvailableFiltersResultInfo: type: object properties: search: type: object additionalProperties: type: string nullable: true nullable: true categories_aggregation: type: object additionalProperties: type: string nullable: true nullable: true BusinessDataGoogleReviewsTasksReadyResultInfo: type: object properties: id: type: string description: 'task identifier of the completed task unique task identifier in our system in the UUID format' nullable: true se: type: string description: 'search engine specified when setting the task can take the following values: google' nullable: true se_type: type: string description: type of search engine nullable: true date_posted: type: string description: date when the task was posted (in the UTC format) nullable: true tag: type: string description: user-defined task identifier nullable: true endpoint: type: string description: URL for collecting the results of the task nullable: true BusinessDataGoogleHotelInfoTaskGetAdvancedResultInfo: type: object properties: hotel_identifier: type: string description: 'unique hotel identifier this field will contain the hotel_identifier parameter; example: CgoI-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 you 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 in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true title: type: string description: 'hotel title the title of the hotel entity for which the results are collected' nullable: true stars: type: integer description: 'hotel class rating class 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 class rating that ranges between 1-5 stars and displayed after review ratings in the hotel summary' nullable: true address: type: string description: 'hotel address physical address of the hotel' nullable: true phone: type: string description: 'hotel phone number contact 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 information about the location where the hotel is located' nullable: true reviews: type: object oneOf: - $ref: '#/components/schemas/HotelReviewInfo' description: 'hotel reviews by criteria information about reviews of the hotel entity' nullable: true overview_images: type: array items: type: string nullable: true description: 'images displayed in the hotel overview array 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 contains information about the hotel’s prices' nullable: true BusinessDataGoogleQuestionsAndAnswersTaskGetTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTaskGetResultInfo' nullable: true description: array of results nullable: true BusinessDataGoogleQuestionsAndAnswersTaskPostTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: object description: 'array of results in this case, the value will be null' nullable: true BusinessDataGoogleLocationsTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleLocationsResultInfo' nullable: true description: array of results nullable: true BusinessDataTrustpilotReviewsTaskPostRequestInfo: type: object properties: domain: type: string description: 'domain of the local establishment required field domain of the local establishment on Trustpilot; you can find the domain in the URL of every business listed on Trustpilot example: www.thepearlsource.com https://www.trustpilot.com/review/www.thepearlsource.com' sort_by: type: string description: 'results sorting parameter optional field you can use this field to sort the results; possible sorting parameters: recency — most recent reviews first; relevance — most relevant reviews first; default value: relevance' nullable: true priority: type: integer description: 'task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page.' nullable: true depth: type: integer description: 'parsing depth optional field number of reviews to be returned from the API response we strongly recommend setting the parsing depth in the multiples of twenty, because our system processes twenty reviews in a row default value: 20 maximum value: 200 Your account will be billed per each SERP containing up to 20 results; Setting depth above 20 may result in additional charges if the search engine returns more than 20 results; The cost can be calculated on the Pricing page.' nullable: true tag: type: string description: 'user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response' nullable: true postback_url: type: string description: 'URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center' nullable: true pingback_url: type: string description: 'notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center' nullable: true example: - domain: www.thepearlsource.com depth: 40 BusinessDataTripadvisorSearchTasksReadyResultInfo: type: object properties: id: type: string description: 'task identifier of the completed task unique task identifier in our system in the UUID format' nullable: true se: type: string description: 'search engine specified when setting the task can take the following values: tripadvisor' nullable: true se_type: type: string description: search engine type nullable: true date_posted: type: string description: date when the task was posted (in the UTC format) nullable: true tag: type: string description: user-defined task identifier nullable: true endpoint: type: string description: URL for collecting the results of the task nullable: true BusinessDataGoogleMyBusinessInfoLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoLiveTaskInfo' nullable: true description: array of tasks nullable: true WorkDayInfo: type: object properties: open: type: object oneOf: - $ref: '#/components/schemas/TimeInfo' description: opening time nullable: true close: type: object oneOf: - $ref: '#/components/schemas/TimeInfo' description: closing time nullable: true BusinessDataGoogleReviewsTasksReadyTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleReviewsTasksReadyResultInfo' nullable: true description: array of results nullable: true BusinessDataTrustpilotReviewsTaskPostTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: object description: 'array of results in this case, the value will be null' nullable: true BusinessDataGoogleHotelSearchesTaskGetResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesTaskGetTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataTripadvisorReviewsTaskPostRequestInfo: type: object properties: url_path: type: string description: 'URL path of the business entity required field if you do not specify keyword URL path to the Tripadvisor page of the business entity; examples: Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html https://www.tripadvisor.com/Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html' nullable: true keyword: type: string description: 'keyword required field if you do not specify url_path the keyword you specify should indicate a name of an existing business or prominent place on Tripadvisor; you can specify up to 700 characters in the keyword filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your keyword, please specify it as “%25”' nullable: true location_name: type: string description: 'full name of search engine location required field if you don’t specify location_code or url_path you can receive the list of available locations with location_name by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/locations example: London,England,United Kingdom' nullable: true location_code: type: integer description: 'search engine location code required field if you don’t specify location_name or url_path you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/locations example: 1003854' nullable: true priority: type: integer description: 'task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page.' nullable: true language_name: type: string description: 'full name of search engine language optional field if you use this field, your account will be charged for one extra request you can receive the list of available languages with language_name by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/languages example: English You will be additionally charged for setting a language parameter in this endpoint. The cost can be calculated on the Pricing page.' nullable: true language_code: type: string description: 'search engine language code optional field if you use this field, your account will be charged for one extra request you can receive the list of available languages with language_code by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/languages example: en You will be additionally charged for setting a language parameter in this endpoint. The cost can be calculated on the Pricing page.' nullable: true depth: type: integer description: 'parsing depth optional field number of reviews in SERP; we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row; default value: 10; max value: 4490 Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page.' nullable: true ratings: type: array items: type: string description: 'Tripadvisor traveler rating for a place of interest optional field rating based on the written reviews by a traveler after they visited a place. possible values: excellent, very_good, average, poor, terrible you can specify several values at once' nullable: true visit_type: type: array items: type: string description: 'filter by type of travelers who left a review optional field possible values: families, couples, solo, business, friends you can specify several values at once' nullable: true months: type: array items: type: string description: 'filter by months when a traveler made a visit optional field possible values: january, february, march, april, may, april, june, july, august, september, october, november, december you can specify several values at once' nullable: true search_reviews_keyword: type: string description: 'search reviews containing a specified keyword example: dessert' nullable: true sort_by: type: string description: 'results sorting parameters optional field you can use this field to sort the results; possible types of sorting: most_recent detailed_reviews' nullable: true translate_reviews: type: boolean description: 'translate reviews according to the URL path optional field if set to true, returned reviews will be translated to the language matching the specified url_path; for example, if url_path contains tripadvisor.it and translate_reviews is true, reviews will be translated to the Italian language; default value: true you can learn more about how reviews are translated in this Help Center article' nullable: true tag: type: string description: 'user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response' nullable: true postback_url: type: string description: 'URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center' nullable: true pingback_url: type: string description: 'notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center' nullable: true example: - url_path: Hotel_Review-g60763-d23462501-Reviews-Margaritaville_Times_Square-New_York_City_New_York.html location_code: 1003854 pingback_url: https://your-server.com/pingback.php?id=$id&tag=$tag tag: some_string_123 BusinessDataIdListResultInfo: type: object properties: id: type: string description: id of the task nullable: true url: type: string description: 'URL of the task URL you used for making an API call' nullable: true datetime_posted: type: string description: 'date and time when the task was made in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-15 12:57:46 +00:00' nullable: true datetime_done: type: string description: 'date and time when the task was completed in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-15 12:57:46 +00:00' nullable: true status: type: string description: 'informational message of the task you can find the full list of general informational messages here' nullable: true cost: type: number description: cost of the task, USD nullable: true metadata: type: array items: type: string nullable: true description: contains parameters you specified in the POST request nullable: true BusinessDataGoogleExtendedReviewsTaskGetTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleExtendedReviewsTaskGetResultInfo' nullable: true description: array of results nullable: true BusinessDataGoogleMyBusinessUpdatesTaskPostRequestInfo: type: object properties: keyword: type: string description: 'keyword required field the keyword you specify should indicate the name of the local establishment you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”;this field can also be used to pass cid (unique, google-defined id of the business entity) or place_id (identifier of the business entity in Google Maps) parameters example: cid:194604053573767737 place_id:GhIJQWDl0CIeQUARxks3icF8U8A learn more about the cid and place_id identifiers in this help center article' priority: type: integer description: 'task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page.' nullable: true location_name: type: string description: 'full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available locations with location_name by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations example: London,England,United Kingdom' nullable: true location_code: type: integer description: 'search engine location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations example: 2840' nullable: true location_coordinate: type: string description: 'GPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter should be specified in the “latitude,longitude,radius” format the maximum number of decimal digits for “latitude” and “longitude”: 7 the minimum value for “radius”: 199.9 example: 53.476225,-2.243572,200' nullable: true language_name: type: string description: 'full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to the https://api.dataforseo.com/v3/business_data/google/languages example: English' nullable: true language_code: type: string description: 'search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/languages example: en' nullable: true depth: type: integer description: 'parsing depth optional field number of updates in SERP we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten updates in a row please note that Google returns 4490 updates maximum default value: 10' nullable: true tag: type: string description: 'user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response' nullable: true postback_url: type: string description: 'URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center' nullable: true pingback_url: type: string description: 'notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center' nullable: true example: - language_code: en location_name: New York,New York,United States keyword: RustyBrick, Inc. BusinessDataTripadvisorLocationsCountryResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorLocationsCountryTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataGoogleMyBusinessInfoTaskGetResultInfo: type: object properties: keyword: type: string description: 'keyword received in a POST array keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) this field will contain the cid parameter if you specified it in the keyword field when setting a task; example: cid:2946633002421908862 learn more about the parameter in this help center article' nullable: true se_domain: type: string description: search engine domain as specified in a POST array 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 you 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 in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true item_types: type: array items: type: string nullable: true description: 'item types types of search engine results encountered in the items array; possible item types: google_business_info' nullable: true items_count: type: integer description: 'item types the number of items in the items array' format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/GoogleBusinessInfo' nullable: true description: array of directory items nullable: true BusinessDataGoogleQuestionsAndAnswersTaskGetResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTaskGetTaskInfo' nullable: true description: array of tasks nullable: true BaseLocalBusinessLink: type: object properties: type: type: string description: type of element nullable: true additionalProperties: false discriminator: propertyName: type mapping: reservation: '#/components/schemas/LocalBusinessReservationLink' order: '#/components/schemas/LocalBusinessOrderLink' menu: '#/components/schemas/LocalBusinessMenuLink' BusinessDataGoogleQuestionsAndAnswersTasksReadyResultInfo: type: object properties: id: type: string description: 'task identifier of the completed task unique task identifier in our system in the UUID format' nullable: true se: type: string description: 'search engine specified when setting the task can take the following values: google' nullable: true se_type: type: string description: search engine type nullable: true date_posted: type: string description: date when the task was posted (in the UTC format) nullable: true tag: type: string description: user-defined task identifier nullable: true endpoint: type: string description: URL for collecting the results of the task 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 BusinessDataGoogleHotelInfoTaskGetAdvancedResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTaskGetAdvancedTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataGoogleLanguagesTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleLanguagesResultInfo' nullable: true description: array of results nullable: true BusinessDataUserProfileInfo: type: object properties: name: type: string description: the name of the reviewer nullable: true url: type: string description: URL to the reviewer’s profile nullable: true image_url: type: string description: URL to the reviewer’s profile picture nullable: true location: type: string description: country of the reviewer nullable: true reviews_count: type: integer description: total number of reviews submitted by the reviewer format: int64 nullable: true BusinessDataErrorsResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataErrorsTaskInfo' nullable: true description: array of tasks 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 USD is applied by default, unless specified in the POST array' nullable: true url: type: string description: 'third-party page url URL to the third-party website page with pricing information' nullable: true domain: type: string description: 'third-party domain domain of the third-party website page with pricing information' nullable: true is_paid: type: boolean description: 'indicates a paid hotel listing if true, related hotel_search_item is a paid ad if 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 in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” equals 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 BusinessDataGoogleMyBusinessInfoTaskPostRequestInfo: type: object properties: keyword: type: string description: "keyword\nrequired field\nthe keyword you specify should indicate the name of the local establishment\nyou can specify up to 700 characters in the keyword filed\nall %## will be decoded (plus character ‘+’ will be decoded to a space character)\nif you need to use the “%” character for your keyword, please specify it as “%25”; \nthis field can also be used to pass the following parameters:\ncid – a unique, google-defined id of the business entity;\nplace_id – an identifier of the business entity in Google Maps;\nexample:\ncid:194604053573767737\nplace_id:GhIJQWDl0CIeQUARxks3icF8U8A\nlearn more about the cid and place_id identifiers in this help center article\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article" priority: type: integer description: 'task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page.' nullable: true location_name: type: string description: 'full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you 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 example: London,England,United Kingdom' nullable: true location_code: type: integer description: 'search engine location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations example: 2840' nullable: true location_coordinate: type: string description: 'GPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter should be specified in the “latitude,longitude,radius” format the maximum number of decimal digits for “latitude” and “longitude”: 7 the minimum value for “radius”: 199.9 (mm) the maximum value for “radius”: 199999 (mm) example: 53.476225,-2.243572,200' nullable: true language_name: type: string description: 'full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages example: English' nullable: true language_code: type: string description: 'search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages example: en' nullable: true tag: type: string description: 'user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response' nullable: true postback_url: type: string description: 'URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center' nullable: true pingback_url: type: string description: 'notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center' nullable: true example: - language_code: en location_name: New York,New York,United States keyword: RustyBrick, Inc. GoogleBusinessQuestionItem: type: object properties: type: type: string description: type of element nullable: true rank_group: type: integer description: 'position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group' nullable: true rank_absolute: type: integer description: absolute rank among all the elements nullable: true question_id: type: string description: ID of the question nullable: true url: type: string description: URL of the question nullable: true profile_image_url: type: string description: URL of the user’s profile image nullable: true profile_url: type: string description: URL of the user’s profile nullable: true profile_name: type: string description: displayed name of the user nullable: true question_text: type: string description: current text of the question nullable: true original_question_text: type: string description: original text of the question nullable: true time_ago: type: string description: estimated time when the question was posted nullable: true timestamp: type: string description: exact time when the question was posted nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/GoogleBusinessAnswerElement' nullable: true description: 'array of items items within google_business_question_item' nullable: true BusinessDataTrustpilotSearchTaskGetResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTrustpilotSearchTaskGetTaskInfo' nullable: true description: array of tasks 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 indicates whether the review element is visible by default' nullable: true TripadvisorReviewSearch: type: object properties: type: type: string description: type of element nullable: true rank_group: type: integer description: 'position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group' nullable: true rank_absolute: type: integer description: 'absolute rank among all the listed reviews absolute position among all reviews on the list' nullable: true position: type: string description: 'the alignment of the review in SERP can take the following values: right' nullable: true url: type: string description: URL of the review nullable: true rating: type: object oneOf: - $ref: '#/components/schemas/RatingInfo' description: the rating score submitted by the reviewer nullable: true date_of_visit: type: string description: 'date of the reviewer’s visit to the local establishment in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true timestamp: type: string description: 'date and time when the review was published in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true review_id: type: string description: ID of the review nullable: true title: type: string description: title of the review nullable: true review_text: type: string description: content of the review nullable: true language: type: string description: language of the review text nullable: true original_language: type: string description: language of the untranslated review text nullable: true review_images: type: array items: type: object oneOf: - $ref: '#/components/schemas/ImageUrlInfo' nullable: true description: contains URLs of the images used in the review nullable: true user_profile: type: object oneOf: - $ref: '#/components/schemas/BusinessDataUserProfileInfo' description: information from the reviewer’s profile nullable: true responses: type: array items: type: object oneOf: - $ref: '#/components/schemas/ReviewResponseItemInfo' nullable: true description: contains information about the owner’s response nullable: true review_highlights: type: object description: 'review highlights contains highlighted review criteria and assessments' nullable: true TrustpilotReviewSearch: type: object properties: type: type: string description: type of element nullable: true rank_group: type: integer description: 'position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group' nullable: true rank_absolute: type: integer description: 'absolute rank among all the listed reviews absolute position among all reviews on the list' nullable: true position: type: string description: 'the alignment of the review in SERP can take the following values: right' nullable: true url: type: string description: the URL of the review nullable: true rating: type: object oneOf: - $ref: '#/components/schemas/RatingInfo' description: the rating score submitted by the reviewer nullable: true verified: type: boolean description: indicates whether the review has the “Verified” mark nullable: true language: type: string description: the language of the review nullable: true timestamp: type: string description: 'date and time when a review was published in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true title: type: string description: the title of the review nullable: true review_text: type: string description: the content of the review nullable: true review_images: type: array items: type: string description: 'images submitted by the reviewer displays URLs to the images provided by the author of the review; please note that Trustpilot doesn’t allow adding images to reviews, so the review_images parameter will always equal null' nullable: true user_profile: type: object oneOf: - $ref: '#/components/schemas/BusinessDataUserProfileInfo' description: user profile of the reviewer nullable: true responses: type: array items: type: object oneOf: - $ref: '#/components/schemas/ReviewResponseItemInfo' nullable: true description: owner’s response to the submitted review nullable: true BusinessDataSocialMediaPinterestLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataSocialMediaPinterestLiveTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataTrustpilotReviewsTasksReadyResultInfo: type: object properties: id: type: string description: 'task identifier of the completed task unique task identifier in our system in the UUID format' nullable: true se: type: string description: 'search engine specified when setting the task can take the following values: trustpilot' nullable: true se_type: type: string description: search engine type nullable: true date_posted: type: string description: date when the task was posted (in the UTC format) nullable: true tag: type: string description: user-defined task identifier nullable: true endpoint: type: string description: URL for collecting the results of the task nullable: true BusinessDataGoogleExtendedReviewsTaskPostResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleExtendedReviewsTaskPostTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataBusinessListingsCategoriesResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataBusinessListingsCategoriesTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataGoogleHotelInfoTaskPostResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTaskPostTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataGoogleMyBusinessUpdatesTaskGetTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTaskGetResultInfo' nullable: true description: array of results nullable: true BusinessDataTripadvisorSearchTaskPostRequestInfo: type: object properties: keyword: type: string description: 'keyword required field the keyword you specify should indicate a business category, company name, or a prominent place; you can specify up to 700 characters in the keyword filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your keyword, please specify it as “%25” learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article' location_name: type: string description: 'full name of search engine location required field if you don’t specify location_code you can receive the list of available locations with location_name by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/locations example: London,England,United Kingdom' nullable: true location_code: type: integer description: 'search engine location code required field if you don’t specify location_name you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/tripadvisor/locations example: 1003854' nullable: true priority: type: integer description: 'task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page.' nullable: true depth: type: integer description: 'parsing depth optional field number of search results to be returned from the API response we strongly recommend setting the parsing depth in the multiples of thirty because our systems processes thirty search results in a row; default value: 30; maximum value: 210 Your account will be billed per each SERP containing up to 30 results; Setting depth above 30 may result in additional charges if the search engine returns more than 30 results; The cost can be calculated on the Pricing page.' nullable: true tag: type: string description: 'user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response' nullable: true postback_url: type: string description: 'URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center' nullable: true pingback_url: type: string description: 'notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center' nullable: true example: - keyword: pizza location_code: 1003854 depth: 30 BusinessDataTripadvisorLocationsResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorLocationsTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataBusinessListingsLocationsResultInfo: type: object properties: location_name: type: string description: full name of the location nullable: true country_iso_code: type: string description: ISO country code of the location nullable: true business_count: type: integer description: number of businesses in this location in our database format: int64 nullable: true BusinessDataGoogleLanguagesResultInfo: 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 BusinessDataGoogleQuestionsAndAnswersTaskPostRequestInfo: type: object properties: keyword: type: string description: "keyword\nrequired field\nthe keyword you specify should indicate the name of the local establishment\nyou can specify up to 700 characters in the keyword filed\nall %## will be decoded (plus character ‘+’ will be decoded to a space character)\nif you need to use the “%” character for your keyword, please specify it as “%25”; \nthis field can also be used to pass the following parameters:\ncid – a unique, google-defined id of the business entity;\nplace_id – an identifier of the business entity in Google Maps;\nexample:\ncid:194604053573767737\nplace_id:GhIJQWDl0CIeQUARxks3icF8U8A\nlearn more about the cid and place_id identifiers in this help center article\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article" priority: type: integer description: 'task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page.' nullable: true location_name: type: string description: 'full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you 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 example: London,England,United Kingdom' nullable: true location_code: type: integer description: 'search engine location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations example: 2840' nullable: true location_coordinate: type: string description: 'GPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter should be specified in the “latitude,longitude,radius” format the maximum number of decimal digits for “latitude” and “longitude”: 7 the minimum value for “radius”: 199.9 (mm) the maximum value for “radius”: 199999 (mm) example: 53.476225,-2.243572,200' nullable: true language_name: type: string description: 'full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages example: English' nullable: true language_code: type: string description: 'search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages example: en' nullable: true depth: type: integer description: 'parsing depth optional field number of question rows in the result default value: 20 max value: 700 Your account will be billed per each SERP containing up to 20 results; Setting depth above 20 may result in additional charges if the search engine returns more than 20 results; If the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance; The cost can be calculated on the Pricing page.' nullable: true tag: type: string description: 'user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response' nullable: true postback_url: type: string description: 'URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center' nullable: true pingback_url: type: string description: 'notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center' nullable: true example: - language_code: en location_name: Los Angeles,California,United States keyword: The Last Bookstore BusinessDataGoogleExtendedReviewsTasksReadyResultInfo: type: object properties: id: type: string description: 'task identifier of the completed task unique task identifier in our system in the UUID format' nullable: true se: type: string description: 'search engine specified when setting the task can take the following values: google' nullable: true se_type: type: string description: type of search engine nullable: true date_posted: type: string description: date when the task was posted (in the UTC format) nullable: true tag: type: string description: user-defined task identifier nullable: true endpoint: type: string description: URL for collecting the results of the task nullable: true GoogleReviewsSearch: type: object properties: type: type: string description: type of element nullable: true rank_group: type: integer description: 'position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group' nullable: true rank_absolute: type: integer description: 'absolute rank among all the listed reviews absolute position among all reviews on the list' nullable: true position: type: string description: 'the alignment of the review in SERP can take the following values: right' nullable: true xpath: type: string description: the XPath of the review nullable: true review_text: type: string description: the content of the review nullable: true original_review_text: type: string description: 'original content of the review the original content of the review, no auto-translate applied' nullable: true original_language: type: string description: original language of the review text nullable: true time_ago: type: string description: 'the time of publication indicates the time (in the ‘time ago’ format) when the review was listed' nullable: true timestamp: type: string description: 'date and time when a review was published in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true rating: type: object oneOf: - $ref: '#/components/schemas/RatingInfo' description: the rating score submitted by the reviewer nullable: true reviews_count: type: integer description: total number of reviews submitted by the reviewer format: int64 nullable: true photos_count: type: integer description: total number of photos submitted by the reviewer format: int64 nullable: true local_guide: type: boolean description: indicates whether the reviewer has a ‘local guide’ status nullable: true profile_name: type: string description: profile name of the reviewer nullable: true profile_url: type: string description: URL of the reviewer’s profile nullable: true review_url: type: string description: the URL of the review nullable: true profile_image_url: type: string description: URL of the reviewer’s profile image nullable: true owner_answer: type: string description: 'text of the owner’s response the owner’s response to the review' nullable: true original_owner_answer: type: string description: 'original text of the owner’s response the original response to the review, no auto-translate applied' nullable: true owner_time_ago: type: string description: 'publication time indicates the time (in the ‘time ago’ format) when the owner submitted the response to the review' nullable: true owner_timestamp: type: string description: 'date and time of the owner’s reply to the review in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true review_id: type: string description: 'the unique identifier of a review on Google example: ChZDSUhNMG9nS0VJQ0FnSUMxbHFyMFlnEAE' nullable: true images: type: array items: type: object oneOf: - $ref: '#/components/schemas/AiModeImagesElementInfo' nullable: true description: images submitted by the reviewer nullable: true review_highlights: type: array items: type: object oneOf: - $ref: '#/components/schemas/ReviewHighlights' nullable: true description: 'review highlights contains highlighted review criteria and assessments' nullable: true BusinessDataGoogleMyBusinessUpdatesTasksReadyTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTasksReadyResultInfo' nullable: true description: array of results nullable: true BusinessDataGoogleHotelInfoTasksReadyTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTasksReadyResultInfo' nullable: true description: array of results nullable: true GpsCoordinatesLocationInfo: type: object properties: latitude: type: number description: 'latitude coordinate of the hotel in google maps example: "latitude": 51.584091' nullable: true longitude: type: number description: 'longitude coordinate of the hotel in google maps example: "longitude": -0.31365919999999997' 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 BusinessDataGoogleMyBusinessUpdatesTaskGetResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTaskGetTaskInfo' nullable: true description: array of tasks nullable: true ImageUrlInfo: type: object properties: url: type: string description: URL of the image used in the review nullable: true BusinessDataTrustpilotSearchTaskPostResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTrustpilotSearchTaskPostTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataGoogleReviewsTaskGetTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleReviewsTaskGetResultInfo' nullable: true description: array of results 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 BusinessDataGoogleHotelInfoLiveHtmlResultInfo: type: object properties: keyword: type: string description: unique hotel identifier specified as "hotel_id:$" nullable: true type: type: string description: type of element nullable: true se_domain: type: string description: search engine domain in a POST array 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 datetime: type: string description: 'date and time when the result was received in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/HtmlItemInfo' nullable: true description: HTML pages nullable: true BusinessDataGoogleQuestionsAndAnswersLiveRequestInfo: type: object properties: keyword: type: string description: "keyword\nrequired field\nthe keyword you specify should indicate the name of the local establishment\nyou can specify up to 700 characters in the keyword filed\nall %## will be decoded (plus character ‘+’ will be decoded to a space character)\nif you need to use the “%” character for your keyword, please specify it as “%25”; \nthis field can also be used to pass the following parameters:\ncid – a unique, google-defined id of the business entity;\nplace_id – an identifier of the business entity in Google Maps;\nexample:\ncid:194604053573767737\nplace_id:GhIJQWDl0CIeQUARxks3icF8U8A\nlearn more about the cid and place_id identifiers in this help center article\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article" location_name: type: string description: 'full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you 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 example: London,England,United Kingdom' nullable: true location_code: type: integer description: 'search engine location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations example: 2840' nullable: true location_coordinate: type: string description: 'GPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter should be specified in the “latitude,longitude,radius” format the maximum number of decimal digits for “latitude” and “longitude”: 7 the minimum value for “radius”: 199.9 (mm) the maximum value for “radius”: 199999 (mm) example: 53.476225,-2.243572,200' nullable: true language_name: type: string description: 'full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages example: English' nullable: true language_code: type: string description: 'search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages example: en' nullable: true depth: type: integer description: 'parsing depth optional field number of results in SERP default value: 20 max value: 100 Your account will be billed per each SERP containing up to 20 results; Setting depth above 20 may result in additional charges if the search engine returns more than 20 results; If the specified depth is higher than the number of questions in the response, the difference will be refunded automatically to your account balance; The cost can be calculated on the Pricing page.' nullable: true tag: type: string description: 'user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response' nullable: true example: - language_code: en location_name: Los Angeles,California,United States keyword: The Last Bookstore BusinessDataGoogleExtendedReviewsTaskPostRequestInfo: type: object properties: keyword: type: string description: 'keyword required field if you don’t specify cid or place_id the keyword you specify should indicate the name of the local establishment; you can specify up to 700 characters in the keyword filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article Note: if you use this field, your account will be charged three times the standard rate for tasks involving the Google Reviews API' nullable: true cid: type: string description: 'unique, google-defined id of the business entity required field if you don’t specify keyword or place_id example: 194604053573767737 learn more about the identifier in this help center article Note: if you use this field, your account will be charged two times the standard rate for tasks involving the Google Reviews API' nullable: true place_id: type: string description: 'identifier of the business entity in Google Maps required field if you don’t specify keyword or cid example: GhIJQWDl0CIeQUARxks3icF8U8A learn more about the identifier in this help center article Note: if you use this field, your account will be charged two times the standard rate for tasks involving the Google Reviews API' nullable: true priority: type: integer description: 'task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page.' nullable: true location_name: type: string description: 'full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available locations with location_name by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations example: London,England,United Kingdom' nullable: true location_code: type: integer description: 'search engine location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations example: 2840' nullable: true location_coordinate: type: string description: 'GPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter should be specified in the “latitude,longitude,radius” format the maximum number of decimal digits for “latitude” and “longitude”: 7 the minimum value for “radius”: 199.9 example: 53.476225,-2.243572,200' nullable: true language_name: type: string description: 'full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to the https://api.dataforseo.com/v3/business_data/google/languages example: English' nullable: true language_code: type: string description: 'search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/languages example: en' nullable: true depth: type: integer description: 'parsing depth optional field number of reviews in SERP we strongly recommend setting the parsing depth in the multiples of twenty, because our systems processes twenty reviews in a row default value: 20 maximum value: 1000 Your account will be billed per each SERP containing up to 20 results; Setting depth above 20 may result in additional charges if the search engine returns more than 20 results; The cost can be calculated on the Pricing page.' nullable: true tag: type: string description: 'user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response' nullable: true postback_url: type: string description: 'URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center' nullable: true pingback_url: type: string description: 'notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center' nullable: true example: - location_name: London,England,United Kingdom language_name: english cid: '17626775537598922320' BusinessDataTrustpilotReviewsTaskPostResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTrustpilotReviewsTaskPostTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataBusinessListingsSearchLiveRequestInfo: type: object properties: categories: type: array items: type: string description: 'business categories optional field the categories you specify are used to search for business listings; if you don’t use this field, we will return business listings found in the specified location; you can specify up to 10 categories' nullable: true description: type: string description: 'description of the element in SERP optional field the description of the business entity for which the results are collected; can contain up to 200 characters' nullable: true title: type: string description: 'title of the element in SERP optional field the name of the business entity for which the results are collected; can contain up to 200 characters' nullable: true is_claimed: type: boolean description: 'indicates whether the business is verified by its owner on Google Maps optional field' nullable: true location_coordinate: type: string description: 'GPS coordinates of a location optional field location_coordinate parameter should be specified in the “latitude,longitude,radius” format the maximum number of decimal digits for “latitude” and “longitude”: 7 the value of “radius” is specified in kilometres (km) the minimum value for “radius”: 1 the maximum value for “radius”: 100000 example: 53.476225,-2.243572,200' nullable: true filters: type: array items: type: object nullable: true description: 'array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: ["rating.value",">",3] you can receive the list of available filters by making a separate request to https://api.dataforseo.com/v3/business_data/business_listings/available_filters The full list of possible filters is available here.' nullable: true order_by: type: array items: type: string description: 'results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order you should use a comma to set up a sorting parameter example: ["rating.value,desc"]note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["rating.value,desc","rating.votes_count,desc"]' nullable: true limit: type: integer description: 'the maximum number of returned businesses optional field default value: 100 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned businesses optional field default value: 0 if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead' nullable: true offset_token: type: string description: 'token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 100,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters should be identical to the previous request learn more about this parameter on our Help Center' nullable: true tag: type: string description: 'user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response' nullable: true example: - categories: - pizza_restaurant description: pizza title: pizza is_claimed: true location_coordinate: 53.476225,-2.243572,10 order_by: - rating.value,desc filters: - - rating.value - '>' - 3 limit: 3 BusinessDataErrorsResultInfo: type: object properties: id: type: string description: id of the task nullable: true datetime: type: string description: 'date and time when an error occurred in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true function: type: string description: corresponding API function nullable: true error_code: type: integer description: error code nullable: true error_message: type: string description: 'error message or error URL error message (see full list) or URL that caused an error' nullable: true http_url: type: string description: 'URL that caused an error URL you used for making an API call or pingback/postback URL' nullable: true http_method: type: string description: HTTP method nullable: true http_code: type: integer description: HTTP status code nullable: true http_time: type: number description: 'time taken by HTTP request for tasks set with a pingback/postback, this field will show the time it took your server to respond' nullable: true http_response: type: string description: 'HTTP response server response' nullable: true BusinessDataSocialMediaRedditLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataSocialMediaRedditLiveResultInfo' nullable: true description: array of results nullable: true BusinessDataGoogleHotelInfoTaskGetHtmlResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTaskGetHtmlTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataBusinessListingsLocationsTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataBusinessListingsLocationsResultInfo' nullable: true description: array of results nullable: true BusinessDataGoogleHotelInfoLiveAdvancedResultInfo: type: object properties: hotel_identifier: type: string description: 'identifier received in a POST array this field will contain the hotel_identifier parameter specified when setting a task; example: CgoI-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 you 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 in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true title: type: string description: 'hotel title the title of the hotel entity for which the results are collected' nullable: true stars: type: integer description: 'hotel class rating class 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 class rating that ranges between 1-5 stars and displayed after review ratings in the hotel summary' nullable: true address: type: string description: 'hotel address physical address of the hotel' nullable: true phone: type: string description: 'hotel phone number contact 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 information about the location where the hotel is located' nullable: true reviews: type: object oneOf: - $ref: '#/components/schemas/HotelReviewInfo' description: 'hotel reviews by criteria information about reviews of the hotel entity' nullable: true overview_images: type: array items: type: string nullable: true description: 'images displayed in the hotel overview array 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 contains information about the hotel’s prices' nullable: true BusinessDataGoogleMyBusinessInfoTaskGetResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoTaskGetTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataGoogleMyBusinessUpdatesTaskPostResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTaskPostTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataTrustpilotSearchTaskPostRequestInfo: type: object properties: keyword: type: string description: 'keyword required field the keyword you specify should indicate a business category or company name; you can specify up to 700 characters in the keyword filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character); if you need to use the “%” character for your keyword, please specify it as “%25” learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article' priority: type: integer description: 'task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page.' nullable: true depth: type: integer description: 'parsing depth optional field number of search results to be returned from the API response we strongly recommend setting the parsing depth in the multiples of twenty because our systems processes twenty search results in a row; default value: 10; maximum value: 140 Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page.' nullable: true tag: type: string description: 'user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response' nullable: true postback_url: type: string description: 'URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center' nullable: true pingback_url: type: string description: 'notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center' nullable: true example: - keyword: pizza restaurant depth: 20 WorkHours: type: object properties: timetable: type: object additionalProperties: type: array items: type: object oneOf: - $ref: '#/components/schemas/WorkDayInfo' description: work hours on Sundays nullable: true nullable: true description: work hours timetable nullable: true current_status: type: string description: 'current status of the establishment indicates whether the establishment is opened or closed' nullable: true BusinessDataAttributesInfo: type: object properties: available_attributes: type: object additionalProperties: type: array items: type: string nullable: true nullable: true description: 'available attributes indicates attributes a business entity can offer' nullable: true unavailable_attributes: type: object additionalProperties: type: array items: type: string nullable: true nullable: true description: 'unavailable attributes indicates attributes a business entity cannot offer' nullable: true BusinessDataGoogleMyBusinessInfoTaskGetTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoTaskGetResultInfo' nullable: true description: array of results nullable: true BusinessDataGoogleMyBusinessInfoLiveRequestInfo: type: object properties: keyword: type: string description: "keyword\nrequired field\nthe keyword you specify should indicate the name of the local establishment\nyou can specify up to 700 characters in the keyword filed\nall %## will be decoded (plus character ‘+’ will be decoded to a space character)\nif you need to use the “%” character for your keyword, please specify it as “%25”; \nthis field can also be used to pass the following parameters:\ncid – a unique, google-defined id of the business entity;\nplace_id – an identifier of the business entity in Google Maps;\nexample:\ncid:194604053573767737\nplace_id:GhIJQWDl0CIeQUARxks3icF8U8A\nlearn more about the cid and place_id identifiers in this help center article\nlearn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article" location_name: type: string description: 'full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you 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 example: London,England,United Kingdom' nullable: true location_code: type: integer description: 'search engine location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations example: 2840' nullable: true location_coordinate: type: string description: 'GPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter should be specified in the “latitude,longitude,radius” format the maximum number of decimal digits for “latitude” and “longitude”: 7 the minimum value for “radius”: 199.9 (mm) the maximum value for “radius”: 199999 (mm) example: 53.476225,-2.243572,200' nullable: true language_name: type: string description: 'full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages example: English' nullable: true language_code: type: string description: 'search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages example: en' nullable: true tag: type: string description: 'user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response' nullable: true example: - language_code: en location_name: New York,New York,United States keyword: RustyBrick, Inc. GoogleBusinessInfo: type: object properties: type: type: string description: type of element nullable: true rank_group: type: integer description: 'position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group' nullable: true rank_absolute: type: integer description: absolute rank among all the elements nullable: true position: type: string description: the alignment in SERP nullable: true title: type: string description: 'title of the element in SERP the name of the business entity for which the results are collected' nullable: true original_title: type: string description: 'original title of the element original title not translated by Google' nullable: true description: type: string description: 'description of the element in SERP the description of the business entity for which the results are collected' nullable: true category: type: string description: 'business category Google My Business general category that best describes the services provided by the business entity' nullable: true category_ids: type: array items: type: string description: 'global category IDs universal category IDs that do not change based on the selected country' nullable: true additional_categories: type: array items: type: string description: 'additional business categories additional Google My Business categories that describe the services provided by the business entity in more detail' nullable: true cid: type: string description: 'google-defined client id unique id of a local establishment; can be used with Google Reviews API to get a full list of reviews learn more about the identifier in this help center article' nullable: true feature_id: type: string description: 'the unique identifier of the element in SERP learn more about the identifier in this help center article' nullable: true address: type: string description: address of the business entity nullable: true address_info: type: object oneOf: - $ref: '#/components/schemas/AddressInfo' description: object containing address components of the business entity nullable: true place_id: type: string description: 'unique place identifier place id of the local establishment featured in the element learn more about the identifier in this help center article' nullable: true phone: type: string description: phone number of the business entity nullable: true url: type: string description: absolute url of the business entity nullable: true contact_url: type: string description: URL of the preferred contact page nullable: true contributor_url: type: string description: URL of the user’s or entity’s Local Guides profile, if available nullable: true book_online_url: type: string description: 'URL in the ‘book online’ button of the element URL directing users to the online booking or order page of the business entity' nullable: true domain: type: string description: domain of the business entity nullable: true logo: type: string description: URL of the logo featured in Google My Business profile nullable: true main_image: type: string description: URL of the main image featured in Google My Business profile nullable: true total_photos: type: integer description: total count of images featured in Google My Business profile format: int64 nullable: true snippet: type: string description: additional information on the business entity nullable: true latitude: type: number description: 'latitude coordinate of the local establishments in google maps example: "latitude": 51.584091' nullable: true longitude: type: number description: 'longitude coordinate of the local establishment in google maps example: "longitude": -0.31365919999999997' nullable: true is_claimed: type: boolean description: shows whether the entity is verified by its owner on Google Maps nullable: true questions_and_answers_count: type: integer nullable: true attributes: type: object oneOf: - $ref: '#/components/schemas/BusinessDataAttributesInfo' description: 'service details in a form of user-reviewed checks; service details of a business entity displayed in a form of checks and based on user feedback and business category' nullable: true place_topics: type: object additionalProperties: type: integer format: int64 nullable: true description: "keywords mentioned in customer reviews\ncontains most popular keywords related to products/services mentioned in customer reviews of a business entity and the number of reviews mentioning each keyword\nexample: \n\"place_topics\": {\n\"egg roll\": 48,\n\"birthday\": 33\n}" nullable: true rating: type: object oneOf: - $ref: '#/components/schemas/RatingInfo' description: "the element’s rating \nthe popularity rate based on reviews and displayed in SERP" nullable: true hotel_rating: type: number description: 'hotel class rating class ratings range between 1-5 stars, learn more if there is no hotel class rating information, the value will be null' nullable: true price_level: type: string description: 'property price level can take values: inexpensive, moderate, expensive, very_expensive if there is no price level information, the value will be null' nullable: true rating_distribution: type: object additionalProperties: type: integer format: Int64 nullable: true description: 'the distribution of ratings of the business entity the object displays the number of 1-star to 5-star ratings, as reviewed by users' nullable: true people_also_search: type: array items: type: object oneOf: - $ref: '#/components/schemas/PeopleAlsoSearch' nullable: true description: related business entities nullable: true work_time: type: object oneOf: - $ref: '#/components/schemas/BusinessWorkHoursInfo' description: 'work time details information related to operational hours of the business entity' nullable: true popular_times: type: object oneOf: - $ref: '#/components/schemas/PopularTimes' description: 'popular times information related to busy hours of the business entity' nullable: true local_business_links: type: array items: type: object oneOf: - $ref: '#/components/schemas/BaseLocalBusinessLink' nullable: true description: 'available interactions with the business list of options to interact with the business directly from search results' nullable: true is_directory_item: type: boolean description: 'business establishment is a part of the directory indicates whether the business establishment is a part of the directory; if true, the item is a part of the larger directory of businesses with the same address (e.g., a mall or a business centre); note: if the business establishment is a parent item in the directory, the value will be null' nullable: true directory: type: object oneOf: - $ref: '#/components/schemas/BusinessDirectoryInfo' description: 'items of the directory includes information about businesses that are located within the target business establishment and have the same address' 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 BusinessDataBusinessListingsAvailableFiltersResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataBusinessListingsAvailableFiltersTaskInfo' nullable: true nullable: true BusinessDataErrorsTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataErrorsResultInfo' nullable: true description: array of results nullable: true BusinessDirectoryInfo: type: object properties: title: type: string description: 'title of the element domain of the online menu system' nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/MapsSearch' nullable: true description: 'encountered item types types of search engine results encountered in the items array; possible item types: google_business_info' nullable: true BusinessDataSocialMediaRedditLiveRequestInfo: type: object properties: targets: type: array items: type: string description: 'target URLs required field target page should be specified with its absolute URL (including http:// or https://) example: https://dataforseo.com/ Note: you can specify 10 targets maximum. You will be charged per earch URL you specify in this array' tag: type: string description: 'user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response' nullable: true example: - targets: - https://vk.com/ - https://ahrefs.com/ - https://google.com/ - https://twitter.com/ - https://reddit.com/ - https://facebook.com/ tag: some_string_123 BusinessDataBusinessListingsAvailableFiltersTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataBusinessListingsAvailableFiltersResultInfo' nullable: true nullable: true BusinessDataTrustpilotReviewsTaskGetResultInfo: type: object properties: domain: type: string description: domain of the business entity nullable: true type: type: string description: type of element nullable: true se_domain: type: string description: search engine domain in a POST array nullable: true check_url: type: string description: 'direct URL to search engine results you 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 in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true title: type: string description: 'title of the ‘reviews’ element on Trustpilot the name of the business entity for which the reviews are collected' nullable: true location: type: string description: 'location of the business entity as specified on Trustpilot address of the business entity for which the reviews are collected' nullable: true reviews_count: type: string description: the total number of reviews format: int64 nullable: true rating: type: object description: 'rating of the corresponding business entity popularity rate based on reviews and displayed in SERP' nullable: true items_count: type: integer description: 'the number of items in the results array you can get more results by using the depth parameter when setting a task' format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/TrustpilotReviewSearch' nullable: true description: 'found reviews you can get more results by using the depth parameter when setting a task' nullable: true BusinessDataTrustpilotReviewsTasksReadyTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTrustpilotReviewsTasksReadyResultInfo' nullable: true description: array of results nullable: true HotelAboutInfo: type: object properties: description: type: string description: 'description of the hotel the 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 details 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 check-in time indicated in the hotel listing' nullable: true check_out_time: type: object oneOf: - $ref: '#/components/schemas/TimeInfo' description: 'hotel check-out time check-out time indicated in the hotel listing' nullable: true full_address: type: string description: 'full address of the hotel address of the hotel indicated in the standardised format' nullable: true domain: type: string description: 'hotel domain domain of the hotel’s website' nullable: true url: type: string description: 'hotel url URL to the hotel’s website indicated in the listing' nullable: true amenities: type: array items: type: object oneOf: - $ref: '#/components/schemas/HotelAmenityInfo' nullable: true description: 'hotel amenities information about hotel amenities' nullable: true popular_amenities: type: array items: type: object oneOf: - $ref: '#/components/schemas/HotelAmenityItemInfo' nullable: true description: 'hotel amenities information about hotel amenities labelled as “popular”' nullable: true BusinessDataTripadvisorReviewsTaskPostTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: object description: 'array of results in this case, the value will be null' nullable: true BusinessDataGoogleHotelSearchesLiveResultInfo: type: object properties: keyword: type: string description: 'keyword received in a POST array keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)' 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 you 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 in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true items_count: type: integer description: 'item types the number of items in the items array' format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesItem' nullable: true description: 'array of items note: this field always equals null; use it to facilitate integration and ensure interoperability with the Hotel Info endpoint' nullable: true BusinessDataGoogleExtendedReviewsTaskGetResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleExtendedReviewsTaskGetTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataGoogleQuestionsAndAnswersTasksReadyTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTasksReadyResultInfo' nullable: true description: array of results nullable: true RatingInfo: properties: rating_type: type: string description: 'the type of rating here 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 BusinessDataGoogleReviewsTaskPostTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: object description: 'array of results in this case, the value will be null' nullable: true BusinessDataTripadvisorReviewsTaskGetTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorReviewsTaskGetResultInfo' nullable: true description: array of results nullable: true BusinessDataGoogleMyBusinessInfoLiveResultInfo: type: object properties: keyword: type: string description: 'keyword received in a POST array keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) this field will contain the cid parameter if you specified it in the keyword field when setting a task; example: cid:2946633002421908862 learn more about the parameter in this help center article' nullable: true se_domain: type: string description: search engine domain as specified in a POST array 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 you 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 in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true item_types: type: array items: type: string nullable: true description: 'item types types of search engine results encountered in the items array; possible item types: google_business_info' nullable: true items_count: type: integer description: 'item types the number of items in the items array' format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/ItemsGoogleBusinessInfo' nullable: true description: 'encountered item types types of search engine results encountered in the items array; possible item types: google_business_info' nullable: true BusinessDataTripadvisorSearchTaskGetTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorSearchTaskGetResultInfo' nullable: true description: array of results 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 the 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 information about hotel reviews by criteria' nullable: true rating_distribution: type: object additionalProperties: type: integer format: Int64 nullable: true description: 'rating distribution by votes the 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 reviews from third-paty sites' nullable: true BusinessDataGoogleLocationsCountryResultInfo: type: object properties: location_code: type: integer description: location code nullable: true location_name: type: string description: full name of the location nullable: true location_name_parent: type: string description: 'the name of the superordinate location example: "location_code": 9041134, "location_name": "Vienna International Airport,Lower Austria,Austria", "location_name_parent": "Lower Austria,Austria"' nullable: true country_iso_code: type: string description: ISO country code of the location nullable: true location_type: type: string description: location type nullable: true BusinessDataGoogleReviewsTaskGetResultInfo: type: object properties: keyword: type: string description: 'keyword received in a POST array keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)' nullable: true type: type: string description: type of element nullable: true se_domain: type: string description: search engine domain in a POST array 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 you 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 in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true title: type: string description: 'title of the ‘reviews’ element in SERP the name of the local establishment for which the reviews are collected' nullable: true sub_title: type: string description: 'subtitle of the ‘reviews’ element in SERP additional information (e.g., address) on the ‘reviews’ element for which the reviews are collected' nullable: true rating: type: object oneOf: - $ref: '#/components/schemas/RatingInfo' description: 'rating of the corresponding local establishment popularity rate based on reviews and displayed in SERP' nullable: true feature_id: type: string description: 'the unique identifier of the ‘reviews’ element in SERP learn more about the identifier in this help center article' nullable: true place_id: type: string description: 'unique identifier of a business location assigned by Google learn more about the identifier in this help center article' nullable: true cid: type: string description: 'google-defined client id unique id of a local establishment learn more about the identifier in this help center article' nullable: true reviews_count: type: integer description: the total number of reviews format: int64 nullable: true items_count: type: integer description: 'the number of reviews items in the results array you can get more results by using the depth parameter when setting a task' format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/GoogleReviewsSearch' nullable: true description: 'found reviews you can get more results by using the depth parameter when setting a task' nullable: true BusinessDataGoogleHotelInfoLiveHtmlRequestInfo: type: object properties: hotel_identifier: type: string description: 'unique hotel identifier required field unique identifier of a hotel entity in Google search; you 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 example: ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE' priority: type: integer description: 'task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page.' nullable: true location_name: type: string description: 'full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you 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 example: London,England,United Kingdom' nullable: true location_code: type: integer description: 'search engine location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations example: 2840' nullable: true location_coordinate: type: string description: 'GPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter should be specified in the “latitude,longitude” format the maximum number of decimal digits for “latitude” and “longitude”: 7 Note: if the coordinates are used to set a location, the search will occur in the nearest settlement; example: 53.476225,-2.243572' nullable: true language_name: type: string description: 'full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages example: English' nullable: true language_code: type: string description: 'search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages example: en' nullable: true check_in: type: string description: 'check-in date optional field if you don’t specify this field, tomorrow’s date will be used by default; date format: "yyyy-mm-dd" example: "2019-01-15"' nullable: true check_out: type: string description: 'check-out date optional field if you don’t specify this field, our system will apply the date of two days from now by default; date format: "yyyy-mm-dd" example: "2019-01-15"' nullable: true currency: type: string description: 'currency optional field example: "USD"' nullable: true adults: type: integer description: 'number of adults optional field if you don’t specify this field, two adults will be used by default example: 1' nullable: true children: type: array items: type: string description: 'number and age of children optional field if you don’t specify this field, no children will be included in the search; set the following value if you want to include one 14-years-old child: [14] set the following value if you want to include one 13-years-old child and one 8-years-old child: [13,8]' nullable: true tag: type: string description: 'user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data array of the response' nullable: true example: - language_code: en location_name: New York,New York,United States hotel_identifier: ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE BusinessDataTasksReadyTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTasksReadyResultInfo' nullable: true description: array of results nullable: true BusinessDataGoogleMyBusinessInfoTaskPostResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoTaskPostTaskInfo' nullable: true description: array of tasks 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 indicates the overall score of the hotel’s location in the range from 1 to 5; calculated based on data from the hotel’s proximity to nearby things to do and restaurants, transportation, and airports; note 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 the scores of the hotel’s 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 latitude coordinates of the hotel’s location example: 39.4806397' nullable: true longitude: type: number description: 'hotel longitude latitude coordinates of the hotel’s location example: -106.0512973' nullable: true location_chain: type: array items: type: object oneOf: - $ref: '#/components/schemas/LocationChain' nullable: true description: 'elements of the location chain additional parameters of each element of the location chain' nullable: true AiModeImagesElementInfo: type: object properties: type: type: string description: type of element nullable: true alt: type: string description: alt tag of the image nullable: true url: type: string description: URL link nullable: true image_url: type: string description: 'URL of the image the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available)' nullable: true BusinessDataGoogleMyBusinessInfoTaskPostTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: object description: 'array of results in this case, the value will be null' nullable: true BusinessDataGoogleHotelSearchesTaskGetTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesTaskGetResultInfo' nullable: true description: array of results nullable: true BusinessDataGoogleLocationsCountryTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleLocationsCountryResultInfo' nullable: true description: array of results nullable: true BusinessDataTrustpilotSearchTasksReadyResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTrustpilotSearchTasksReadyTaskInfo' 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 GoogleBusinessAnswerElement: type: object properties: type: type: string description: type of element nullable: true answer_id: type: string description: ID of the answer nullable: true profile_image_url: type: string description: URL of the user’s profile image nullable: true profile_url: type: string description: URL of the user’s profile nullable: true profile_name: type: string description: displayed name of the user nullable: true answer_text: type: string description: current text of the answer nullable: true original_answer_text: type: string description: original text of the answer nullable: true time_ago: type: string description: estimated time when the answer was posted nullable: true timestamp: type: string description: exact time when the answer was posted 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 USD is applied by default, unless specified in the POST array' nullable: true url: type: string description: 'url of the price offer URL to the page of the website where price offer appears' nullable: true max_visitors: type: integer description: 'the maximal number of visitors the 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 URLs of the images featured in the price offer' nullable: true free_cancellation_until: type: string description: 'date until free cancellation is available in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” equals null if free cancellation is not available for the selected dates' nullable: true description: featured price offers BusinessDataGoogleHotelInfoTaskPostRequestInfo: type: object properties: hotel_identifier: type: string description: 'unique hotel identifier required field if you don’t specify keyword if you use this field, you don’t need to specify keyword unique identifier of a hotel entity in Google search; you can obtain the value by making a request to Advanced Google SERP API (enclosed in the hotels_pack element of the response), or the Hotel Searches endpoint of Business Data API example: ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE' nullable: true keyword: type: string description: 'keyword required field if you don’t specify hotel_identifier if you use this field, you don’t need to specify hotel_identifier the keyword you specify should indicate the name of the hotel entity you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”' nullable: true priority: type: integer description: 'task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page.' nullable: true location_name: type: string description: 'full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you 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 example: London,England,United Kingdom' nullable: true location_code: type: integer description: 'search engine location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations example: 2840' nullable: true location_coordinate: type: string description: 'GPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter should be specified in the “latitude,longitude” format the maximum number of decimal digits for “latitude” and “longitude”: 7 Note: if the coordinates are used to set a location, the search will occur in the nearest settlement; example: 53.476225,-2.243572' nullable: true language_name: type: string description: 'full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages example: English' nullable: true language_code: type: string description: 'search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages example: en' nullable: true check_in: type: string description: 'check-in date optional field if you don’t specify this field, tomorrow’s date will be used by default; the value must not be earlier than today’s date date format: "yyyy-mm-dd" example: "2019-01-15"' nullable: true check_out: type: string description: 'check-out date optional field if you don’t specify this field, our system will apply the date of two days from now by default; Note: the value cannot be less than or equal to check_in; the range between check_in and check_out values cannot exceed 30 days date format: "yyyy-mm-dd" example: "2019-01-15"' nullable: true currency: type: string description: 'currency optional field example: "USD"' nullable: true adults: type: integer description: 'number of adults optional field if you don’t specify this field, two adults will be used by default example: 1' nullable: true children: type: array items: type: string description: 'number and age of children optional field if you don’t specify this field, no children will be included in the search; set the following value if you want to include one 14-years-old child: [14] set the following value if you want to include one 13-years-old child and one 8-years-old child: [13,8]' nullable: true load_prices_by_dates: type: boolean description: 'load hotel stay prices by dates optional field if you specify this parameter with true, the response will include the prices_by_dates array with hotel stay prices divided by dates if you use this parameter, you will be charged double the base price for a request' nullable: true prices_start_date: type: string description: 'start date to load prices by dates optional field to use this parameter, you must specify load_prices_by_dates with true if this parameter is not specified, the start date is set to check_in date date format: yyyy-mm-dd example: 2025-05-20' nullable: true prices_end_date: type: string description: 'end date to load prices by dates optional field to use this parameter, you must specify load_prices_by_dates with true if this parameter is not specified, you will get prices by date for the month date format: yyyy-mm-dd example: 2025-05-21' nullable: true prices_date_range: type: string description: 'predefined period for retrieving daily price data optional field to use this parameter, you must specify load_prices_by_dates with true if the prices_start_date is not specified, the start date is set to check_in date possible values: month, three_months, six_months, year default value: month' nullable: true tag: type: string description: 'user-defined task identifier optional field the character limit is 255; you can use this parameter to identify the task and match it with the result; you will find the specified tag value in the data object of the response' nullable: true postback_url: type: string description: 'URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified; you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request; example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center' nullable: true postback_data: type: string description: 'postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html' nullable: true pingback_url: type: string description: 'notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified; you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable; we will set the necessary values before sending the request; example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center' nullable: true example: - language_code: en location_name: New York,New York,United States hotel_identifier: ChYIq6SB--i6p6cpGgovbS8wN2s5ODZfEAE tag: some_string_123 postback_url: https://your-server.com/postbackscript.php postback_data: advanced BusinessDataBusinessListingsSearchLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataBusinessListingsSearchLiveTaskInfo' nullable: true description: array of tasks nullable: true ReviewResponseItemInfo: type: object properties: title: type: string description: the title of response nullable: true text: type: string description: the content of response nullable: true timestamp: type: string description: the time of publication 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 BusinessDataGoogleQuestionsAndAnswersTaskPostResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTaskPostTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataBusinessListingsCategoriesAggregationLiveResultInfo: type: object properties: total_count: type: integer description: total number of results in our database relevant to your request format: int64 nullable: true count: type: integer description: 'item types the number of items in the items array' format: int64 nullable: true offset: type: string description: offset in the results array of returned categories nullable: true offset_token: type: string description: 'token for subsequent requests by specifying the unique offset_token when setting a new task, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task' nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataBusinessListingsCategoriesAggregationLiveItem' nullable: true description: 'encountered item types types of search engine results encountered in the items array; possible item types: business_category' nullable: true PopularTimes: type: object properties: popular_times_by_days: type: object additionalProperties: type: array items: type: object oneOf: - $ref: '#/components/schemas/PopularWorkTimeInfo' description: work hours on Sundays nullable: true nullable: true description: 'popular hours information about busy hours of the local establishment on each day of the week' nullable: true BusinessDataTripadvisorReviewsTaskGetResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorReviewsTaskGetTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataBusinessListingsLocationsResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataBusinessListingsLocationsTaskInfo' nullable: true description: array of tasks nullable: true RedditReviews: type: object properties: subreddit: type: string description: the name of the subreddit nullable: true author_name: type: string description: 'nickname of the author nicknname of the user who published the post in the subreddit and shared the URL' nullable: true title: type: string description: title of the subreddit post nullable: true permalink: type: string description: URL to the subreddit post nullable: true subreddit_members: type: integer description: number of subreddit members nullable: true BusinessDataBusinessListingsCategoriesAggregationLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataBusinessListingsCategoriesAggregationLiveTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataGoogleLocationsResultInfo: type: object properties: location_code: type: integer description: location code nullable: true location_name: type: string description: full name of the location nullable: true location_name_parent: type: string description: 'the name of the superordinate location example: "location_code": 9041134, "location_name": "Vienna International Airport,Lower Austria,Austria", "location_name_parent": "Lower Austria,Austria"' nullable: true country_iso_code: type: string description: ISO country code of the location nullable: true location_type: type: string description: location type nullable: true BusinessDataGoogleHotelSearchesTaskGetResultInfo: type: object properties: keyword: type: string description: 'keyword received in a POST array keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character); in order to obtain accurate search results, the location name is appended to the keyword automatically' 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 you 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 in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true items_count: type: integer description: 'item types the number of items in the items array' format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesItem' nullable: true description: 'array of items note: this field always equals null; use it to facilitate integration and ensure interoperability with the Hotel Info endpoint' nullable: true BusinessDataGoogleHotelSearchesTasksReadyTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesTasksReadyResultInfo' nullable: true description: array of results nullable: true BusinessDataSocialMediaPinterestLiveRequestInfo: type: object properties: targets: type: array items: type: string description: 'target URLs required field target page should be specified with its absolute URL (including http:// or https://) example: https://dataforseo.com/ Note: you can specify 10 targets maximum. You will be charged per earch URL you specify in this array' tag: type: string description: 'user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response' nullable: true example: - targets: - https://www.simplyrecipes.com/recipes/grilled_salmon_with_cucumber_mango_salsa/ - https://tasty.co/recipe/classic-lasagna - https://www.allrecipes.com/recipe/255263/sicilian-roasted-chicken/ tag: some_string_123 BusinessDataTrustpilotSearchTasksReadyTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTrustpilotSearchTasksReadyResultInfo' nullable: true description: array of results nullable: true BusinessDataIdListRequestInfo: type: object properties: datetime_from: type: string description: 'start time for filtering results required field if include_metadata is set to true, maximum value: a month from current datetime; if include_metadata is set to false, maximum value: six months from current datetime; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-15 12:57:46 +00:00' datetime_to: type: string description: 'finish time for filtering results required field maximum value: current datetime; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-31 13:57:46 +00:00' limit: type: integer description: 'the maximum number of returned task IDs optional field default value: 1000 maximum value: 1000' nullable: true offset: type: integer description: 'offset in the results array of returned task IDs optional field default value: 0 if you specify the 10 value, the first ten tasks in the results array will be omitted' nullable: true sort: type: string description: 'sorting by task execution time optional field possible values: "asc", "desc" default value: "asc"' nullable: true include_metadata: type: boolean description: 'include task metadata in the respond optional field default value: false' nullable: true example: - datetime_from: '2026-04-12 04:39:39 +00:00' datetime_to: '2026-04-14 04:39:39 +00:00' limit: 100 offset: 0 sort: desc include_metadata: true BusinessDataBusinessListingsSearchLiveResultInfo: type: object properties: total_count: type: integer description: total number of results in our database relevant to your request format: int64 nullable: true count: type: integer description: 'item types the number of items in the items array' format: int64 nullable: true offset: type: integer description: offset in the results array of returned businesses format: int64 nullable: true offset_token: type: string description: 'token for subsequent requests by specifying the unique offset_token when setting a new task, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task' nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataBusinessListingsSearchLiveItem' nullable: true description: 'encountered item types types of search engine results encountered in the items array; possible item types: business_listing' nullable: true LocationChain: type: object properties: card_id: type: string description: card identifier nullable: true feature_id: type: string description: 'feature identifier learn more about the identifier in this help center article' nullable: true cid: type: string description: 'client id learn 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 BusinessDataIdListTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataIdListResultInfo' nullable: true description: array of results nullable: true BusinessDataGoogleHotelInfoLiveHtmlResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoLiveHtmlTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataTrustpilotSearchTasksReadyResultInfo: type: object properties: id: type: string description: 'task identifier of the completed task unique task identifier in our system in the UUID format' nullable: true se: type: string description: 'search engine specified when setting the task can take the following values: trustpilot' nullable: true se_type: type: string description: search engine type nullable: true date_posted: type: string description: date when the task was posted (in the UTC format) nullable: true tag: type: string description: user-defined task identifier nullable: true endpoint: type: string description: URL for collecting the results of the task 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 USD 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 in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true check_out: type: string description: 'check-out date and time in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-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 types of search engine results encountered in the items array; possible item types: hotel_search_item' nullable: true prices_by_dates: type: array items: type: object oneOf: - $ref: '#/components/schemas/PricesByDates' nullable: true nullable: true BusinessDataGoogleMyBusinessInfoTasksReadyResultInfo: type: object properties: id: type: string description: 'task identifier of the completed task unique task identifier in our system in the UUID format' nullable: true se: type: string description: 'search engine specified when setting the task can take the following values: google' nullable: true se_type: type: string description: search engine specified when setting the task nullable: true date_posted: type: string description: date when the task was posted (in the UTC format) nullable: true tag: type: string description: user-defined task identifier nullable: true endpoint: type: string description: URL for collecting the results of the task nullable: true BusinessDataTrustpilotReviewsTasksReadyResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTrustpilotReviewsTasksReadyTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataGoogleHotelInfoTasksReadyResultInfo: type: object properties: id: type: string description: 'task identifier of the completed task unique task identifier in our system in the UUID format' nullable: true se: type: string description: 'search engine specified when setting the task can take the following values: google' nullable: true se_type: type: string description: search engine specified when setting the task nullable: true date_posted: type: string description: date when the task was posted (in the UTC format) nullable: true tag: type: string description: user-defined task identifier nullable: true endpoint: type: string description: URL for collecting the results of the task nullable: true BusinessDataGoogleMyBusinessUpdatesTasksReadyResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessUpdatesTasksReadyTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataTrustpilotReviewsTaskGetTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTrustpilotReviewsTaskGetResultInfo' nullable: true description: array of results nullable: true BusinessDataTripadvisorSearchTaskGetResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorSearchTaskGetTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataGoogleLanguagesResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleLanguagesTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataGoogleExtendedReviewsTaskGetResultInfo: type: object properties: keyword: type: string description: 'keyword received in a POST array keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character)' nullable: true type: type: string description: type of element nullable: true se_domain: type: string description: search engine domain in a POST array 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 you 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 in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true title: type: string description: 'title of the ‘reviews’ element in SERP the name of the local establishment for which the reviews are collected' nullable: true sub_title: type: string description: 'subtitle of the ‘reviews’ element in SERP additional information (e.g., address) on the ‘reviews’ element for which the reviews are collected' nullable: true rating: type: object oneOf: - $ref: '#/components/schemas/RatingInfo' description: 'rating of the corresponding local establishment popularity rate based on reviews and displayed in SERP' nullable: true feature_id: type: string description: 'the unique identifier of the ‘reviews’ element in SERP learn more about the identifier in this help center article' nullable: true place_id: type: string description: 'unique identifier of a business location assigned by Google learn more about the identifier in this help center article' nullable: true cid: type: string description: 'google-defined client id unique id of a local establishment learn more about the identifier in this help center article' nullable: true reviews_count: type: integer description: the total number of reviews format: int64 nullable: true items_count: type: integer description: 'the number of reviews items in the results array you can get more results by using the depth parameter when setting a task' format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/GoogleExtendedReviewsSearch' nullable: true description: 'found reviews you can get more results by using the depth parameter when setting a task' nullable: true BusinessDataGoogleReviewsTaskPostRequestInfo: type: object properties: keyword: type: string description: 'keyword required field if you don’t specify cid or place_id the keyword you specify should indicate the name of the local establishment; you can specify up to 700 characters in the keyword filed; all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; if this field contains such parameters as ‘allinanchor:’, ‘allintext:’, ‘allintitle:’, ‘allinurl:’, ‘define:’, ‘filetype:’, ‘id:’, ‘inanchor:’, ‘info:’, ‘intext:’, ‘intitle:’, ‘inurl:’, ‘link:’, ‘related:’, ‘site:’, the charge per task will be multiplied by 5 Note: queries containing the ‘cache:’ parameter are not supported and will return a validation error learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article' nullable: true cid: type: string description: 'unique, google-defined id of the business entity required field if you don’t specify keyword or place_id example: 194604053573767737 learn more about the identifier in this help center article' nullable: true place_id: type: string description: 'identifier of the business entity in Google Maps required field if you don’t specify keyword or cid example: GhIJQWDl0CIeQUARxks3icF8U8A learn more about the identifier in this help center article' nullable: true priority: type: integer description: 'task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page.' nullable: true location_name: type: string description: 'full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available locations with location_name by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations example: London,England,United Kingdom' nullable: true location_code: type: integer description: 'search engine location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations example: 2840' nullable: true location_coordinate: type: string description: 'GPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter should be specified in the “latitude,longitude,radius” format the maximum number of decimal digits for “latitude” and “longitude”: 7 the minimum value for “radius”: 199.9 example: 53.476225,-2.243572,200' nullable: true language_name: type: string description: 'full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to the https://api.dataforseo.com/v3/business_data/google/languages example: English' nullable: true language_code: type: string description: 'search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/languages example: en' nullable: true depth: type: integer description: 'parsing depth optional field number of reviews in SERP we strongly recommend setting the parsing depth in the multiples of ten, because our systems processes ten reviews in a row default value: 10 maximum value: 4490 Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page.' nullable: true sort_by: type: string description: 'results sorting parameters optional field you can use this field to sort the results possible types of sorting: newest – sort by newest first highest_rating – sort by highest rating lowest_rating – sort by lowest rating relevant – sort by relevance default value: relevant' nullable: true tag: type: string description: 'user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response' nullable: true postback_url: type: string description: 'URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center' nullable: true pingback_url: type: string description: 'notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center' nullable: true example: - location_name: London,England,United Kingdom language_name: English keyword: hedonism wines depth: 50 sort_by: highest_rating BusinessWorkHoursInfo: type: object properties: work_hours: type: object oneOf: - $ref: '#/components/schemas/WorkHours' description: 'open hours information about work hours of the local establishment' nullable: true BusinessDataBusinessListingsSearchLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataBusinessListingsSearchLiveResultInfo' nullable: true description: array of results nullable: true AddressInfo: type: object properties: borough: type: string description: administrative unit or district the local establishment belongs to nullable: true address: type: string description: street address of the local establishment nullable: true city: type: string description: name of the city where the local establishment is located nullable: true zip: type: string description: ZIP code of the local establishment nullable: true region: type: string description: DMA region the local establishment belongs to nullable: true country_code: type: string description: ISO country code of the local establishment nullable: true BusinessDataTripadvisorLocationsResultInfo: type: object properties: location_code: type: integer description: location code nullable: true location_name: type: string description: full name of the location nullable: true location_name_parent: type: string description: 'the name of the superordinate location example: "location_code": 9041134, "location_name": "Vienna International Airport,Lower Austria,Austria", "location_name_parent": "Lower Austria,Austria"' nullable: true country_iso_code: type: string description: ISO country code of the location nullable: true location_type: type: string description: location type nullable: true BusinessDataTripadvisorReviewsTaskGetResultInfo: type: object properties: url_path: type: string description: URL path received in a POST array nullable: true type: type: string description: type of element nullable: true se_domain: type: string description: search engine domain in a POST array nullable: true check_url: type: string description: 'direct URL to search engine results you 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 in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true title: type: string description: 'title of the ‘reviews’ element in SERP the name of the local establishment for which the reviews are collected' nullable: true location: type: string description: 'location of the local establishment address of the local establishment for which the reviews are collected' nullable: true reviews_count: type: integer description: the total number of reviews format: int64 nullable: true rating: type: object oneOf: - $ref: '#/components/schemas/RatingInfo' description: 'rating of the corresponding local establishment popularity rate based on reviews and displayed in SERP' nullable: true rating_distribution: type: object additionalProperties: type: integer format: Int64 nullable: true description: 'rating distribution by votes the distribution of votes across the rating in the range from 1 to 5' nullable: true items_count: type: integer description: 'the number of reviews items in the results array you can get more results by using the depth parameter when setting a task' format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/TripadvisorReviewSearch' nullable: true description: 'found reviews you can get more results by using the depth parameter when setting a task' nullable: true language_code: type: string description: language code in a POST array nullable: true BusinessDataGoogleHotelSearchesTaskPostResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesTaskPostTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataGoogleHotelInfoTaskPostTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: object description: 'array of results in this case, the value will be null' nullable: true BusinessDataGoogleReviewsTaskGetResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleReviewsTaskGetTaskInfo' nullable: true description: array of tasks nullable: true LinkElement: type: object properties: type: type: string description: type of element nullable: true title: type: string description: title of a given link element nullable: true snippet: type: string description: text alongside the link title nullable: true description: type: string description: description of the results element nullable: true url: type: string description: URL nullable: true domain: type: string description: domain where a link points nullable: true xpath: type: string description: the XPath of the element nullable: true BusinessDataBusinessListingsCategoriesAggregationLiveItem: type: object properties: type: type: string description: type of element nullable: true categories: type: array items: type: string nullable: true description: 'business categories Google My Business general category that best describes the cluster of related categories' nullable: true aggregation: type: object oneOf: - $ref: '#/components/schemas/BusinessListingAggregationInfo' properties: top_categories: type: object additionalProperties: type: integer format: int64 nullable: true nullable: true top_countries: type: object additionalProperties: type: integer format: int64 nullable: true nullable: true top_attributes: type: object additionalProperties: type: integer format: int64 nullable: true nullable: true top_place_topics: type: object additionalProperties: type: integer format: int64 nullable: true nullable: true description: aggregation of the category nullable: true GoogleExtendedReviewsSearch: type: object properties: type: type: string description: type of element nullable: true rank_group: type: integer description: 'position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group' nullable: true rank_absolute: type: integer description: 'absolute rank among all the listed reviews absolute position among all reviews on the list' nullable: true position: type: string description: 'the alignment of the review in SERP can take the following values: right' nullable: true xpath: type: string description: the XPath of the review nullable: true review_text: type: string description: the content of the review nullable: true original_review_text: type: string description: 'original content of the review the original content of the review, no auto-translate applied' nullable: true time_ago: type: string description: 'the time of publication indicates the time (in the ‘time ago’ format) when the review was listed' nullable: true timestamp: type: string description: 'date and time when a review was published in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true rating: type: object oneOf: - $ref: '#/components/schemas/RatingInfo' description: the rating score submitted by the reviewer nullable: true reviews_count: type: integer description: total number of reviews submitted by the reviewer format: int64 nullable: true photos_count: type: integer description: total number of photos submitted by the reviewer format: int64 nullable: true local_guide: type: boolean description: indicates whether the reviewer has a ‘local guide’ status nullable: true profile_name: type: string description: profile name of the reviewer nullable: true profile_url: type: string description: URL of the reviewer’s profile nullable: true review_url: type: string description: the URL of the review nullable: true profile_image_url: type: string description: URL of the reviewer’s profile image nullable: true owner_answer: type: string description: 'text of the owner’s response the owner’s response to the review' nullable: true original_owner_answer: type: string description: 'original text of the owner’s response the original response to the review, no auto-translate applied' nullable: true owner_time_ago: type: string description: 'publication time indicates the time (in the ‘time ago’ format) when the owner submitted the response to the review' nullable: true owner_timestamp: type: string description: 'date and time of the owner’s reply to the review in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true review_id: type: string description: 'the unique identifier of a review on Google example: ChZDSUhNMG9nS0VJQ0FnSUMxbHFyMFlnEAE' nullable: true images: type: array items: type: object oneOf: - $ref: '#/components/schemas/AiModeImagesElementInfo' nullable: true description: images submitted by the reviewer nullable: true review_highlights: type: array items: type: object oneOf: - $ref: '#/components/schemas/ReviewHighlights' nullable: true description: 'review highlights contains highlighted review criteria and assessments' nullable: true source: type: object oneOf: - $ref: '#/components/schemas/Source' description: 'source of the review contains information about the source where the review was posted' nullable: true BusinessDataGoogleMyBusinessInfoTasksReadyResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleMyBusinessInfoTasksReadyTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataBusinessListingsCategoriesResultInfo: type: object properties: category_name: type: string description: full name of the category nullable: true business_count: type: integer description: number of businesses in the category format: int64 nullable: true HtmlItemInfo: type: object properties: page: type: integer description: serial number of the returned HTML page nullable: true date: type: string description: 'date and time when the HTML page was scanned in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true html: type: string description: HTML page nullable: true BusinessDataGoogleHotelSearchesTasksReadyResultInfo: type: object properties: id: type: string description: 'task identifier of the completed task unique task identifier in our system in the UUID format' nullable: true se: type: string description: 'search engine specified when setting the task can take the following values: google' nullable: true se_type: type: string description: search engine type nullable: true date_posted: type: string description: date when the task was posted (in the UTC format) nullable: true tag: type: string description: user-defined task identifier nullable: true endpoint: type: string description: URL for collecting the results of the task 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 BusinessDataTrustpilotSearchTaskPostTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: object description: 'array of results in this case, the value will be null' nullable: true BusinessDataSocialMediaPinterestLiveResultInfo: type: object properties: type: type: string description: type of element nullable: true page_url: type: string description: 'URL of the page the data is provided for corresponding URL you specified in the targets array when setting a task' nullable: true pins_count: type: integer description: 'number of pins for the related page_url pins on Pinterest correspond to content saves; this field shows the number of content saves made from the related page_url using the Pinterest Save Button' format: int64 nullable: true BusinessDataGoogleHotelSearchesItem: type: object properties: type: type: string description: type of element nullable: true hotel_identifier: type: string description: 'unique identifier of a hotel entity in Google search example: CgoI-KWyzenM_MV3EAE' nullable: true title: type: string description: title of the hotel nullable: true stars: type: integer description: 'hotel class rating class rating that ranges between 1-5 stars' nullable: true is_paid: type: boolean description: 'indicates a paid hotel listing if true, related hotel_search_item is a paid ad if false, related hotel_search_item is an organic hotel listing' nullable: true location: type: object oneOf: - $ref: '#/components/schemas/GpsCoordinatesLocationInfo' description: GPS coordinates of the hotel’s location nullable: true reviews: type: object oneOf: - $ref: '#/components/schemas/HotelReviewInfo' description: hotel reviews and rating information nullable: true overview_images: type: array items: type: string nullable: true description: featured images for a hotel nullable: true prices: type: object oneOf: - $ref: '#/components/schemas/HotelPriceInfo' description: hotel price nullable: true BusinessDataBusinessListingsCategoriesAggregationLiveRequestInfo: type: object properties: categories: type: array items: type: string description: 'business categories optional field the categories you specify are used to search for business listings; if you don’t use this field, we will return business listings found in the specified location; you can specify up to 10 categories' nullable: true description: type: string description: 'description of the element in SERP optional field the description of the business entity for which the results are collected; can contain up to 200 characters' nullable: true title: type: string description: 'title of the element in SERP optional field the name of the business entity for which the results are collected; can contain up to 200 characters' nullable: true is_claimed: type: boolean description: 'indicates whether the business is verified by its owner on Google Maps optional field' nullable: true location_coordinate: type: string description: 'GPS coordinates of a location optional field location_coordinate parameter should be specified in the “latitude,longitude,radius” format the maximum number of decimal digits for “latitude” and “longitude”: 7 the minimum value for “radius”: 1 the maximum value for “radius”: 100000 example: 53.476225,-2.243572,200' nullable: true initial_dataset_filters: type: array items: type: object nullable: true description: 'array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, <, <=, >, >=, =, <>, in, not_in, like, not_like, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: ["rating.value",">",3] you can receive the list of available filters by making a separate request to https://api.dataforseo.com/v3/business_data/business_listings/available_filters The full list of possible filters is available here.' nullable: true internal_list_limit: type: integer description: 'maximum number of elements within internal arrays optional field you can use this field to limit the number of elements within the aggregated categories default value: 10' nullable: true limit: type: integer description: 'the maximum number of returned businesses optional field default value: 100 maximum value: 1000' nullable: true offset: type: integer description: 'the maximum number of returned businesses optional field' nullable: true tag: type: string description: 'user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response' nullable: true example: - categories: - pizza_restaurant description: pizza title: pizza is_claimed: true location_coordinate: 53.476225,-2.243572,10 initial_dataset_filters: - - rating.value - '>' - 3 limit: 3 BusinessDataGoogleReviewsTaskPostResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleReviewsTaskPostTaskInfo' nullable: true description: array of tasks nullable: true Source: type: object properties: title: type: string description: name of the source where the review was posted nullable: true image: type: string description: featured image of the source nullable: true domain: type: string description: domain of the source where the review was posted nullable: true BusinessDataTrustpilotSearchTaskGetResultInfo: type: object properties: keyword: type: string description: keyword in a POST array nullable: true se_domain: type: string description: search engine domain in a POST array nullable: true check_url: type: string description: 'direct URL to search engine results you 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 in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true items_count: type: integer description: 'the number of items in the results array you can get more results by using the depth parameter when setting a task' format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/TrustpilotSearchOrganic' nullable: true description: 'found reviews you can get more results by using the depth parameter when setting a task' nullable: true BusinessDataTasksReadyResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTasksReadyTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataGoogleHotelInfoTasksReadyResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelInfoTasksReadyTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataGoogleHotelInfoTaskGetHtmlResultInfo: type: object properties: keyword: type: string nullable: true type: type: string description: type of element nullable: true se_domain: type: string 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 datetime: type: string description: 'date and time when the result was received in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true items_count: type: integer description: the number of results returned in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/HtmlItemInfo' nullable: true description: HTML pages nullable: true OtherSitesReviewsInfo: type: object properties: title: type: string description: 'review title contains a name of the third-party site where review initially appeared' nullable: true url: type: string description: 'review url URL to the a third-party site where review initially appeared' nullable: true review_text: type: string description: 'review text text of the review' nullable: true rating: type: object oneOf: - $ref: '#/components/schemas/RatingInfo' description: 'rating in the review information about the rating enclosed in the review on a third-party site' nullable: true BusinessDataGoogleHotelSearchesTasksReadyResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesTasksReadyTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataTripadvisorLocationsCountryResultInfo: type: object properties: location_code: type: integer description: location code nullable: true location_name: type: string description: full name of the location nullable: true location_name_parent: type: string description: 'the name of the superordinate location example: "location_code": 9041134, "location_name": "Vienna International Airport,Lower Austria,Austria", "location_name_parent": "Lower Austria,Austria"' nullable: true country_iso_code: type: string description: ISO country code of the location nullable: true location_type: type: string description: location type nullable: true BaseResponseInfo: properties: version: type: string description: the current version of the API nullable: true status_code: type: integer description: 'general status code you can find the full list of the response codes here' nullable: true status_message: type: string description: 'general informational message you 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 BusinessDataGoogleHotelSearchesLiveResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleHotelSearchesLiveTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataContactInfo: type: object properties: type: type: string description: type of element nullable: true value: type: string description: "contact displayed in SERP \nexample:\n\"+119797979736\"" nullable: true source: type: string description: data source nullable: true BusinessDataGoogleMyBusinessUpdatesTaskPostTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: object description: 'array of results in this case, the value will be null' nullable: true BusinessDataGoogleQuestionsAndAnswersLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: object description: array of results nullable: true BusinessDataBusinessListingsCategoriesTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataBusinessListingsCategoriesResultInfo' nullable: true description: array of results nullable: true BusinessDataGoogleQuestionsAndAnswersTaskGetResultInfo: type: object properties: keyword: type: string description: 'keyword received in a POST array keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) this field will contain the cid parameter if you specified it in the keyword field when setting a task; example: cid:2946633002421908862 learn more about the parameter in this help center article' nullable: true se_domain: type: string description: search engine domain as specified in a POST array 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 you 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 in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true cid: type: string description: 'google-defined client id unique id of a local establishment; learn more about the identifier in this help center article' nullable: true feature_id: type: string description: unique identifier of the SERP feature nullable: true item_types: type: array items: type: string nullable: true description: 'item types types of search engine results encountered in the items array; possible item types: google_business_question_item' nullable: true items_without_answers: type: array items: type: object oneOf: - $ref: '#/components/schemas/GoogleBusinessQuestionItem' nullable: true description: array of google business question items without answers nullable: true items_count: type: integer description: the number of items in the items array format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/GoogleBusinessQuestionItem' nullable: true description: 'array of items within google_business_question_item contains answers to the google business questions; the maximum number of answers returned for each question: 5 possible item types google_business_answer_element' nullable: true BusinessDataGoogleQuestionsAndAnswersTasksReadyResponseInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseInfo' - type: object properties: tasks: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleQuestionsAndAnswersTasksReadyTaskInfo' nullable: true description: array of tasks nullable: true BusinessDataGoogleMyBusinessUpdatesTaskGetResultInfo: type: object properties: keyword: type: string description: 'keyword received in a POST array keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) this field will contain the cid parameter if you specified it in the keyword field when setting a task; example: cid:2946633002421908862 learn more about the parameter in this help center article' nullable: true se_domain: type: string description: search engine domain as specified in a POST array 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 you 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 in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00' nullable: true business_updates_id: type: string description: identifier of the business updates element in SERP nullable: true cid: type: string description: 'google-defined client id unique id of a local establishment learn more about the cid identifier in this help center article' nullable: true feature_id: type: string description: 'the unique identifier of the element in SERP learn more about the identifier in this help center article' nullable: true item_types: type: array items: type: string nullable: true description: 'item types types of search engine results encountered in the items array; possible item types: google_business_post' nullable: true items_count: type: integer description: 'item types the number of items in the items array' format: int64 nullable: true items: type: array items: type: object oneOf: - $ref: '#/components/schemas/GoogleBusinessPost' nullable: true description: 'encountered item types types of search engine results encountered in the items array; possible item types: google_business_post' nullable: true BusinessListingAggregationInfo: type: object properties: top_categories: type: object additionalProperties: type: integer format: int64 nullable: true description: 'the most mentioned related categories top categories displayed with the number of businesses in each category' nullable: true top_countries: type: object additionalProperties: type: integer format: int64 nullable: true description: 'the most mentioned counties country codes with the biggest number of businesses in the category' nullable: true websites_count: type: integer description: number of unique websites format: int64 nullable: true count: type: integer description: number of unique entities format: int64 nullable: true top_attributes: type: object additionalProperties: type: integer format: int64 nullable: true description: 'the most mentioned service details service details of a business entity displayed in a form of checks and the number of entities mentioning each attribute' nullable: true top_place_topics: type: object additionalProperties: type: integer format: int64 nullable: true description: 'top keywords mentioned in customer reviews contains most popular keywords related to products/services mentioned in customer reviews of a business entity and the number of reviews mentioning each keyword' nullable: true BusinessDataTripadvisorLocationsCountryTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataTripadvisorLocationsCountryResultInfo' nullable: true description: array of results nullable: true BusinessDataGoogleExtendedReviewsTasksReadyTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataGoogleExtendedReviewsTasksReadyResultInfo' nullable: true description: array of results nullable: true BusinessDataSocialMediaPinterestLiveTaskInfo: type: object allOf: - $ref: '#/components/schemas/BaseResponseTaskInfo' - type: object properties: result: type: array items: type: object oneOf: - $ref: '#/components/schemas/BusinessDataSocialMediaPinterestLiveResultInfo' nullable: true description: array of results nullable: true BusinessDataGoogleHotelSearchesTaskPostRequestInfo: type: object properties: keyword: type: string description: 'keyword optional field the keyword you specify is used to search for the list of hotels; if you don’t use this field, we will return the list of hotels found in a specified location; you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; Note: in order to obtain accurate search results, the location name is appended to the keyword automatically learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article' nullable: true priority: type: integer description: 'task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page.' nullable: true location_name: type: string description: 'full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you 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 example: London,England,United Kingdom Note: in order to obtain accurate search results, the location_name you specify will be automatically appended to the keyword' nullable: true location_code: type: integer description: 'search engine location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available locations with location_code by making a separate request to the https://api.dataforseo.com/v3/business_data/google/locations example: 2840' nullable: true location_coordinate: type: string description: 'GPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter should be specified in the “latitude,longitude” format the maximum number of decimal digits for “latitude” and “longitude”: 7 Note: if the coordinates are used to set a location, the search will occur in the nearest settlement; example: 53.476225,-2.243572' nullable: true search_this_area: type: boolean description: 'show hotels from the displayed area optional field can take the values: true, false default value: true if set to false the search_this_area mode will be turned off Note: if the search_this_area mode is turned off, the location_name won’t be appended to the keyword during search learn more about this parameter on our Help Center' nullable: true language_name: type: string description: 'full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with language_name by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages example: English' nullable: true language_code: type: string description: 'search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code by making a separate request to https://api.dataforseo.com/v3/business_data/google/languages example: en' nullable: true depth: type: integer description: 'parsing depth optional field number of results in Google Hotels default value: 20 organic results max value: 140 Note: your account will be billed per each 20 organic results regardless of paid listings in the response; thus, setting a depth above 20 may result in additional charges if Google Hotels return more than 20 results; if the specified depth is higher than the number of results in the response, the difference will be refunded automatically to your account balance' nullable: true check_in: type: string description: 'check-in date optional field if you don’t specify this field, tomorrow’s date will be used by default; date format: "yyyy-mm-dd" example: "2019-01-15" Note: the value cannot precede the today’s date' nullable: true check_out: type: string description: 'check-out date optional field if you don’t specify this field, our system will apply the date of two days from now by default; date format: "yyyy-mm-dd" example: "2019-01-15" Note: the value cannot be less than or equal to check_in; the range between check_in and check_out values cannot exceed 30 days' nullable: true currency: type: string description: 'currency optional field example: "USD"' nullable: true adults: type: integer description: 'number of adults optional field if you don’t specify this field, the default value of 2 will be applied; note that you can specify up to 6 persons including both adults and children example: 1' nullable: true children: type: array items: type: string description: 'number and age of children optional field if you don’t specify this field, no children will be included in the search; age of child can be from 0 to 17; note that you can specify up to 6 persons including both adults and children set the following value if you want to include one 14-year-old child: [14] set the following value if you want to include one 13-year-old child and one 8-year-old child: [13,8]' nullable: true stars: type: array items: type: string description: 'hotel stars optional field set this field to [5] if you want to get the list of 5-star hotels only example: [3,4,5]' nullable: true min_rating: type: number description: 'minimum rating optional field you can use this field to specify guest rating higher than a certain value example: 2.5' nullable: true sort_by: type: string description: 'results sorting parameters optional field you can use this field to sort the results possible types of sorting: relevance – sort by most relevant lowest_price – sort by the lowest price highest_rating – sort by highest rating most_reviewed – sort by most reviewed default value: relevance' nullable: true min_price: type: integer description: 'minimum price per night optional field the currency of this value depends on the currency field example: 100' nullable: true max_price: type: integer description: 'maximum price per night optional field the currency of this value depends on the currency field example: 600' nullable: true free_cancellation: type: boolean description: 'hotels with a free cancellation optional field set this field to true if you want to get the list of hotels with free cancellation of reservations default value: false' nullable: true is_vacation_rentals: type: boolean description: 'search for vacation rentals optional field set this field to true if you want to get the list of vacation rentals instead of hotels default value: false' nullable: true amenities: type: array items: type: string description: "hotel amenities\noptional field\nyou can use this field to specify different hotel amenities\nexample:\n [\n \"free_parking\",\n \"pets_allowed\"\n ]\n\npossible values:\n\"air_conditioning\",\n\"all_inclusive_available\",\n\"bar\",\n\"free_breakfast\",\n\"fitness_center\",\n\"kid_friendly\",\n\"free_parking\",\n\"pets_allowed\",\n\"pool\",\n\"restaurant\",\n\"room_service\",\n\"spa\",\n\"free_wifi\",\n\"parking\",\n\"indoor_pool\",\n\"outdoor_pool\",\n\"wheelchair_accessible\",\n\"beach_access\"" nullable: true tag: type: string description: 'user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response' nullable: true postback_url: type: string description: 'URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center' nullable: true pingback_url: type: string description: 'notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center' nullable: true example: - language_code: en location_name: New York,New York,United States keyword: cheap hotel check_in: '2026-05-15' check_out: '2026-05-16' currency: USD adults: 2 children: - 14 sort_by: highest_rating priority: 2 tag: example securitySchemes: basicAuth: type: http scheme: basic