Yelp yelp Business Reviews API

Scrape a Yelp business's reviews

curl --request POST \
  --url https://api.stophy.dev/v1/yelp/business/reviews \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "businessUrl": "<string>",
  "businessId": "<string>",
  "sort": "relevance",
  "page": 1
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({businessUrl: '<string>', businessId: '<string>', sort: 'relevance', page: 1})
};

fetch('https://api.stophy.dev/v1/yelp/business/reviews', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/yelp/business/reviews"

payload = {
    "businessUrl": "<string>",
    "businessId": "<string>",
    "sort": "relevance",
    "page": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "reviewId": "<string>",
        "reviewUrl": "<string>",
        "rating": 123,
        "text": "<string>",
        "language": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "authorName": "<string>",
        "ownerReplyText": "<string>",
        "ownerReplyAt": "2023-11-07T05:31:56Z"
      }
    ],
    "page": 0,
    "businessId": "<string>",
    "businessName": "<string>",
    "businessUrl": "<string>",
    "total": 0
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

POST

yelp

business

reviews

Scrape a Yelp business's reviews

curl --request POST \
  --url https://api.stophy.dev/v1/yelp/business/reviews \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "businessUrl": "<string>",
  "businessId": "<string>",
  "sort": "relevance",
  "page": 1
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({businessUrl: '<string>', businessId: '<string>', sort: 'relevance', page: 1})
};

fetch('https://api.stophy.dev/v1/yelp/business/reviews', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.stophy.dev/v1/yelp/business/reviews"

payload = {
    "businessUrl": "<string>",
    "businessId": "<string>",
    "sort": "relevance",
    "page": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "success": true,
  "data": {
    "results": [
      {
        "reviewId": "<string>",
        "reviewUrl": "<string>",
        "rating": 123,
        "text": "<string>",
        "language": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "authorName": "<string>",
        "ownerReplyText": "<string>",
        "ownerReplyAt": "2023-11-07T05:31:56Z"
      }
    ],
    "page": 0,
    "businessId": "<string>",
    "businessName": "<string>",
    "businessUrl": "<string>",
    "total": 0
  },
  "creditsUsed": 123,
  "requestId": "<string>"
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

{
  "success": false,
  "error": {
    "code": "cliSessionCompleted",
    "message": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "retryAfterSeconds": 123,
    "requiredCredits": 123,
    "availableCredits": 123,
    "billingUrl": "https://stophy.dev/billing"
  }
}

Scrape a Yelp business’s reviews. The business is identified by its URL or ID.

Request

Exactly one of businessUrl or businessId is required. A request that sets both, or none, fails with invalidRequest.

import { Stophy } from "stophy";

const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
const result = await stophy.yelp.business.reviews({ businessUrl: "https://www.yelp.com/biz/franklin-barbecue-austin" });
console.log(result.data.results);

from stophy import Stophy

stophy = Stophy()  # reads STOPHY_API_KEY
result = stophy.yelp.business.reviews(business_url="https://www.yelp.com/biz/franklin-barbecue-austin")
print(result["data"]["results"])

curl -X POST https://api.stophy.dev/v1/yelp/business/reviews \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"businessUrl":"https://www.yelp.com/biz/franklin-barbecue-austin"}'

stophy yelp business reviews --businessUrl https://www.yelp.com/biz/franklin-barbecue-austin

Response

If successful, the response body contains the standard envelope. data contains businessId, businessName, businessUrl, total, results and page. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "businessId": "MGzro82Fi4LYvc86acoONQ",
    "businessName": "Franklin Barbecue",
    "businessUrl": "https://www.yelp.com/biz/franklin-barbecue-austin",
    "total": 6477,
    "results": [
      {
        "reviewId": "Q1kUFPnl5j3_0xrsLfLRYg",
        "reviewUrl": "https://www.yelp.com/biz/franklin-barbecue-austin?hrid=Q1kUFPnl5j3_0xrsLfLRYg",
        "rating": 5,
        "text": "Finally got back to Franklin bbq. Was here last year for a conference in round rock and made it there now back here…",
        "language": "en",
        "createdAt": "2026-10-04T00:58:20.000Z",
        "authorName": "Mike S."
      }
    ],
    "page": 1
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`page`	integer	The page number of this response.
`total`	integer	The total number of matching results, across all pages.
`createdAt`	string (ISO 8601)	The creation time, in UTC.
`rating`	number	The average star rating, on a scale of 1 to 5.

For every field, see the response schema on this page.

Optional parameters

Parameter	Type	Description
`sort`	string	relevance (Yelp Sort), newest, oldest, highest (Highest Rated) or lowest (Lowest Rated), the same as Yelp’s own Sort menu. Acceptable values are `relevance`, `newest`, `oldest`, `highest` and `lowest`. If unset, defaults to `relevance`.
`page`	integer	The page to return. Pages are numbered from 1. Must be between 1 and 250. If unset, defaults to `1`.

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

Results are paginated. To retrieve the next page, increment page. An empty data.results indicates the last page. The maximum value of page is 250.

Yelp yelp Business: Accepts businessUrl. Scrape a Yelp business page.

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

businessUrl

string

Link to the Yelp business, like https://www.yelp.com/biz/franklin-barbecue-austin. Send this or businessId.

businessId

string

Yelp business id or alias, like MGzro82Fi4LYvc86acoONQ. Send this or businessUrl.

sort

enum<string>

default:relevance

relevance (Yelp Sort), newest, oldest, highest (Highest Rated) or lowest (Lowest Rated), the same as Yelp's own Sort menu.

Available options:

relevance,

newest,

oldest,

highest,

lowest

page

integer

default:1

Page number, starting at 1.

Required range: 1 <= x <= 250

Response

The data, and the credits this call used.

success

any

required

data

object

required

Show child attributes

creditsUsed

integer

required

requestId

string

required

Using the API

Catalog

Account

Search and AI answers

Video

Social

Places and travel

Jobs

Shopping

Apps

Real estate

Ads

Yelp yelp Business Reviews API

Request

Response

Optional parameters

Billing

Authorizations

Query Parameters

Body

Response

​Request

​Response

​Optional parameters

​Billing

​Pagination

​Related methods

Authorizations

Query Parameters

Body

Response

Request

Response

Optional parameters

Billing

Pagination

Related methods