DataForSEO: Business Data Business Listings Search Live

Search Google Maps business listings by category and location.

Tool ID: dataforseo_business_data_business_listings_search_live

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'dataforseo_business_data_business_listings_search_live',
  {
    "categories": [
      {}
    ],
    "description": "Example description",
    "title": "VP of Engineering"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute dataforseo_business_data_business_listings_search_live --input '{
  "categories": [
    {}
  ],
  "description": "Example description",
  "title": "VP of Engineering"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "version": "example",
  "status_code": 123,
  "status_message": "example",
  "time": "example",
  "tasks_count": 123,
  "tasks_error": 123,
  "tasks": [
    {}
  ]
}

Use deepline describe dataforseo_business_data_business_listings_search_live --json for the latest machine-readable contract.

Input reference

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.

Name	Type	Required	Default	Details
`payload.categories`	`array`	No	—	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
`payload.description`	`string`	No	—	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
`payload.title`	`string`	No	—	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
`payload.is_claimed`	`boolean`	No	—	indicates whether the business is verified by its owner on Google Maps optional field
`payload.location_coordinate`	`string`	No	—	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
`payload.filters`	`array`	No	—	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 See the live schema for the complete constraint.
`payload.order_by`	`array`	No	—	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: See the live schema for the complete constraint.
`payload.limit`	`integer`	No	—	the maximum number of returned businesses optional field default value: 100 maximum value: 1000
`payload.offset`	`integer`	No	—	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
`payload.offset_token`	`string`	No	—	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 See the live schema for the complete constraint.
`payload.tag`	`string`	No	—	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

Output reference

Top-level response envelope for dataforseo_business_data_business_listings_search_live.

Name	Type	Required	Default	Details
`result.version`	`string`	Yes	—	the current version of the API
`result.status_code`	`integer`	Yes	—	general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
`result.status_message`	`string`	Yes	—	general informational message you can find the full list of general informational messages here
`result.time`	`string`	Yes	—	execution time, seconds
`result.tasks_count`	`integer`	Yes	—	the number of tasks in the tasks array
`result.tasks_error`	`integer`	Yes	—	the number of tasks in the tasks array returned with an error
`result.tasks`	`array`	Yes	—	array of tasks

Deepline cost

Pricing model: provider_usage (provider usage).
Estimated Deepline credits: 0.01 per pricing unit.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation