JSON POST request example
POST to https://api.litescrape.com/api/yelp/place with Content-Type: application/json and your Authorization: Bearer header.
{
"place_id": "arabica-brooklyn"
}// request reference
Yelp Place parameters
Send query parameters with GET /api/yelp/place. 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.
Place details
Resolve a Yelp business and its menu.
place_idRequired Yelp encoded business ID or business alias.
Type string · GET query or POST JSON
Example / input hint: arabica-brooklyn
yelp_domainSupported localized Yelp hostname.
Type string · GET query or POST JSON · Default www.yelp.com
Example / input hint: www.yelp.com
business_alertInclude business alert information when available.
Type boolean · GET query or POST JSON · Default false
truefalsefull_menuFetch the full menu when available; otherwise return place details with an explanation.
Type boolean · GET query or POST JSON · Default false
truefalsemenu_nameSelect a named menu when more than one is available. Requires full_menu=true.
Type string · GET query or POST JSON
Example / input hint: Lunch
// 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, place_results, full_menu_results, error, 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.
Illustrative success response. Result groups and optional fields depend on upstream content.
{
"search_parameters": {
"place_id": "arabica-brooklyn",
"yelp_domain": "www.yelp.com",
"business_alert": false,
"full_menu": false
},
"search_information": {
"query_displayed": "arabica-brooklyn"
},
"place_results": {
"name": "% Arabica",
"place_ids": [
"ED7A7vDdg8yLNKJTSVHHmg",
"arabica-brooklyn"
],
"rating": 4.4,
"reviews": 364,
"address": "20 Old Fulton St, Brooklyn, NY 11201",
"phone": "(718) 865-2551",
"price": "$$"
},
"submit_feedback_for_this_response_here": "https://ecll-litescrape-v3--site-api-web.modal.run/api/feedback/example-not-a-valid-token"
}