This endpoint will provide you with data on businesses listed on the Yelp platform. The results obtained through this endpoint are specific to the location (see the List of Yelp Locations) and keyword parameters used in the POST request.
The returned results are specific to the indicated business identifier or keyword, as well as location and language parameters. 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.
Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard
# Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
login="login"
password="password"
cred="$(printf ${login}:${password} | base64)"
id="04011058-0696-0199-0000-2196151a15cb"
curl --location --request GET "https://api.dataforseo.com/v3/business_data/yelp/search/task_get/${id}"
--header "Authorization: Basic ${cred}"
--header "Content-Type: application/json"
<?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-dashboard
$client = new RestClient($api_url, null, 'login', 'password');
try {
$result = array();
// #1 - using this method you can get a list of completed tasks
// GET /v3/business_data/yelp/search/tasks_ready
$tasks_ready = $client->get('/v3/business_data/yelp/search/tasks_ready');
// you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if (isset($tasks_ready['status_code']) AND $tasks_ready['status_code'] === 20000) {
foreach ($tasks_ready['tasks'] as $task) {
if (isset($task['result'])) {
foreach ($task['result'] as $task_ready) {
// #2 - using this method you can get results of each completed task
// GET /v3/business_data/yelp/search/task_get/$id
if (isset($task_ready['endpoint'])) {
$result[] = $client->get($task_ready['endpoint']);
}
// #3 - another way to get the task results by id
// GET /v3/business_data/yelp/search/task_get/$id
/*
if (isset($task_ready['id'])) {
$result[] = $client->get('/v3/business_data/yelp/search/task_get/' . $task_ready['id']);
}
*/
}
}
}
}
print_r($result);
// do something with 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")
# 1 - using this method you can get a list of completed tasks
# GET /v3/business_data/yelp/search/tasks_ready
response = client.get("/v3/business_data/yelp/search/tasks_ready")
# you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if response['status_code'] == 20000:
results = []
for task in response['tasks']:
if (task['result'] and (len(task['result']) > 0)):
for resultTaskInfo in task['result']:
# 2 - using this method you can get results of each completed task
# GET /v3/business_data/yelp/search/task_get/$id
if(resultTaskInfo['endpoint']):
results.append(client.get(resultTaskInfo['endpoint']))
'''
# 3 - another way to get the task results by id
# GET /v3/business_data/yelp/search/task_get/$id
if(resultTaskInfo['id']):
results.append(client.get("/v3/business_data/yelp/search/task_get/" + resultTaskInfo['id']))
'''
print(results)
# 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_yelp_reviews_task_get()
{
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-dashboard
DefaultRequestHeaders = { Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes("login:password"))) }
};
// #1 - using this method you can get a list of completed tasks
// GET /v3/business_data/yelp/search/tasks_ready
var response = await httpClient.GetAsync("/v3/business_data/yelp/search/tasks_ready");
var tasksInfo = JsonConvert.DeserializeObject<<dynamic>>(await response.Content.ReadAsStringAsync());
var tasksResponses = new List<<object>>();
// you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if (tasksInfo.status_code == 20000)
{
if (tasksInfo.tasks != null)
{
foreach (var tasks in tasksInfo.tasks)
{
if (tasks.result != null)
{
foreach (var task in tasks.result)
{
if (task.endpoint != null)
{
// #2 - using this method you can get results of each completed task
// GET /v3/business_data/yelp/search/task_get/$id
var taskGetResponse = await httpClient.GetAsync((string)task.endpoint);
var taskResultObj = JsonConvert.DeserializeObject<<dynamic>>(await taskGetResponse.Content.ReadAsStringAsync());
if (taskResultObj.tasks != null)
{
var fst = taskResultObj.tasks.First;
// you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if (fst.status_code >= 40000 || fst.result == null)
Console.WriteLine($"error. Code: {fst.status_code} Message: {fst.status_message}");
else
tasksResponses.Add(fst.result);
}
// #3 - another way to get the task results by id
// GET /v3/business_data/yelp/search/task_get//$id
/*
var tasksGetResponse = await httpClient.GetAsync("/v3/business_data/yelp/search/task_get/" + (string)task.id);
var taskResultObj = JsonConvert.DeserializeObject<<dynamic>>(await tasksGetResponse.Content.ReadAsStringAsync());
if (taskResultObj.tasks != null)
{
var fst = taskResultObj.tasks.First;
// you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
if (fst.status_code >= 40000 || fst.result == null)
Console.WriteLine($"error. Code: {fst.status_code} Message: {fst.status_message}");
else
tasksResponses.Add(fst.result);
}
*/
}
}
}
}
}
if (tasksResponses.Count > 0)
// do something with result
Console.WriteLine(String.Join(Environment.NewLine, tasksResponses));
else
Console.WriteLine("No completed tasks");
}
else
Console.WriteLine($"error. Code: {tasksInfo.status_code} Message: {tasksInfo.status_message}");
}
}
}
The above command returns JSON structured like this:
{
"version": "0.1.20210907",
"status_code": 20000,
"status_message": "Ok.",
"time": "0.0637 sec.",
"cost": 0,
"tasks_count": 1,
"tasks_error": 0,
"tasks": [
{
"id": "09131615-1535-0338-0000-a57678b3eed6",
"status_code": 20000,
"status_message": "Ok.",
"time": "0.0183 sec.",
"cost": 0,
"result_count": 1,
"path": [
"v3",
"business_data",
"yelp",
"search",
"task_get",
"09131615-1535-0338-0000-a57678b3eed6"
],
"data": {
"se_type": "organic",
"se": "yelp",
"api": "business_data",
"function": "search",
"location_name": "Richmond,Virginia,United States",
"language_name": "English",
"keyword": "restaurant",
"depth": 10,
"device": "desktop",
"os": "windows"
},
"result": [
{
"keyword": "restaurant",
"se_domain": "yelp.com",
"location_code": 1027270,
"language_code": "en",
"check_url": "https://www.yelp.com/search?find_desc=restaurant&find_loc=Richmond%2CVA%2CUnited%20States&rl=en&sortby=recommended",
"datetime": "2021-09-13 13:15:47 +00:00",
"item_types": [
"yelp_search_paid",
"yelp_search_organic"
],
"se_results_count": 240,
"items_count": 13,
"items": [
{
"type": "yelp_search_paid",
"rank_group": 1,
"rank_absolute": 1,
"yelp_business_id": "IKkWMa53eB4gwywDCmPLSg",
"business_url": "https://www.yelp.com/biz/first-watch-richmond-13",
"alias": "first-watch-richmond-13",
"name": "First Watch",
"description": "I've eaten here a few times back to back over the past few weeks. The level of service really depends on who's working. However if you go in the afternoon on a day when Travis ( I…",
"location": {
"address_lines": [
"5310 W Broad St",
"Richmond, VA 23230"
],
"latitude": 37.5868081,
"longitude": -77.4990097
},
"price_range": null,
"phone": "(804) 613-3309",
"is_guaranteed": false,
"rating": {
"rating_type": "Max5",
"value": 4,
"votes_count": 38,
"rating_max": null
},
"categories": [
"American (Traditional)",
"Cafes",
"Coffee & Tea"
],
"photos": [
"https://s3-media0.fl.yelpcdn.com/bphoto/EW7jVnoOVLjqkDUF9IvO_g/1000s.jpg"
],
"tags": null,
"business_highlights": null,
"service_offerings": [
{
"type": "service_offerings_element",
"name": "Outdoor dining",
"is_available": true
},
{
"type": "service_offerings_element",
"name": "Delivery",
"is_available": true
},
{
"type": "service_offerings_element",
"name": "Takeout",
"is_available": true
}
]
},
{
"type": "yelp_search_paid",
"rank_group": 2,
"rank_absolute": 2,
"yelp_business_id": "2kKULu3rkQ4Vc-j2CJS-Bg",
"business_url": "https://www.yelp.com/biz/the-patio-thai-richmond",
"alias": "the-patio-thai-richmond",
"name": "The Patio Thai",
"description": "Went there for dinner & called ahead to let them know that we were celebrating our daughter's birthday. At first we were a bit disappointed as we were seated next to an occupied…",
"location": {
"address_lines": [
"103 E Cary St",
"Richmond, VA 23219"
],
"latitude": 37.5413652,
"longitude": -77.4442686
},
"price_range": null,
"phone": "(804) 447-4615",
"is_guaranteed": false,
"rating": {
"rating_type": "Max5",
"value": 4.5,
"votes_count": 173,
"rating_max": null
},
"categories": [
"Thai"
],
"photos": [
"https://s3-media0.fl.yelpcdn.com/bphoto/Yjm5wK46W8kWUX9KSE0cxg/1000s.jpg"
],
"tags": [
"Make an Online Reservation"
],
"business_highlights": null,
"service_offerings": [
{
"type": "service_offerings_element",
"name": "Outdoor dining",
"is_available": true
},
{
"type": "service_offerings_element",
"name": "Delivery",
"is_available": true
},
{
"type": "service_offerings_element",
"name": "Takeout",
"is_available": true
}
]
},
{
"type": "yelp_search_organic",
"rank_group": 1,
"rank_absolute": 3,
"yelp_business_id": "Y3MXJBGKjg7neqTE0XHNgQ",
"business_url": "https://www.yelp.com/biz/the-broken-tulip-richmond?osq=restaurant",
"alias": "the-broken-tulip-richmond",
"name": "The Broken Tulip",
"description": "Oh broken tulip, I love you so. From your incredible wine selection featuring small producers from around the world, your seasonal menu, supporting small…",
"location": {
"address_lines": [
"3129 W Cary St",
"Richmond, VA 23221"
],
"latitude": 37.5532695,
"longitude": -77.4815048
},
"price_range": null,
"phone": "(804) 353-4020",
"is_guaranteed": false,
"rating": {
"rating_type": "Max5",
"value": 4.5,
"votes_count": 49,
"rating_max": null
},
"categories": [
"American (New)"
],
"photos": [
"https://s3-media0.fl.yelpcdn.com/bphoto/odD1PcydDzChQOjsBna32A/1000s.jpg"
],
"tags": null,
"business_highlights": null,
"service_offerings": [
{
"type": "service_offerings_element",
"name": "Outdoor dining",
"is_available": false
},
{
"type": "service_offerings_element",
"name": "Delivery",
"is_available": true
},
{
"type": "service_offerings_element",
"name": "Takeout",
"is_available": true
}
]
},
{
"type": "yelp_search_organic",
"rank_group": 2,
"rank_absolute": 4,
"yelp_business_id": "ZOg0pxLuq9RoG8nXm4Bv1g",
"business_url": "https://www.yelp.com/biz/pinky-s-richmond?osq=restaurant",
"alias": "pinky-s-richmond",
"name": "Pinky’s",
"description": "The green palm tree leaves danced to the rhythms of \"Whatever Lola Wants,\" the cool breeze wafting, on a bright summer's eve.. And that was inside Mr. RVA's…",
"location": {
"address_lines": [
"3015 Norfolk St",
"Richmond, VA 23230"
],
"latitude": 37.5683849,
"longitude": -77.46902519999999
},
"price_range": 2,
"phone": "(804) 802-4716",
"is_guaranteed": false,
"rating": {
"rating_type": "Max5",
"value": 4.5,
"votes_count": 25,
"rating_max": null
},
"categories": [
"Mediterranean"
],
"photos": [
"https://s3-media0.fl.yelpcdn.com/bphoto/sHzI-nYynW8dK1dihu6t3g/1000s.jpg"
],
"tags": [
"Opened 7 weeks ago"
],
"business_highlights": null,
"service_offerings": [
{
"type": "service_offerings_element",
"name": "Outdoor dining",
"is_available": true
},
{
"type": "service_offerings_element",
"name": "Takeout",
"is_available": true
}
]
},
{
"type": "yelp_search_organic",
"rank_group": 3,
"rank_absolute": 5,
"yelp_business_id": "fMCZg2fC1-2B567zyAmccA",
"business_url": "https://www.yelp.com/biz/stellas-richmond?osq=restaurant",
"alias": "stellas-richmond",
"name": "Stella’s",
"description": "I believe, she is one of the best restaurants in the US. Food, dim lit ambiance, atmosphere and customer service *chef's kiss*. Walked in on a Fri night with…",
"location": {
"address_lines": [
"1012 Lafayette St",
"Richmond, VA 23221"
],
"latitude": 37.5674579,
"longitude": -77.4864864
},
"price_range": 2,
"phone": "(804) 358-2011",
"is_guaranteed": false,
"rating": {
"rating_type": "Max5",
"value": 4.5,
"votes_count": 770,
"rating_max": null
},
"categories": [
"Mediterranean",
"Greek",
"Cocktail Bars"
],
"photos": [
"https://s3-media0.fl.yelpcdn.com/bphoto/zTVXWtKjlWVg-NrFrmUuxg/1000s.jpg"
],
"tags": null,
"business_highlights": null,
"service_offerings": null
},
{
"type": "yelp_search_organic",
"rank_group": 4,
"rank_absolute": 6,
"yelp_business_id": "NitfsAz3sgLFHg-xdtx6Rw",
"business_url": "https://www.yelp.com/biz/lunch-or-supper-richmond?osq=restaurant",
"alias": "lunch-or-supper-richmond",
"name": "Lunch Or Supper",
"description": "This restaurant is underrated! I would 100% recommend for date night, BRUNCH, solo lunch, and/ or birthday dinners! \n\nThe portion sizes are outstanding and…",
"location": {
"address_lines": [
"1213-1215 Summit Ave",
"Richmond, VA 23230"
],
"latitude": 37.5654977,
"longitude": -77.4731325
},
"price_range": 2,
"phone": "(804) 353-0111",
"is_guaranteed": false,
"rating": {
"rating_type": "Max5",
"value": 4.5,
"votes_count": 1726,
"rating_max": null
},
"categories": [
"American (New)",
"Breakfast & Brunch",
"Southern"
],
"photos": [
"https://s3-media0.fl.yelpcdn.com/bphoto/OzjzFTEqiEcSsNTbrafXKQ/1000s.jpg"
],
"tags": null,
"business_highlights": null,
"service_offerings": [
{
"type": "service_offerings_element",
"name": "Outdoor dining",
"is_available": true
},
{
"type": "service_offerings_element",
"name": "Delivery",
"is_available": false
},
{
"type": "service_offerings_element",
"name": "Takeout",
"is_available": true
}
]
},
{
"type": "yelp_search_organic",
"rank_group": 5,
"rank_absolute": 7,
"yelp_business_id": "G226_BI0o-HJk0UfJeK_KA",
"business_url": "https://www.yelp.com/biz/lillie-pearl-richmond?osq=restaurant",
"alias": "lillie-pearl-richmond",
"name": "Lillie Pearl",
"description": "I came to Lillie Pearl on a date night with my partner during the week. The restaurant was packed with customers and now I see why. \n\nParking consists of…",
"location": {
"address_lines": [
"416 E Grace St",
"Richmond, VA 23219"
],
"latitude": 37.542541,
"longitude": -77.43843
},
"price_range": 2,
"phone": "(804) 412-8724",
"is_guaranteed": false,
"rating": {
"rating_type": "Max5",
"value": 4.5,
"votes_count": 150,
"rating_max": null
},
"categories": [
"Southern",
"American (New)",
"Cocktail Bars"
],
"photos": [
"https://s3-media0.fl.yelpcdn.com/bphoto/YeFUWOnXy7maxDaFyxEzNA/1000s.jpg"
],
"tags": null,
"business_highlights": null,
"service_offerings": [
{
"type": "service_offerings_element",
"name": "Outdoor dining",
"is_available": true
},
{
"type": "service_offerings_element",
"name": "Delivery",
"is_available": true
},
{
"type": "service_offerings_element",
"name": "Takeout",
"is_available": true
}
]
},
{
"type": "yelp_search_organic",
"rank_group": 6,
"rank_absolute": 8,
"yelp_business_id": "sPaAUfAibt1ctKivxt8ieQ",
"business_url": "https://www.yelp.com/biz/lucky-af-richmond?osq=restaurant",
"alias": "lucky-af-richmond",
"name": "Lucky AF",
"description": "This might be my third week in a row here at Lucky AF... anyway I would like to say I'm happy and satisfied for the quality of the food and especially the…",
"location": {
"address_lines": [
"3103 West Leigh St",
"Richmond, VA 23220"
],
"latitude": 37.5673551,
"longitude": -77.4713642
},
"price_range": 2,
"phone": "(804) 905-9888",
"is_guaranteed": false,
"rating": {
"rating_type": "Max5",
"value": 4.5,
"votes_count": 131,
"rating_max": null
},
"categories": [
"Asian Fusion",
"Sushi Bars",
"Pan Asian"
],
"photos": [
"https://s3-media0.fl.yelpcdn.com/bphoto/bw_IpEvkuzI25rAybc_hzw/1000s.jpg"
],
"tags": null,
"business_highlights": null,
"service_offerings": [
{
"type": "service_offerings_element",
"name": "Outdoor dining",
"is_available": true
},
{
"type": "service_offerings_element",
"name": "Delivery",
"is_available": true
},
{
"type": "service_offerings_element",
"name": "Takeout",
"is_available": true
}
]
},
{
"type": "yelp_search_organic",
"rank_group": 7,
"rank_absolute": 9,
"yelp_business_id": "Mp1JZqfvzw-BSR81Pcbw3Q",
"business_url": "https://www.yelp.com/biz/y-tu-mama-richmond?osq=restaurant",
"alias": "y-tu-mama-richmond",
"name": "Y Tu Mama",
"description": "This spot never ceases to amaze me, the quesadillas are the best ones I have ever had. The sweet and savory of the pineapple and guajillo chicken go perfectly…",
"location": {
"address_lines": [
"4910 Forest Hill Ave",
"Richmond, VA 23225"
],
"latitude": 37.521588,
"longitude": -77.48978
},
"price_range": null,
"phone": "(804) 533-6700",
"is_guaranteed": false,
"rating": {
"rating_type": "Max5",
"value": 4.5,
"votes_count": 32,
"rating_max": null
},
"categories": [
"Mexican"
],
"photos": [
"https://s3-media0.fl.yelpcdn.com/bphoto/STVqw3R5XhWyimrVYZaumQ/1000s.jpg"
],
"tags": null,
"business_highlights": null,
"service_offerings": [
{
"type": "service_offerings_element",
"name": "Outdoor dining",
"is_available": true
},
{
"type": "service_offerings_element",
"name": "Takeout",
"is_available": true
}
]
},
{
"type": "yelp_search_organic",
"rank_group": 8,
"rank_absolute": 10,
"yelp_business_id": "i9nzaAu33hRWrnl3qIX55w",
"business_url": "https://www.yelp.com/biz/secret-sandwich-society-richmond?osq=restaurant",
"alias": "secret-sandwich-society-richmond",
"name": "Secret Sandwich Society",
"description": "Wow you know you have come to an awesome place when you see \"Ssshhh\" as neon lights right on the front.\n\nI had to come try this spot based off all the raving…",
"location": {
"address_lines": [
"501 E Grace St",
"Richmond, VA 23219"
],
"latitude": 37.5417709350586,
"longitude": -77.4382553100586
},
"price_range": 2,
"phone": "(804) 644-4777",
"is_guaranteed": false,
"rating": {
"rating_type": "Max5",
"value": 4.5,
"votes_count": 1068,
"rating_max": null
},
"categories": [
"Burgers",
"Sandwiches",
"Cocktail Bars"
],
"photos": [
"https://s3-media0.fl.yelpcdn.com/bphoto/6jq9qbzZ4g-bb0CtA5aloQ/1000s.jpg"
],
"tags": null,
"business_highlights": null,
"service_offerings": [
{
"type": "service_offerings_element",
"name": "Outdoor dining",
"is_available": true
},
{
"type": "service_offerings_element",
"name": "Delivery",
"is_available": true
},
{
"type": "service_offerings_element",
"name": "Takeout",
"is_available": true
}
]
},
{
"type": "yelp_search_organic",
"rank_group": 9,
"rank_absolute": 11,
"yelp_business_id": "hRXtIpCwnWzMr0DD8Wjeug",
"business_url": "https://www.yelp.com/biz/perch-richmond?osq=restaurant",
"alias": "perch-richmond",
"name": "Perch",
"description": "We had stumbled in here for dinner after 8 hours on the road, and were more than pleasantly surprised. We sat at the bar and were directed to the \"secret bar…",
"location": {
"address_lines": [
"2918 W Broad St",
"Richmond, VA 23230"
],
"latitude": 37.5640539,
"longitude": -77.4719183
},
"price_range": null,
"phone": "(804) 669-3344",
"is_guaranteed": false,
"rating": {
"rating_type": "Max5",
"value": 4.5,
"votes_count": 193,
"rating_max": null
},
"categories": [
"American (New)"
],
"photos": [
"https://s3-media0.fl.yelpcdn.com/bphoto/4U3lAuDT7qt69S1dl8QjUw/1000s.jpg"
],
"tags": null,
"business_highlights": null,
"service_offerings": [
{
"type": "service_offerings_element",
"name": "Outdoor dining",
"is_available": true
},
{
"type": "service_offerings_element",
"name": "Delivery",
"is_available": true
},
{
"type": "service_offerings_element",
"name": "Takeout",
"is_available": true
}
]
},
{
"type": "yelp_search_organic",
"rank_group": 10,
"rank_absolute": 12,
"yelp_business_id": "Ic3ImCI0KvOCwrZVDtkLFQ",
"business_url": "https://www.yelp.com/biz/shagbark-richmond-2?osq=restaurant",
"alias": "shagbark-richmond-2",
"name": "Shagbark",
"description": "Shagbark was recommended to us because we like Longoven. Solid experience. Portions larger than expected. I ordered the salmon . Perfectly crispy skin, tomato…",
"location": {
"address_lines": [
"4901 Libbie Mill E Blvd",
"Richmond, VA 23230"
],
"latitude": 37.5907255643733,
"longitude": -77.4937755171201
},
"price_range": 3,
"phone": "(804) 358-7424",
"is_guaranteed": false,
"rating": {
"rating_type": "Max5",
"value": 4.5,
"votes_count": 326,
"rating_max": null
},
"categories": [
"American (New)"
],
"photos": [
"https://s3-media0.fl.yelpcdn.com/bphoto/aNv9Z6kPvufETrubScQg_Q/1000s.jpg"
],
"tags": null,
"business_highlights": null,
"service_offerings": [
{
"type": "service_offerings_element",
"name": "Outdoor dining",
"is_available": true
},
{
"type": "service_offerings_element",
"name": "Delivery",
"is_available": false
},
{
"type": "service_offerings_element",
"name": "Takeout",
"is_available": true
}
]
},
{
"type": "yelp_search_paid",
"rank_group": 3,
"rank_absolute": 13,
"yelp_business_id": "ljjOQ-vHhTIzgU0jO6bKsw",
"business_url": "https://www.yelp.com/biz/lemaire-restaurant-richmond",
"alias": "lemaire-restaurant-richmond",
"name": "Lemaire Restaurant",
"description": "First, let's start with the bad- we were told by the hostess that they were super busy today but if we went to the back that we would find seating. We obviously were able to see that…",
"location": {
"address_lines": [
"101 W Franklin St",
"Richmond, VA 23220"
],
"latitude": 37.5442364,
"longitude": -77.4454155
},
"price_range": null,
"phone": "(804) 649-4629",
"is_guaranteed": false,
"rating": {
"rating_type": "Max5",
"value": 4.5,
"votes_count": 263,
"rating_max": null
},
"categories": [
"American (New)"
],
"photos": [
"https://s3-media0.fl.yelpcdn.com/bphoto/Md057jU7ODqLEyJjLfcV7A/1000s.jpg"
],
"tags": null,
"business_highlights": null,
"service_offerings": [
{
"type": "service_offerings_element",
"name": "Outdoor dining",
"is_available": true
},
{
"type": "service_offerings_element",
"name": "Delivery",
"is_available": false
},
{
"type": "service_offerings_element",
"name": "Takeout",
"is_available": true
}
]
}
]
}
]
}
]
}
Description of the fields for sending a request:
Field name
Type
Description
id
string
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
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
this field will contain the alias parameter if it was specified in a POST array
alias
string
Yelp business identifier
displayed only if the request contained the corresponding field
se_domain
string
search engine domain in a POST array
location_code
string
location code in a POST array
if location_code was not specified in a POST array, the value equals null
language_code
string
language code in a POST array
check_url
string
direct URL to Yelp 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 encountered in the result
possible item types: yelp_search_organic, yelp_search_paid
se_results_count
integer
the total number of results
items_count
integer
the number of items in the results array
you can get more results by using the depth parameter when setting a task
items
array
Yelp search listing results
you can get more results by using the depth parameter when setting a task
type
string
type of Yelp search result
possible types: yelp_search_organic, yelp_search_paid Note: all types have identical fields and structure
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 listed results
absolute position among all reviews on the list
yelp_business_id
string
the unique identifier of a business identity on Yelp
example: 2sWZ17vpEF2vuM_7ic721w
business_url
string
link to the Yelp profile of the business entity
alias
string
link to the Yelp profile of the business entity
unique business identifier on Yelp;
you can use this identifier in Yelp Reviews to get Yelp reviews of the listed business
name
string
name of the business entity
description
string
description containing the featured review
location
object
information about the location of the business entity
address_lines
array
business address
contains few address lines specified by the business entity
latitude
string
latitude in GPS coordinates
longitude
string
longitude in GPS coordinates
price_range
integer
price range of the business entity
indicates the number of currency signs next to the business listing corresponding to its price score
phone
string
contact phone number
example: (804) 342-1981
is_guaranteed
boolean
Yelp guaranteed label
rating
object
the rating score submitted by the reviewer
rating_type
string
the type of the rating
can take the following values: Max5
value
float
the value of the rating
votes_count
integer
the amount of feedback
indicated the number of votes the review obtained
rating_max
integer
the maximum value for a rating_type
the maximum value for Max5 is 5
categories
array
categories related to the business entity
photos
array
links to photos appearing in the result
tags
array
tags generated by Yelp
example: "New on Yelp"
business_highlights
array
highlights describing business offerings
example: "casual_dining"
service_offerings
array
tags corresponding to the availability of certain business offerings
type
string
type of the element
possible values: service_offerings_element
name
string
name of the label
example: Delivery
is_available
boolean
availability of the offering
if the value is false, the offering is not available
