Skip to content
Examples

Get Results

Retrieve scraped data from Yelp Search Export

The v1 API, for batchesSquids, tasks and runs: many calls on a schedule, delivered where you work. For one call that answers in seconds, use the API v2.
GEThttps://api.lobstr.io/v1/results

Retrieve scraped data from your Yelp Search Export runs.

Headers

Authorizationstringheaderrequired

Your API authentication token. Value: Token YOUR_API_KEY

Query Parameters

squidstringqueryrequired

Hash of the squid to get results from

runstringquery

Hash of a specific run (optional)

pageintegerquery

Page number (default: 1). Example: 1

Result Fields

Each result object contains the following fields:

urlstring

Direct URL to the business listing on Yelp. Example: https://www.yelp.com/biz/vega-vitality-back-bay-boston-2?osq=Spa

namestring

Business name as listed on Yelp. Example: Vega Vitality Back Bay

reviewsinteger

Total number of customer reviews on Yelp. Example: 97

scoreinteger

Average Yelp rating out of 5. Example: 4.8

is_closedboolean

Whether the business is permanently closed on Yelp. Example: false

is_claimedboolean

Whether the business has claimed its Yelp listing. Example: true

pricestring

Price range indicator on Yelp (e.g. $, $$, $$$). Example: $$

categoriesstring

Business categories on Yelp (e.g. Italian, Pizza). Example: Medical Spas, Skin Care, Dermatologists

websitestring

Business website URL. Example: http://vegavitality.com

phonestring

Primary phone number of the business. Example: (617) 658-3421

website_menustring

URL to the business's menu on its own website. Example: https://vegavitality.com/pricing/

yelp_menustring

URL to the business's menu page on Yelp

addressstring

Full formatted address of the business. Example: 551 Boylston St, Fl 4, Boston, MA 02116

latfloat

Latitude coordinate of the business. Example: 42.350756

lngfloat

Longitude coordinate of the business. Example: -71.076037

amenitiesstring

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

emailstring

Email address of the business. Example: info@vegavitality.com

advertiser_statusboolean

Whether the business is an advertiser on Yelp. Example: false

is_sponsoredboolean

Whether the listing appears as a sponsored result on Yelp. Example: false

Response

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
}