Skip to main content
POST
Scrape Yelp search results
Scrape Yelp search results.

Request

query and location are required.

Response

If successful, the response body contains the standard envelope. data contains results. The following example is a real response, truncated: each list shows one item and long strings are cut.
For every field, see the response schema on this page.

Billing

Each successful request consumes 1 credit, regardless of the number of items returned. Requests that fail, or that return no items, are not billed.

Pagination

This method is not paginated. A single request returns the complete result.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

maxTextLength
integer

Cut every text value in the response to this many characters. A value that was cut ends with …, and a page whose text was cut has isTruncated set to true. A screenshot is never cut. Leave it out to get the full text.

Required range: x >= 1

Body

application/json
query
string
required

What to find, like plumber, pizza or a business name.

Required string length: 1 - 200
location
string
required

A city, neighborhood, address or postal code, like Austin, TX.

Required string length: 2 - 200

Response

The data, and the credits this call used.

success
any
required
data
object
required
creditsUsed
integer
required
requestId
string
required