/yelp-search

Returns search results from Yelp.

GET

Yelp Search

Returns search results from Yelp.

Request

Endpoint: GET https://api.outscraper.com/yelp-search

Parameters

Name	In	Type	Required	Description	Example	Constraints
`query`	query	array<string>	Yes	Search links with search parameters (e.g., `https://www.yelp.com/search?find_desc=Restaurants&find_loc=San+Francisco%2C+CA`). It supports batching by sending arrays with up to `1000` queries (e.g., `query=text1&query=text2&query=text3`). It allows multiple queries to be sent in one request and to save on network latency time.	-	-
`limit`	query	integer	No	The parameter specifies the limit of items to get from one query.	-	default 100
`enrichment`	query	array<string>	No	The parameter defines an enrichment or enrichments (e.g., `enrichment=enrichment1&enrichment=enrichment2&enrichment=enrichment3`) you want to apply to the results. Available values: `contacts_n_leads` — Contacts & Leads Enrichment: finds emails, social links, phones, and other contacts from websites; `emails_validator_service` — Email Address Verifier: validates emails, checks deliverability, filters out blacklists, spam traps, and complainers, while significantly reducing your bounce rate; `company_websites_finder` - Company Website Finder: finds company websites based on business names; `disposable_email_checker` — Disposable Emails Checker: checks origins of email addresses (disposable, free, or corporate); `company_insights_service` — Company Insights: Finds company firmographics such as revenue, size, founding year, public status, etc.; `phones_enricher_service` — Phone Numbers Enricher: returns phones carrier data (name/type), validates phones, ensures messages deliverability, `trustpilot_service` — Trustpilot Scraper: returns data from a list of businesses, `whitepages_phones` - Phone Identity Finder: returns insights about phone number owners (name, address, etc.); `ai_chain_info` - Chain Info: identifies if a business is part of a chain, adding a true/false indication to your data for smarter targeting. Using enrichments increases the time of the response. You might want to use the `async=true` parameter to avoid getting timeouts.	-	-
`fields`	query	string	No	The parameter defines which fields you want to include with each item returned in the response. By default, it returns all fields. Use `&fields=query,name` to return only the specific ones.	-	-
`async`	query	boolean	Yes	The parameter defines the way you want to submit your task to Outscraper. It can be set to `false` to open an HTTP connection and keep it open until you got your results, or `true` (default) to just submit your requests to Outscraper and retrieve them later (usually within 1-3 minutes) with the Request Results endpoint. Each response is available for `4` hours after a request has been completed. A good practice is to send async requests and start checking the results after the estimated execution time. Check out this Python implementation as an example. As most of the requests take some time to be executed the `async=true` option is preferred to avoid HTTP requests timeouts.	-	default true
`ui`	query	boolean	No	The parameter defines whether a task will be executed as a UI task. This is commonly used when you want to create a regular platform task with API. Using this parameter overwrites the `async` parameter to `true`.	-	default false
`format`	query	array<string enum>	No	The parameter defines the format of the output data. Using this parameter overwrites the `ui` parameter to `true`.	-	-
`webhook`	query	string	No	The parameter defines the URL address (callback) to which Outscraper will create a POST request with a JSON body once a task/request is finished. Using this parameter overwrites the webhook from integrations.	-	-

Responses

200

application/json

The response contains the status of the request and data. Data is an array where each element represents a response for a single query from the request.

{
  "id": "your-request-id",
  "status": "Success",
  "data": [
    [
      {
        "query": "https://www.yelp.com/search?find_desc=Restaurants&find_loc=San+Francisco%2C+CA",
        "biz_id": "HHtpR0RslupSQ99GIIwW5A",
        "name": "Marufuku Ramen",
        "price_range": "$$",
        "rating": 4.4,
        "reviews": 4109,
        "categories": [
          "Ramen"
        ],
        "formatted_dddress": "",
        "neighborhoods": [
          "Lower Pacific Heights"
        ],
        "phone": "(415) 872-9786",
        "business_url": "https://www.yelp.com/biz/marufuku-ramen-san-francisco-5?osq=Restaurants",
        "services": [
          "Outdoor seating",
          "Delivery",
          "Takeout"
        ],
        "photo": "https://s3-media0.fl.yelpcdn.com/bphoto/ouK2VmW0SrI70jsJpTxJhw/348s.jpg",
        "tags": [
          "Waitlist is closed"
        ],
        "snippet": "Long long overdue review, but I loved this place. The line was literally booty, so me and my friends went half an hour before opening, and sat by a nearby…"
      },
      {
        "query": "https://www.yelp.com/search?find_desc=Restaurants&find_loc=San+Francisco%2C+CA",
        "biz_id": "8VurRDEj1RpimenhgTmyFQ",
        "name": "KAIYŌ Rooftop",
        "price_range": "",
        "rating": 3.8,
        "reviews": 334,
        "categories": [
          "Peruvian",
          "Cocktail Bars",
          "Sushi Bars"
        ],
        "formatted_dddress": "",
        "neighborhoods": [
          "South Beach"
        ],
        "phone": "",
        "business_url": "https://www.yelp.com/biz/kaiy%C5%8D-rooftop-san-francisco-5?osq=Restaurants",
        "services": [
          "Outdoor seating",
          "Delivery",
          "Takeout"
        ],
        "photo": "https://s3-media0.fl.yelpcdn.com/bphoto/IpnkGDpsm94wGzTAdFekPg/348s.jpg",
        "tags": [],
        "snippet": null
      },
      {
        "query": "https://www.yelp.com/search?find_desc=Restaurants&find_loc=San+Francisco%2C+CA",
        "biz_id": "J7_-faNq_Ag9qTOlDn81Pw",
        "name": "Starbelly",
        "price_range": "$$",
        "rating": 3.8,
        "reviews": 2112,
        "categories": [
          "Comfort Food",
          "Cocktail Bars",
          "Wine Bars"
        ],
        "formatted_dddress": "",
        "neighborhoods": [
          "Castro"
        ],
        "phone": "(415) 252-7500",
        "business_url": "https://www.yelp.com/biz/starbelly-san-francisco?osq=Restaurants",
        "services": [
          "Outdoor seating",
          "Delivery",
          "Takeout"
        ],
        "photo": "https://s3-media0.fl.yelpcdn.com/bphoto/G1SweY3VbKx_BqAws9RytA/348s.jpg",
        "tags": [
          "Live wait time: 0 mins"
        ],
        "snippet": "Starbelly has been one of my go to comfort restaurants since I moved to this city. The menu is always fresh and new but the atmosphere and service always makes…"
      }
    ]
  ]
}

202

application/json

The response contains a request ID that can be used to fetch results by using Request Results endpoint. Each response is available for 4 hours after a request has been completed.

{
  "id": "your-request-id",
  "status": "Pending",
  "results_location": "https://api.outscraper.cloud/requests/your-request-id"
}

401

application/json

Wrong or missing API Key (token).

{
  "error": true,
  "errorMessage": "401 Unauthorized: The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required."
}

402

application/json

Past due invoices or a payment method not connected.

{
  "error": true,
  "errorMessage": "Please close past due invoices or verify your card information is correct."
}

422

application/json

Wrong query url parameters.

{
  "error": true,
  "errorMessage": "422 Unprocessable Entity: The request was well-formed but was unable to be followed due to semantic errors."
}

Code Samples

cURL

curl -X GET "https://api.outscraper.cloud/yelp-search?query=https%3A%2F%2Fwww.yelp.com%2Fsearch%3Ffind_desc%3DRestaurants%26find_loc%3DSan%2BFrancisco%252C%2BCA&limit=3&async=false" -H  "X-API-KEY: YOUR-API-KEY"

cURL (async)

curl -X GET "https://api.outscraper.cloud/yelp-search?query=https%3A%2F%2Fwww.yelp.com%2Fsearch%3Ffind_desc%3DRestaurants%26find_loc%3DSan%2BFrancisco%252C%2BCA&limit=3" -H  "X-API-KEY: YOUR-API-KEY"

Related Endpoints

GET

/airbnb-reviews

Returns reviews from Airbnb accommodations.

GET

/airbnb-search

Returns search results from Airbnb.

GET

/appstore-reviews

Returns reviews from AppStore apps.

GET

/booking-search

Returns search results from Booking.com

POST

/businesses

Retrieve business records with optional enrichment data. This endpoint provides access to millions of business listings with support for pagination and selective data enrichment.…

GET

/businesses/{business_id}

Retrieve detailed information for a specific business by os id, place id, or google id, with optional enrichments. Returns a complete business profile including basic information…