Yelp

Yelp Reviews

Return Yelp business reviews by alias or encoded business ID. Filter recommended reviews by text and ratings, or select not-recommended reviews with their separate offset. Keep filters, language, sorting, and limit unchanged when paginating.

post/v1/yelp/reviews

Request

  • Base URL: https://api.prismcrawl.com
  • URL: https://api.prismcrawl.com/v1/yelp/reviews
  • Auth: API key in header x-api-key

Request body

idstring required

The business alias from its Yelp URL, such as halcyon-austin-2.

languagestring

Provider-supported language code, such as en.

pageinteger

One-based page number.

limitinteger

Maximum number of items to return. The provider may return fewer.

sort_by'recommended' | 'newest' | 'oldest' | 'highest_rating' | 'lowest_rating' | 'elites'

The provider's supported sort order.

device'desktop' | 'mobile' | 'tablet'

Device presentation for the source request.

htmlboolean

Return the encoded original response rather than parsed JSON.

zero_traceboolean

Do not archive source or parsed response artifacts.

querystring

Text to search for on the selected service. At most 8,192 UTF-8 bytes.

yelp_domain'yelp.at' | 'yelp.be' | 'yelp.ca' | 'yelp.ch' | 'yelp.cl' | 'yelp.co.jp' | 'yelp.co.nz' | 'yelp.co.uk' | 'yelp.com' | 'yelp.com.ar' | 'yelp.com.au' | 'yelp.com.br' | 'yelp.com.hk' | 'yelp.com.mx' | 'yelp.com.ph' | 'yelp.com.sg' | 'yelp.com.tr' | 'yelp.com.tw' | 'yelp.cz' | 'yelp.de' | 'yelp.dk' | 'yelp.es' | 'yelp.fi' | 'yelp.fr' | 'yelp.ie' | 'yelp.it' | 'yelp.my' | 'yelp.nl' | 'yelp.no' | 'yelp.pl' | 'yelp.pt'

Yelp regional domain.

ratingstring

Comma-separated review star ratings.

startinteger

Zero-based offset in recommended reviews.

not_recommendedboolean

Return reviews that Yelp does not currently recommend.

not_recommended_startinteger

Zero-based offset in not-recommended reviews.

output'json' | 'html' | 'md' | 'null' nullable

Response content format. md returns Markdown in data.content with data.format=md; the JSON success/request envelope remains. Accept: text/markdown also selects Markdown unless output or html=true is explicit. html is an alias for html=true and retains the existing Brotli/Base64 source format.

json_restrictorstring nullable

Select fields within data.content for JSON or Markdown. Supports comma-separated paths, non-negative array indices, half-open slices [0:3] (either bound may be omitted), [] and .{nested,subqueries}. Up to128 selections and16 levels. Missing fields are omitted; selected declared fields retain their zero defaults. The request envelope and credit headers remain. Include next_page_token when pagination is needed. Incompatible with HTML output. This changes response presentation only; tracing-enabled history retains the complete JSON result.

no_cacheboolean nullable

Accepted for compatibility. Searches are always fetched without a result cache for either value; normal successful-request billing applies.

Example request

{
  "json_restrictor": "results[].{title,url},has_next_page,next_page_token"
}

Response

Request completed. One credit is charged, including recognized empty or unavailable source results and source inventory changes discovered after a valid continuation is fetched. These completed responses may preserve verified partial results; operational failures remain errors.

successtrue required
request_idstring uuid required

Changes

No recorded changes to this operation across all 1 revision of this API.