Yelp yelp Business API

Scrape a Yelp business page

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

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

fetch('https://api.stophy.dev/v1/yelp/business', 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"

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

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

print(response.text)

{
  "success": true,
  "data": {
    "businessUrl": "<string>",
    "categories": [
      "<string>"
    ],
    "neighborhoods": [
      "<string>"
    ],
    "hours": [
      {
        "day": "<string>",
        "times": [
          "<string>"
        ]
      }
    ],
    "businessId": "<string>",
    "businessAlias": "<string>",
    "name": "<string>",
    "rating": 123,
    "reviews": 0,
    "priceLevel": "<string>",
    "addressFull": "<string>",
    "addressStreet": "<string>",
    "addressCity": "<string>",
    "addressRegion": "<string>",
    "addressPostalCode": "<string>",
    "addressCountry": "<string>",
    "latitude": 0,
    "longitude": 0,
    "phone": "<string>",
    "website": "<string>",
    "photosAndVideos": 0,
    "isClaimed": true
  },
  "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

Scrape a Yelp business page

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

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

fetch('https://api.stophy.dev/v1/yelp/business', 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"

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

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

print(response.text)

{
  "success": true,
  "data": {
    "businessUrl": "<string>",
    "categories": [
      "<string>"
    ],
    "neighborhoods": [
      "<string>"
    ],
    "hours": [
      {
        "day": "<string>",
        "times": [
          "<string>"
        ]
      }
    ],
    "businessId": "<string>",
    "businessAlias": "<string>",
    "name": "<string>",
    "rating": 123,
    "reviews": 0,
    "priceLevel": "<string>",
    "addressFull": "<string>",
    "addressStreet": "<string>",
    "addressCity": "<string>",
    "addressRegion": "<string>",
    "addressPostalCode": "<string>",
    "addressCountry": "<string>",
    "latitude": 0,
    "longitude": 0,
    "phone": "<string>",
    "website": "<string>",
    "photosAndVideos": 0,
    "isClaimed": true
  },
  "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 page. 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({ businessUrl: "https://www.yelp.com/biz/franklin-barbecue-austin" });
console.log(result.data);

from stophy import Stophy

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

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

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

Response

If successful, the response body contains the standard envelope. data contains businessId, businessAlias, businessUrl, name, rating, reviews, priceLevel, categories, addressFull, addressStreet, addressCity, addressRegion, addressPostalCode, addressCountry, neighborhoods, latitude, longitude, phone, website, hours, photosAndVideos and isClaimed. The following example is a real response, truncated: each list shows one item and long strings are cut.

{
  "success": true,
  "data": {
    "businessId": "MGzro82Fi4LYvc86acoONQ",
    "businessAlias": "franklin-barbecue-austin",
    "businessUrl": "https://www.yelp.com/biz/franklin-barbecue-austin",
    "name": "Franklin Barbecue",
    "rating": 4.5,
    "reviews": 6492,
    "priceLevel": "$$$",
    "categories": ["Barbeque"],
    "addressFull": "900 E 11th St, Austin, TX 78702",
    "addressStreet": "900 E 11th St",
    "addressCity": "Austin",
    "addressRegion": "TX",
    "addressPostalCode": "78702",
    "addressCountry": "US",
    "neighborhoods": ["East Austin"],
    "latitude": 30.2701348,
    "longitude": -97.73134511,
    "phone": "+1 555 0100",
    "website": "https://franklinbbq.com",
    "hours": [
      {
        "day": "Mon",
        "times": ["Closed"]
      }
    ],
    "photosAndVideos": 8631,
    "isClaimed": true
  },
  "creditsUsed": 1,
  "requestId": "2fe9dbad-fc48-4890-9751-0b24b596035b"
}

Field	Type	Description
`rating`	number	The average star rating, on a scale of 1 to 5.
`reviews`	integer	The number of reviews the rating is based on.

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.

Yelp yelp Business Reviews: Accepts businessUrl. Scrape a Yelp business’s reviews.

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.

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 API

Request

Response

Billing

Authorizations

Query Parameters

Body

Response

​Request

​Response

​Billing

​Pagination

​Related methods

Authorizations

Query Parameters

Body

Response

Request

Response

Billing

Pagination

Related methods