> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Yelp reviews

> Read a Yelp business page as JSON with the yelp-reviews parser. $1 per 1,000 calls. Send the page to scrape. Examples in cURL, TypeScript and Python.

Reads a Yelp business page, like yelp.com/biz/franklin-barbecue-austin, and returns a list of reviews as JSON.

## Make a request

Send the page's URL to [scrape](https://docs.stophy.dev/api-reference/endpoint/scrape.md) with a `json` format that names the parser. Get an API key in the [Quickstart](https://docs.stophy.dev/quickstart).

```bash cURL theme={null}
curl -X POST https://api.stophy.dev/v1/scrape \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://www.yelp.com/biz/franklin-barbecue-austin?sort_by=date_desc","formats":[{"type":"json","parser":"yelp-reviews"}]}'
```

```typescript TypeScript theme={null}
const response = await fetch("https://api.stophy.dev/v1/scrape", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.STOPHY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    url: "https://www.yelp.com/biz/franklin-barbecue-austin?sort_by=date_desc",
    formats: [{ type: "json", parser: "yelp-reviews" }],
  }),
});
console.log(await response.json());
```

```python Python theme={null}
import os

import requests

response = requests.post(
    "https://api.stophy.dev/v1/scrape",
    headers={"Authorization": f"Bearer {os.environ['STOPHY_API_KEY']}"},
    json={
        "url": "https://www.yelp.com/biz/franklin-barbecue-austin?sort_by=date_desc",
        "formats": [{"type": "json", "parser": "yelp-reviews"}],
    },
)
print(response.json())
```

## Read the response

The parser's data is in `data.json`. Its fields include `results`, `cursor`, `page` and `total`. This sample is cut to the first items.

```json theme={null}
{
  "success": true,
  "data": {
    "json": {
      "results": [
        {
          "id": "Wtxnb99DEKuOQtZ9Yd5qTw",
          "url": "https://www.yelp.com/biz/franklin-barbecue-austin?hrid=Wtxnb99DEKuOQtZ9Yd5qTw",
          "author": {
            "id": "0",
            "name": "Example user",
            "handle": null,
            "url": "https://example.com/example_user",
            "avatarUrl": null
          },
          "rating": 5,
          "title": null,
          "text": "This was a bucket list resteraunt for us to try, we had some extra time and were in town so we had to try it out. \n\nWe…",
          "publishedAt": "2026-11-02T20:42:12.000Z",
          "likes": null,
          "response": null,
          "subject": {
            "id": "MGzro82Fi4LYvc86acoONQ",
            "name": "Franklin Barbecue",
            "url": "https://www.yelp.com/biz/franklin-barbecue-austin"
          },
          "language": "en",
          "authorReviews": 115,
          "authorLocation": null
        }
      ],
      "cursor": null,
      "page": 1,
      "total": 6480
    }
  }
}
```

## Options

Send options in the `options` object of the `json` format.

| Option | What it does |
| - | - |
| `page` | Page number, starting at 1. |

## Price

\$1 per 1,000 calls. See [Pricing](https://docs.stophy.dev/account/pricing.md).

## Limits and errors

* The URL must be a Yelp business page, like yelp.com/biz/franklin-barbecue-austin. Any other URL fails with `invalidRequest`.
* The answer comes back in `data.json`. If the page cannot be read, the call fails with an error code from [Errors](https://docs.stophy.dev/api-reference/errors.md).

## Related

* [Pre-built parsers](https://docs.stophy.dev/scrape/prebuilt-parsers) lists every parser.
* [Scrape](https://docs.stophy.dev/scrape/overview) has the options every scrape takes.
* [Yelp search](https://docs.stophy.dev/scrape/prebuilt-parsers/places-and-travel/yelp-search.md)
* [Yelp business](https://docs.stophy.dev/scrape/prebuilt-parsers/places-and-travel/yelp-business.md)
* [Google Maps](https://docs.stophy.dev/scrape/prebuilt-parsers/places-and-travel/google-maps.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.