scraper
Back to API docs

Overview

  • Overview

APIs

  • POSTReviews
  • POSTBusiness Profile
  • POSTSearch

Yelp Search

1 credit

Search for businesses on Yelp by term, location, or coordinates.

POST/api/v1/tools/yelp/search

Parameters

termstring

Search term, such as "pizza" or "plumber". Maximum length is 200.

locationstring

Location string, such as "San Francisco, CA". Provide location or both latitude and longitude.

latitudenumber

Latitude (-90 to 90). Must be paired with longitude.

longitudenumber

Longitude (-180 to 180). Must be paired with latitude.

categorystring

Category filter.

maxResultsnumber

Maximum results (1-200). Defaults to 20.

sortstring

"default", "distance", "rating", "review_count".

radiusnumber

Non-negative search radius in the selected radiusUnit. The maximum is 40.2335 km or 25 miles.

radiusUnitstring

Unit for radius. One of "km" or "miles". Defaults to "km".

Response Schema

dataobject

Search results

resultsobject[]

Array of matching business identities

totalnumber

Total matching businesses that Yelp reports.

metaobject

Request metadata

toolstring

Tool name (yelp-search)

creditsUsednumber

Credits consumed (1)

requestIdstring

Unique request ID

Request

curl -X POST https://scraper.run/api/v1/tools/yelp/search \
-H "Authorization: Bearer sc_live_..." \
-H "Content-Type: application/json" \
-d '{
"term": "pizza",
"location": "San Francisco, CA",
"maxResults": 10
}'

Response Example

{
"data": {
"results": [
{
"id": "v2GpHEjNRMGZFIqkXnPh4g",
"alias": "tonys-pizza-napoletana-san-francisco",
"name": "Tony's Pizza Napoletana"
},
{
"id": "lJAGnYzku5zSaLnQ_T6_GQ",
"alias": "golden-boy-pizza-san-francisco",
"name": "Golden Boy Pizza"
}
],
"total": 124
},
"meta": {
"tool": "yelp-search",
"creditsUsed": 1,
"requestId": "req_def456"
}
}