Skip to main content
GET
/
v1
/
results
Get Results
curl --request GET \
  --url https://api.lobstr.io/v1/results \
  --header 'Authorization: <authorization>'
{
  "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
}

Documentation Index

Fetch the complete documentation index at: https://docs.lobstr.io/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve scraped data from your Yelp Search Export runs.

​
Headers

​
Authorization
string
required
Your API authentication token. Value: Token YOUR_API_KEY

​
Query Parameters

​
squid
string
required
Hash of the squid to get results from
​
run
string
Hash of a specific run (optional)
​
page
integer
Page number (default: 1). Example: 1

​
Result Fields

Each result object contains the following fields:
​
url
string
Direct URL to the business listing on Yelp. Example: https://www.yelp.com/biz/vega-vitality-back-bay-boston-2?osq=Spa
​
name
string
Business name as listed on Yelp. Example: Vega Vitality Back Bay
​
reviews
integer
Total number of customer reviews on Yelp. Example: 97
​
score
integer
Average Yelp rating out of 5. Example: 4.8
​
is_closed
boolean
Whether the business is permanently closed on Yelp. Example: false
​
is_claimed
boolean
Whether the business has claimed its Yelp listing. Example: true
​
price
string
Price range indicator on Yelp (e.g. $, , $$$). Example: ``
​
categories
string
Business categories on Yelp (e.g. Italian, Pizza). Example: Medical Spas, Skin Care, Dermatologists
​
website
string
Business website URL. Example: http://vegavitality.com
​
phone
string
Primary phone number of the business. Example: (617) 658-3421
​
website_menu
string
URL to the business’s menu on its own website. Example: https://vegavitality.com/pricing/
​
yelp_menu
string
URL to the business’s menu page on Yelp
​
address
string
Full formatted address of the business. Example: 551 Boylston St, Fl 4, Boston, MA 02116
​
lat
float
Latitude coordinate of the business. Example: 42.350756
​
lng
float
Longitude coordinate of the business. Example: -71.076037
​
amenities
string
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 parking
​
email
string
Email address of the business. Example: info@vegavitality.com
​
advertiser_status
boolean
Whether the business is an advertiser on Yelp. Example: false
​
is_sponsored
boolean
Whether the listing appears as a sponsored result on Yelp. Example: false