Yelp Search Scraper

Effortlessly extract local business data from Yelp search results with our user-friendly app or API

API Usage

The Yelp Search Scraper is also accessible via API, accepting the following parameters in the request body

Request Body

Name	Description	Example
search	Search keyword to extract business data for	coffee shops
location	Location or city to search in	New York, NY
service_platform	Identifier for the scraper platform	yelp_search
webhook_url	Optional callback URL to receive results upon job completion (must accept POST requests)	https://yourwebhook.com/endpoint

Authentication

Set the following header for authentication:

Authorization: Token <your_api_key>

Example

To use the scraper via API, send a POST request with the search, location, and service_platform in the request body.

bash

1curl -X POST 'https://data.unwrangle.com/api/jobs/' \
2-H 'Authorization: Token <your_api_key_here>' \
3-H 'Content-Type: application/json' \
4-d '{
5  "search": "coffee shops",
6  "location": "New York, NY",
7  "service_platform": "yelp_search"
8}'

API Response

This is the response you will receive when a scraping job is created successfully.

json

1{
2  "created": "2024-06-10T09:19:40.161178Z",
3  "id": 27602,
4  "url": null,
5  "search": "coffee shops",
6  "location": "New York, NY",
7  "urls": [],
8  "status": "queued",
9  "n": null,
10  "service_platform": "yelp_search",
11  "from_date": null,
12  "webhook_url": null,
13  "external_id": null,
14  "is_webhook_sent": false,
15  "credits_used": 10,
16  "completed": null
17}

Querying Results

The results retrieved by the scraping job can also be queried via API by making a request with the job ID if a webhook URL is not provided.

bash

1curl -X GET 'https://data.unwrangle.com/api/jobs/27602/results/' \
2-H 'Authorization: Token <your_api_key>'

Request Cost

Each record returned will cost 1 credit and an additional 10 credits will be charged as a base fee for each job that is created