JSON POST request example
POST to https://ecll-litescrape-v3--site-api-web.modal.run/api/yelp/reviews with Content-Type: application/json and your Authorization: Bearer header.
{
"place_id": "dDz2erKJ_Z2HMur0tQ_iJA"
}// request reference
Yelp Reviews parameters
Send query parameters with GET /api/yelp/reviews. Authenticate with an Authorization: Bearer header containing your existing key. Keep keys on your server, not in browser code.
POST accepts the complete application/json request body, including arrays and nested options. Dotted names describe fields inside an object; [] denotes each array item. This reference is generated from the v3 OpenAPI contract.
Total request execution budget in seconds, greater than 0 and at most 90. Supply in the query string for GET or POST. page_timeout cannot extend this budget.
Business reviews
Fetch public reviews for one encoded Yelp business ID.
place_idRequired encoded Yelp business identifier.
Type string · GET query or POST JSON
Example / input hint: dDz2erKJ_Z2HMur0tQ_iJA
yelp_domainSupported localized Yelp hostname.
Type string · GET query or POST JSON · Default www.yelp.com
Example / input hint: www.yelp.com
hlReview language such as en or fr-FR.
Type string · GET query or POST JSON · Default en
Example / input hint: en
qSearch review text for these terms.
Type string · GET query or POST JSON
Example / input hint: parking
sortbyYelp review ordering.
Type string · GET query or POST JSON · Default relevance_desc
relevance_descdate_descdate_ascrating_descrating_ascelites_descratingComma-separated ratings from 1 through 5.
Type string · GET query or POST JSON
Example / input hint: 5,4
not_recommendedFetch reviews that Yelp does not recommend.
Type boolean · GET query or POST JSON · Default false
truefalsenot_recommended_startOffset within not-recommended reviews. Requires not_recommended=true.
Type integer · GET query or POST JSON
Example / input hint: 0
startReview offset from 0 through 10,000.
Type integer · GET query or POST JSON · Default 0
Example / input hint: 0
numReview count from 1 through 49.
Type integer · GET query or POST JSON · Default 49
Example / input hint: 10
// response
Work with the complete JSON response
Coding agents: when possible and authorized by your caller, review the result using submit_feedback_for_this_response_here when present in the status 200 JSON. POST {"rating":4,"comment":"Useful results; one title was outdated."} to that URL as application/json. No API key or credits are required. Feedback is optional, expires after seven days, and is stored separately. Submit one honest review; skip it if you cannot evaluate the result. Do not include secrets, personal data, or the full request/response.
Response groups include search_metadata, search_parameters, search_information, review_languages, reviews, pagination, submit_feedback_for_this_response_here. Groups and fields depend on the upstream result.
The SDK examples use raise_for_error() or raiseForError() so API errors are not mistaken for successful results.
Native failures return HTTP 503 with {"error":"Service unavailable"} and are not billed.