Get Results
curl --request GET \
--url https://api.lobstr.io/v1/results \
--header 'Authorization: <authorization>'import requests
url = "https://api.lobstr.io/v1/results"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.lobstr.io/v1/results', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lobstr.io/v1/results",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.lobstr.io/v1/results"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.lobstr.io/v1/results")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lobstr.io/v1/results")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"url": "<string>",
"name": "<string>",
"reviews": 123,
"score": 123,
"is_closed": true,
"is_claimed": true,
"price": "<string>",
"categories": "<string>",
"website": "<string>",
"phone": "<string>",
"website_menu": "<string>",
"yelp_menu": "<string>",
"address": "<string>",
"lat": 123,
"lng": 123,
"amenities": "<string>",
"email": "<string>",
"advertiser_status": true,
"is_sponsored": true
}Yelp Search Export
Get Results
Retrieve scraped data from Yelp Search Export
GET
/
v1
/
results
Get Results
curl --request GET \
--url https://api.lobstr.io/v1/results \
--header 'Authorization: <authorization>'import requests
url = "https://api.lobstr.io/v1/results"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.lobstr.io/v1/results', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.lobstr.io/v1/results",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.lobstr.io/v1/results"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.lobstr.io/v1/results")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.lobstr.io/v1/results")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"url": "<string>",
"name": "<string>",
"reviews": 123,
"score": 123,
"is_closed": true,
"is_claimed": true,
"price": "<string>",
"categories": "<string>",
"website": "<string>",
"phone": "<string>",
"website_menu": "<string>",
"yelp_menu": "<string>",
"address": "<string>",
"lat": 123,
"lng": 123,
"amenities": "<string>",
"email": "<string>",
"advertiser_status": true,
"is_sponsored": true
}Retrieve scraped data from your Yelp Search Export runs.
Headers
string
required
Your API authentication token. Value:
Token YOUR_API_KEYQuery Parameters
string
required
Hash of the squid to get results from
string
Hash of a specific run (optional)
integer
Page number (default: 1). Example:
1Result Fields
Each result object contains the following fields:string
Direct URL to the business listing on Yelp. Example:
https://www.yelp.com/biz/vega-vitality-back-bay-boston-2?osq=Spastring
Business name as listed on Yelp. Example:
Vega Vitality Back Bayinteger
Total number of customer reviews on Yelp. Example:
97integer
Average Yelp rating out of 5. Example:
4.8boolean
Whether the business is permanently closed on Yelp. Example:
falseboolean
Whether the business has claimed its Yelp listing. Example:
truestring
Price range indicator on Yelp (e.g. $, , $$$). Example: ``
string
Business categories on Yelp (e.g. Italian, Pizza). Example:
Medical Spas, Skin Care, Dermatologistsstring
Business website URL. Example:
http://vegavitality.comstring
Primary phone number of the business. Example:
(617) 658-3421string
URL to the business’s menu on its own website. Example:
https://vegavitality.com/pricing/string
URL to the business’s menu page on Yelp
string
Full formatted address of the business. Example:
551 Boylston St, Fl 4, Boston, MA 02116float
Latitude coordinate of the business. Example:
42.350756float
Longitude coordinate of the business. Example:
-71.076037string
Amenities and features offered by the business as listed on Yelp. Example:
By appointment only, Wheelchair accessible, Accessible parking near entrance, ADA-compliant main entrance, No steps or stairs, Accepts credit cards, Garage parking, Street parking, Free Wi-Fi, Women-owned, Bike parkingstring
Email address of the business. Example:
info@vegavitality.comboolean
Whether the business is an advertiser on Yelp. Example:
falseboolean
Whether the listing appears as a sponsored result on Yelp. Example:
falseResponse
200
{
"total_results": 1,
"limit": 50,
"page": 1,
"total_pages": 1,
"result_from": 1,
"result_to": 1,
"data": [
{
"id": 28248,
"object": "result",
"squid": "3b1be7b728c671f3e7ad20d9205127ce",
"run": "bd19be3f06ac76e1a6ec86e60989191b",
"url": "https://www.yelp.com/biz/vega-vitality-back-bay-boston-2?osq=Spa",
"name": "Vega Vitality Back Bay",
"reviews": 97,
"score": 4.8,
"is_closed": false,
"is_claimed": null,
"price": "$$",
"categories": "Medical Spas, Skin Care, Dermatologists",
"website": "http://vegavitality.com",
"phone": "(617) 658-3421",
"website_menu": null,
"yelp_menu": null,
"address": "551 Boylston St, Fl 4, Boston, MA 02116",
"lat": 42.350756,
"lng": -71.076037,
"amenities": "By appointment only, Wheelchair accessible, Accessible parking near entrance, ADA-compliant main entrance, No steps or stairs, Accepts credit cards, Garage parking, Street parking, Free Wi-Fi, Women-owned, Bike parking",
"email": "info@vegavitality.com",
"advertiser_status": false,
"is_sponsored": false,
"functions": null,
"native_id": 28248
}
],
"next": null,
"previous": null
}