データ API / DataForSEO / Business Data

Live Business Listings Search Tasks

Searches DataForSEO's own index of local business listings by categories, description, title and location_coordinate - a latitude, longitude and radius triple. Returns total_count, count, offset, offset_token and items, paged with the token. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. This reads an index and answers immediately; everything else here queues a live scrape of the source. Start with this and drill in only where it matters.

パラメータ

パス・クエリ・ヘッダーのパラメータはありません。

リクエストボディ

categoriesstring[]任意
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
descriptionstring任意
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
titlestring任意
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
is_claimedboolean任意
indicates whether the business is verified by its owner on Google Maps optional field
location_coordinatestring任意
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
filtersarray任意
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
order_bystring[]任意
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"]
limitinteger任意
the maximum number of returned businesses optional field default value: 100 maximum value: 1000
offsetinteger任意
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
offset_tokenstring任意
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
tagstring任意
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

リクエスト例

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/business_data/business_listings/search/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "categories": [
    "<string>"
  ],
  "description": "<string>",
  "title": "<string>",
  "is_claimed": false,
  "location_coordinate": "<string>",
  "filters": "<string>",
  "order_by": [
    "<string>"
  ],
  "limit": 0
}'

レスポンス

レスポンスのフィールド

versionstring任意
the current version of the API
status_codeinteger任意
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
status_messagestring任意
general informational message you can find the full list of general informational messages here
timestring任意
execution time, seconds
costnumber任意
total tasks cost, USD
tasks_countinteger任意
*the number of tasks in the tasksarray*
tasks_errorinteger任意
*the number of tasks in the tasks array returned with an error*
tasksstring[]任意
array of tasks
idstring任意
unique task identifier in our system in the Universally unique identifier (UUID) format
status_codeinteger任意
status code of the task generated by DataForSEO; can be within the following range: 10000-60000
status_messagestring任意
informational message of the task
timestring任意
execution time, seconds
costnumber任意
cost of the task, USD
result_countinteger任意
number of elements in the result array
pathstring[]任意
URL path
dataobject任意
contains the same parameters that you specified in the POST request
resultstring[]任意
array of results
total_countinteger任意
total number of results in our database relevant to your request
countinteger任意
item types the number of items in the items array
offsetinteger任意
offset in the results array of returned businesses
offset_tokenstring任意
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
itemsstring[]任意
encountered item types types of search engine results encountered in the items array; possible item types: business_listing
typestring任意
*type of element = ‘business\_listing’*
titlestring任意
title of the element in SERP the name of the business entity for which the results are collected
original_titlestring任意
original title of the element original title not translated by Google
descriptionstring任意
description of the element in SERP the description of the business entity for which the results are collected
categorystring任意
business category Google My Business general category that best describes the services provided by the business entity
category_idsstring[]任意
global category IDs universal category IDs that do not change based on the selected country
additional_categoriesstring[]任意
additional business categories additional Google My Business categories that describe the services provided by the business entity in more detail
cidstring任意
google-defined client id unique id of a local establishment learn more about the identifier in this help center article
feature_idstring任意
the unique identifier of the element in SERP learn more about the identifier in this help center article
addressstring任意
street address of the business entity
address_infoobject任意
object containing address components of the business entity
boroughstring任意
administrative unit or district the business entity location belongs to
citystring任意
name of the city where the business entity is located
zipstring任意
ZIP code of the business entity
regionstring任意
DMA region of the business entity location
country_codestring任意
ISO country code of the business entity location
place_idstring任意
unique place identifier place id of the local establishment featured in the element learn more about the identifier in this help center article
phonestring任意
phone number of the business entity
urlstring任意
absolute url of the business entity
domainstring任意
domain of the business entity
logostring任意
URL of the logo featured in Google My Business profile
main_imagestring任意
URL of the main image featured in Google My Business profile
total_photosinteger任意
total count of images featured in Google My Business profile
snippetstring任意
additional information on the business entity
latitudenumber任意
latitude coordinate of the local establishments in google maps example: "latitude": 51.584091
longitudenumber任意
longitude coordinate of the local establishment in google maps example: "longitude": -0.31365919999999997
is_claimedboolean任意
shows whether the entity is verified by its owner on Google Maps
attributesobject任意
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
available_attributesobject任意
available attributes indicates attributes a business entity can offer
unavailable_attributesobject任意
unavailable attributes indicates attributes a business entity cannot offer
place_topicsobject任意
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 example: "place_topics": {"egg roll": 48,"birthday": 33}
ratingobject任意
the element’s rating the popularity rate based on reviews and displayed in SERP
rating_typestring任意
the type of rating here you can find the following elements: Max5, Percents, CustomMax
valueinteger任意
the value of the rating
votes_countinteger任意
the amount of feedback
rating_maxinteger任意
the maximum value for a rating_type
hotel_ratinginteger任意
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
price_levelstring任意
property price level can take values: inexpensive, moderate, expensive, very_expensive if there is no price level information, the value will be null
rating_distributionobject任意
the distribution of ratings of the business entity the object displays the number of 1-star to 5-star ratings, as reviewed by users
1integer任意
the number of 1-star ratings
2integer任意
the number of 2-star ratings
3integer任意
the number of 3-star ratings
4integer任意
the number of 4-star ratings
5integer任意
the number of 5-star ratings
people_also_searchstring[]任意
related business entities
work_timeobject任意
work time details information related to operational hours of the business entity
work_hoursobject任意
open hours information about work hours of the local establishment
timetableobject任意
work hours timetable
sundaystring[]任意
work hours on Sunday can take values of the corresponding days of the week
openobject任意
opening time
hourinteger任意
hours in the 24-hour format
minuteinteger任意
minutes
closeobject任意
closing time
current_statusstring任意
current status of the establishment possible values: open, close, temporarily_closed, closed_forever
popular_timesobject任意
popular times information related to busy hours of the business entity
popular_times_by_daysobject任意
popular hours information about busy hours of the local establishment on each day of the week
sundaystring[]任意
busy hours on Sunday can take values of the corresponding days of the week
timeobject任意
busy hours
hourinteger任意
hours in a 24-hour format
minuteinteger任意
minutes
popular_indexinteger任意
popularity index relative time-bound popularity index measured from 0 to 100; higher value corresponds to a busier time of a day
local_business_linksstring[]任意
available interactions with the business list of options to interact with the business directly from search results
typestring任意
type of element possible values: "reservation""order""delivery_services_element""menu"
titlestring任意
title of the element domain of the reservation software
urlstring任意
URL to the services
contact_infostring[]任意
available contacts of the business list of contacts to interact with the business
typestring任意
type of contact element
valuestring任意
contact displayed in SERP example: "+119797979736"
sourcestring任意
data source
check_urlstring任意
direct URL to search engine results you can use it to make sure that we provided accurate results
last_updated_timestring任意
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
first_seenstring任意
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