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.
Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-access
# Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
login="login"
password="password"
cred="$(printf ${login}:${password} | base64)"
curl --location --request POST "https://api.dataforseo.com/v3/business_data/google/my_business_info/live"
--header "Authorization: Basic ${cred}"
--header "Content-Type: application/json"
--data-raw "[
{
"language_code": "en",
"location_name": "New York,New York,United States",
"keyword": "RustyBrick, Inc."
}
]"
<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
$client = new RestClient($api_url, null, 'login', 'password');
$post_array = array();
// example #1 - a simple way to set a task
// this way requires you to specify a location, a language of search, and a keyword.
$post_array[] = array(
"location_code" => 1023191,
"language_code" => "en",
"keyword" => mb_convert_encoding("RustyBrick, Inc.", "UTF-8")
);
// example #2 - a way to set a task with additional parameters
// after a task is completed, we will send a GET request to the address you specify. Instead of $id and $tag, you will receive actual values that are relevant to this task.
$post_array[] = array(
"location_name" => "New York,New York,United States",
"language_name" => "English",
"keyword" => mb_convert_encoding("RustyBrick, Inc.", "UTF-8"),
"tag" => "some_string_123",
);
// this example has a 2 elements, but in the case of large number of tasks - send up to 100 elements per POST request
if (count($post_array) > 0) {
try {
// POST /v3/business_data/google/my_business_info/live
$result = $client->post('/v3/business_data/google/my_business_info/live', $post_array);
print_r($result);
// do something with post result
} catch (RestClientException $e) {
echo "n";
print "HTTP code: {$e->getHttpCode()}n";
print "Error code: {$e->getCode()}n";
print "Message: {$e->getMessage()}n";
print $e->getTraceAsString();
echo "n";
}
}
$client = null;
?>
from client import RestClient
# You can download this file from here https://cdn.dataforseo.com/v3/examples/python/python_Client.zip
client = RestClient("login", "password")
post_data = dict()
# simple way to set a task
post_data[len(post_data)] = dict(
location_code=1023191,
language_code="en",
keyword="RustyBrick, Inc."
)
# POST /v3/business_data/google/my_business_info/live
response = client.post("/v3/business_data/google/my_business_info/live", post_data)
# you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if response["status_code"] == 20000:
print(response)
# do something with result
else:
print("error. Code: %d Message: %s" % (response["status_code"], response["status_message"]))
using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
namespace DataForSeoDemos
{
public static partial class Demos
{
public static async Task business_data_info_live()
{
var httpClient = new HttpClient
{
BaseAddress = new Uri("https://api.dataforseo.com/"),
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-access
DefaultRequestHeaders = { Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes("login:password"))) }
};
var postData = new List<object>();
// example #1 - a simple way to set a task
// this way requires you to specify a location, a language of search, and a keyword.
postData.Add(new
{
language_code = "en",
location_code = 1023191,
keyword = "RustyBrick, Inc."
});
// POST /v3/business_data/google/my_business_info/live
var taskPostResponse = await httpClient.PostAsync("/v3/business_data/google/my_business_info/live", new StringContent(JsonConvert.SerializeObject(postData)));
var result = JsonConvert.DeserializeObject(await taskPostResponse.Content.ReadAsStringAsync());
// you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if (result.status_code == 20000)
{
// do something with result
Console.WriteLine(result);
}
else
Console.WriteLine($"error. Code: {result.status_code} Message: {result.status_message}");
}
}
}
The above command returns JSON structured like this:
All POST data should be sent in the JSON format (UTF-8 encoding). Task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array. You can send up to 2000 API calls per minute, with each POST call containing no more than 100 tasks. If your POST call contains over 100 tasks, the tasks over this limit will return the 40006 error.
Below you will find a detailed description of the fields you can use for setting a task.
Description of the fields for setting a task:
Field name
Type
Description
keyword
string
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 the following parameters: cid – a unique, google-defined id of the business entity; place_id – an identifier of the business entity in Google Maps; spp – a unique identifier of local services featured in the local_pack element of Google SERP
learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article
location_name
string
full name of search engine location required field if you don’t specifylocation_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
location_code
integer
search engine location code required field if you don’t specifylocation_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
location_coordinate
string
GPS coordinates of a location required field if you don’t specifylocation_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
language_name
string
full name of search engine language required field if you don’t specifylanguage_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
language_code
string
search engine language code required field if you don’t specifylanguage_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
tag
string
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
As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.
Description of the fields in the results array:
Field name
Type
Description
version
string
the current version of the API
status_code
integer
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_message
string
general informational message
you can find the full list of general informational messages here
time
string
execution time, seconds
cost
float
total tasks cost, USD
tasks_count
integer
the number of tasks in the tasks array
tasks_error
integer
the number of tasks in the tasks array that were returned an error
tasks
array
array of tasks
id
string
task identifier unique task identifier in our system in the UUID format
status_code
integer
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
status_message
string
informational message of the task
you can find the full list of general informational messages here
time
string
execution time, seconds
cost
float
cost of the task, USD
result_count
integer
number of elements in the result array
path
array
URL path
data
object
contains the same parameters that you specified in the POST request
result
array
array of results
keyword
string
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
se_domain
string
search engine domain as specified in a POST array
location_code
integer
location code in a POST array
language_code
string
language code in a POST array
check_url
string
direct URL to search engine results
you can use it to make sure that we provided accurate results
datetime
string
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
item_types
array
item types
types of search engine results encountered in the items array;
possible item types: google_business_info
items_count
integer
item types
the number of items in the items array
items
array
encountered item types
types of search engine results encountered in the items array;
possible item types: google_business_info
type
string
type of element = ‘google_business_info’
rank_group
integer
position within a group of elements with identical type values
positions of elements with different type values are omitted from rank_group
rank_absolute
integer
absolute rank among all the elements
position
string
the alignment in SERP
title
string
title of the element in SERP
the name of the business entity for which the results are collected
description
string
description of the element in SERP
the description of the business entity for which the results are collected
category
string
business category
Google My Business general category that best describes the services provided by the business entity
category_ids
array
global category IDs
universal category IDs that do not change based on the selected country
additional_categories
array
additional business categories
additional Google My Business categories that describe the services provided by the business entity in more detail
cid
string
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
feature_id
string
the unique identifier of the element in SERP
learn more about the identifier in this help center article
address
string
address of the business entity
address_info
object
object containing address components of the business entity
borough
string
administrative unit or district the business entity location belongs to
address
string
street address of the business entity
city
string
name of the city where the business entity is located
zip
string
ZIP code of the business entity
region
string
DMA region of the business entity location
country_code
string
ISO country code of the business entity location
place_id
string
unique place identifier place id of the local establishment featured in the element
learn more about the identifier in this help center article
phone
string
phone number of the business entity
url
string
absolute url of the business entity
contact_url
string
URL of the preferred contact page
contributor_url
string
URL of the user’s or entity’s Local Guides profile, if available
book_online_url
string
URL in the ‘book online’ button of the element
URL directing users to the online booking or order page of the business entity
domain
string
domain of the business entity
logo
string
URL of the logo featured in Google My Business profile
main_image
string
URL of the main image featured in Google My Business profile
total_photos
integer
total count of images featured in Google My Business profile
snippet
string
additional information on the business entity
latitude
float
latitude coordinate of the local establishments in google maps
example: "latitude": 51.584091
longitude
float
longitude coordinate of the local establishment in google maps
example: "longitude": -0.31365919999999997
is_claimed
boolean
shows whether the entity is verified by its owner on Google Maps
attributes
object
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_attributes
object
available attributes
indicates attributes a business entity can offer
unavailable_attributes
object
unavailable attributes
indicates attributes a business entity cannot offer
place_topics
object
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
}
rating
object
the element’s rating
the popularity rate based on reviews and displayed in SERP
rating_type
string
the type of rating
here you can find the following elements: Max5, Percents, CustomMax
value
integer
the value of the rating
votes_count
integer
the amount of feedback
rating_max
integer
the maximum value for a rating_type
rating_distribution
object
the distribution of ratings of the business entity
the object displays the number of 1-star to 5-star ratings, as reviewed by users
1
integer
the number of 1-star ratings
2
integer
the number of 2-star ratings
3
integer
the number of 3-star ratings
4
integer
the number of 4-star ratings
5
integer
the number of 5-star ratings
people_also_search
array
related business entities
cid
string
google-defined client id
unique id of a local establishment
learn more about the identifier in this help center article
feature_id
string
the unique identifier of the element in SERP
learn more about the identifier in this help center article
title
string
title of the element in SERP
the name of the business entity for which the results are collected
rating
object
the element’s rating
the popularity rate based on reviews and displayed in SERP
rating_type
string
the type of rating
here you can find the following elements: Max5, Percents, CustomMax
value
integer
the value of the rating
votes_count
integer
the amount of feedback
rating_max
integer
the maximum value for a rating_type
work_time
object
work time details
information related to operational hours of the business entity
work_hours
object
open hours
information about work hours of the local establishment
timetable
object
work hours timetable
sunday
array
work hours on Sundays
open
object
opening time
hour
integer
hours in the 24-hour format
minute
integer
minutes
close
object
closing time
hour
integer
hours in the 24-hour format
minute
integer
minutes
monday
array
work hours on Mondays
open
object
opening time
hour
integer
hours in the 24-hour format
minute
integer
minutes
close
object
closing time
hour
integer
hours in the 24-hour format
minute
integer
minutes
tuesday
array
work hours on Tuesdays
open
object
opening time
hour
integer
hours in the 24-hour format
minute
integer
minutes
close
object
closing time
hour
integer
hours in the 24-hour format
minute
integer
minutes
wednesday
array
work hours on Wednesdays
open
object
opening time
hour
integer
hours in the 24-hour format
minute
integer
minutes
close
object
closing time
hour
integer
hours in the 24-hour format
minute
integer
minutes
thursday
array
work hours on Thursdays
open
object
opening time
hour
integer
hours in the 24-hour format
minute
integer
minutes
close
object
closing time
hour
integer
hours in the 24-hour format
minute
integer
minutes
friday
array
work hours on Fridays
open
object
opening time
hour
integer
hours in the 24-hour format
minute
integer
minutes
close
object
closing time
hour
integer
hours in the 24-hour format
minute
integer
minutes
saturday
array
work hours on Saturday
open
object
opening time
hour
integer
hours in the 24-hour format
minute
integer
minutes
close
object
closing time
hour
integer
hours in the 24-hour format
minute
integer
minutes
current_status
string
current status of the establishment
possible values: opened, closed, temporarily_closed, closed_forever
popular_times
object
popular times
information related to busy hours of the business entity
popular_times_by_days
object
popular hours
information about busy hours of the local establishment on each day of the week
sunday
array
busy hours on sunday can take values of the corresponding days of the week
time
object
busy hours
hour
integer
hours in a 24-hour format
minute
integer
minutes
popular_index
integer
popularity index
relative time-bound popularity index measured from 0 to 100;
higher value corresponds to a busier time of a day
local_business_links
array
available interactions with the business
list of options to interact with the business directly from search results
type
string
type of element = ‘reservation’
title
string
title of the element
domain of the reservation software
url
string
URL to make a reservation
type
string
type of element = ‘order’
delivery_services
array
lists available delivery services
type
string
type of element = ‘delivery_services_element’
title
string
title of the element
domain of the online food ordering system
url
string
URL to place an order
type
string
type of element = ‘menu’
title
string
title of the element
domain of the online menu system
url
string
URL to view the menu
is_directory_item
boolean
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
directory
array
items of the directory
includes information about businesses that are located within the target business establishment and have the same address
title
string
directory title
can take the following values: At this place, Directory
items
array
array of directory items
type
string
type of element = ‘maps_search’
rank_group
integer
position within a group of elements with identical type values
positions of elements with different type values are omitted from the rank_group
rank_absolute
integer
absolute rank among all the elements
domain
string
domain of the business entity
title
string
title of the element in SERP
the name of the business entity
url
string
absolute url of the business entity
rating
object
the element’s rating
the popularity rate based on reviews and displayed in SERP
rating_type
string
the type of rating
here you can find the following elements: Max5, Percents, CustomMax
value
integer
the value of the rating
votes_count
integer
the amount of feedback
rating_max
integer
the maximum value for a rating_type
rating_distribution
object
the distribution of ratings of the business entity
the object displays the number of 1-star to 5-star ratings, as reviewed by users
1
integer
the number of 1-star ratings
2
integer
the number of 2-star ratings
3
integer
the number of 3-star ratings
4
integer
the number of 4-star ratings
5
integer
the number of 5-star ratings
snippet
string
additional information about the business entity
address
string
address of the business entity
address_info
object
object containing address components of the business entity
borough
string
administrative unit or district the business entity location belongs to
address
string
street address of the business entity
city
string
name of the city where the business entity is located
zip
string
ZIP code of the business entity
region
string
DMA region of the business entity location
country_code
string
ISO country code of the business entity location
place_id
string
unique place identifier place id of the local establishment featured in the element
learn more about the identifier in this help center article
phone
string
phone number of the business entity
main_image
string
URL of the main image featured in Google My Business profile
total_photos
integer
total count of images featured in Google My Business profile
category
string
business category
Google My Business general category that best describes the services provided by the business entity
category_ids
array
global category IDs
universal category IDs that do not change based on the selected country
work_hours
object
work hours
information about work hours of the local establishment
feature_id
string
the unique identifier of the element in SERP
learn more about the identifier in this help center article
cid
string
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
latitude
float
latitude coordinate of the local establishments in google maps
example: "latitude": 51.584091
longitude
float
longitude coordinate of the local establishment in google maps
example: "longitude": -0.31365919999999997
is_claimed
boolean
shows whether the entity is verified by its owner on Google Maps
local_justifications
array
Google local justifications
snippets of text that “justify” why the business is showing up for search query
is_directory_item
boolean
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
price_level
string
property price level
can take values: inexpensive, moderate, expensive, very_expensive
if there is no price level information, the value will be null
hotel_rating
integer
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_level
string
property price level
can take values: inexpensive, moderate, expensive, very_expensive
if there is no price level information, the value will be null
hotel_rating
integer
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