API reference
Yelp Business Reviews API
Reviews of a Yelp business, ten per page, with the author profile, votes, photos and any owner reply.
Endpoint
/v1/yelp/reviewslive · proven3 creditsParameters
Query parameters
Useful optional inputs
sort— Choose the documented source ordering before paging through results.Ordering keeps the normal endpoint price and does not guarantee exhaustive results.
dry_run— Read a free estimate before fetching sources or scheduling paid work.Zero credits; cache status and availability are snapshots rather than guarantees.
| Name | Required | Description | Example |
|---|---|---|---|
id | yes | Business id or alias, or its yelp.com URL | RJNAeNA-209sctUO0dmwuA |
page | no | Page number (10 per page) | 1 |
sort | no | yelp (default) or newest Accepted values: yelp, newest. Case, spaces, hyphens and underscores are interchangeable. | newest |
keywords | no | Only reviews mentioning this text | |
language | no | ISO 639-1 language | en |
dry_run | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable. | 1 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/yelp/reviews?id=RJNAeNA-209sctUO0dmwuA" \ -H "x-api-key: mn_your_key_here"
TypeScript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
"https://www.monocrawl.com/v1/yelp/reviews?id=RJNAeNA-209sctUO0dmwuA",
{ headers: { "x-api-key": key } },
);
const body = await res.json();
if (!body.success) {
// one error shape for every endpoint — see /docs/errors
throw new Error(`${body.error.type}: ${body.error.message}`);
}
console.log(body.data, "credits left:", body.credits_remaining);Python
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/yelp/reviews?id=RJNAeNA-209sctUO0dmwuA",
headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
timeout=60,
)
body = res.json()
if not body["success"]:
# one error shape for every endpoint — see /docs/errors
raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")
print(body["data"], "credits left:", body["credits_remaining"])Response
Response fields and example
This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.
{
"success": true,
"platform": "yelp",
"endpoint": "/v1/yelp/reviews",
"data": {
"business_id": "example",
"count": 0,
"cursor": null,
"has_more": false,
"items": [
{
"author": {
"elite_year": 0,
"friends": 0,
"id": "example",
"image": "https://example.com/example",
"location": "example",
"name": "example",
"photos": 0,
"reviews": 0,
"url": "https://example.com/example"
},
"id": "example",
"images": [
{}
],
"language": "example",
"platform": "example",
"posted_at": "2026-09-01T12:00:00Z",
"rating": 0,
"text": "example",
"url": "https://example.com/example",
"votes": {
"cool": 0,
"funny": 0,
"useful": 0
}
}
],
"languages": {
"en": 0,
"es": 0,
"fr": 0,
"zh": 0
},
"page": 0,
"total": 0,
"total_pages": 0
},
"credits_used": 3,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.
Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.
Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.
| Field inside data | Type | Meaning |
|---|---|---|
business_id | string | null | Optional business id supplied by this operation. Null means unknown. |
count | number | null | Number of records in this response, not lifetime or total matches. |
cursor | string | null | Opaque next-page token; pass it back unchanged. Null does not prove complete history. |
has_more | boolean | null | Source continuation indicator; null means unknown. |
items | array | null | Returned records. Source coverage and completeness vary. |
items[].author | object | null | Public author information supplied with this record. |
items[].author.elite_year | number | null | Optional elite year supplied by this operation. Null means unknown. |
items[].author.friends | number | null | Optional friends supplied by this operation. Null means unknown. |
items[].author.id | string | null | Source identifier. Preserve the supplied type and exact value. |
items[].author.image | string | null | Optional image supplied by this operation. Null means unknown. |
items[].author.location | string | null | Optional location supplied by this operation. Null means unknown. |
items[].author.name | string | null | Optional name supplied by this operation. Null means unknown. |
items[].author.photos | number | null | Optional photos supplied by this operation. Null means unknown. |
items[].author.reviews | number | null | Optional reviews supplied by this operation. Null means unknown. |
items[].author.url | string | null | Original source URL when supplied. |
items[].id | string | null | Source identifier. Preserve the supplied type and exact value. |
items[].images | array | null | Optional images supplied by this operation. Null means unknown. |
items[].language | string | null | Optional language supplied by this operation. Null means unknown. |
items[].platform | string | null | Optional platform supplied by this operation. Null means unknown. |
items[].posted_at | string | null | Optional posted at supplied by this operation. Null means unknown. |
items[].rating | number | null | Source rating; read its accompanying scale and vote count. |
items[].text | string | null | Source text when supplied. |
items[].url | string | null | Original source URL when supplied. |
items[].votes | object | null | Optional votes supplied by this operation. Null means unknown. |
items[].votes.cool | number | null | Optional cool supplied by this operation. Null means unknown. |
items[].votes.funny | number | null | Optional funny supplied by this operation. Null means unknown. |
items[].votes.useful | number | null | Optional useful supplied by this operation. Null means unknown. |
languages | object | null | Optional languages supplied by this operation. Null means unknown. |
languages.en | number | null | Optional en supplied by this operation. Null means unknown. |
languages.es | number | null | Optional es supplied by this operation. Null means unknown. |
languages.fr | number | null | Optional fr supplied by this operation. Null means unknown. |
languages.zh | number | null | Optional zh supplied by this operation. Null means unknown. |
page | number | null | Optional page supplied by this operation. Null means unknown. |
total | number | null | Source-reported total; null is unknown. |
total_pages | number | null | Optional total pages supplied by this operation. Null means unknown. |
Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.
The example is invented and illustrates types only; zero and empty values are not claims about a real result.
Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference