JSON POST request example
POST to https://ecll-litescrape-v3--site-api-web.modal.run/api/yelp/search with Content-Type: application/json and your Authorization: Bearer header.
{
"find_desc": "coffee",
"find_loc": "Austin, TX"
}// request reference
Yelp Search parameters
Send query parameters with GET /api/yelp/search. 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 search
Search Yelp businesses with optional filters.
find_descBusiness name, category, or search terms.
Type string · GET query or POST JSON
Example / input hint: coffee
find_locRequired Yelp search location.
Type string · GET query or POST JSON
Example / input hint: Austin, TX
yelp_domainSupported Yelp hostname. Results use the language of the selected domain.
Type string · GET query or POST JSON · Default www.yelp.com
Example / input hint: www.yelp.com
lOptional Yelp-native map bounds token.
Type string · GET query or POST JSON
Example / input hint: g:-97.80,30.20,-97.70,30.30
cfltYelp category identifier containing letters, numbers, _ or -.
Type string · GET query or POST JSON
Example / input hint: coffee
sortbyNative Yelp ordering.
Type string · GET query or POST JSON · Default recommended
recommendedratingreview_countattrsYelp-native comma-separated attribute filters.
Type string · GET query or POST JSON
Example / input hint: OutdoorSeating
startResult offset from 0 through 10,000.
Type integer · GET query or POST JSON · Default 0
Example / input hint: 0
// 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, filters, ads_results, organic_results, pagination, litescrape_pagination, related_links, faqs, 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.