---
title: "Yelp Search"
method: POST
path: "/v1/yelp/search"
tags: ["Yelp"]
---

# Yelp Search

`POST /v1/yelp/search`

## Request

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

Search Yelp businesses by query and area. Category, attribute, neighborhood, alternative sort and regional-domain selections use standard search. Unfiltered US relevance requests retain native business lookup. Pagination is limited to the first 200 businesses.

## Request body

- union: Search Yelp businesses by query and area. Category, attribute, neighborhood, alternative sort and regional-domain selections use standard search. Unfiltered US relevance requests retain native business lookup. Pagination is limited to the first 200 businesses.
  - object
    - `query` string: Optional business search text. Omit to browse businesses in the selected area. At most 8,192 UTF-8 bytes.
    - `language` string: Provider-supported language code, such as en.
    - `location` string, required: Location to search around, such as Austin, TX. Yelp Business Lookup requires exactly one of location or coordinates. If Yelp cannot resolve the location, a completed lookup returns HTTP 200 with an empty results array and search_parameters.location_not_found: true. This successful response costs one credit.
    - `coordinates` object: Latitude and longitude for location targeting. Yelp Business Lookup requires exactly one of location or coordinates. If Yelp cannot resolve the location, a completed lookup returns HTTP 200 with an empty results array and search_parameters.location_not_found: true. This successful response costs one credit.
      - `latitude` number, required
      - `longitude` number, required
    - `page` integer: One-based page within the first 200 businesses. The starting offset (page - 1) × limit must be less than 200. With limit 20, pages 1 through 10 are available. Keep the other search parameters unchanged.
    - `limit` integer: Maximum businesses to return, from 1 to 100; defaults to 20. The final page stops at Yelp's 200-result lookup window.
    - `sort_by` 'recommended': Omit this field or use recommended for Yelp's native business lookup order. Rating, review-count, and distance sorting are unsupported.
    - `device` 'desktop' | 'mobile' | 'tablet': Device presentation for the source request.
    - `html` boolean: Return the encoded original response rather than parsed JSON.
    - `zero_trace` boolean: Do not archive source or parsed response artifacts.
    - `start` integer: Result offset within the first 200 businesses. Use this or page; a final page can contain fewer than limit results.
    - `l` string: Source geographic box g:west,south,east,north or neighborhood selection p:region:city::neighborhood. A neighborhood requires location. Cannot be combined with coordinates.
    - `cflt` string: Comma-separated native category aliases.
    - `attrs` string: Comma-separated native attribute filters, for example GoodForKids,DogsAllowed.
    - `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.
    - `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_restrictor` string, 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_cache` boolean, nullable: Accepted for compatibility. Searches are always fetched without a result cache for either value; normal successful-request billing applies.
  - object
    - `query` string: Optional business search text. Omit to browse businesses in the selected area. At most 8,192 UTF-8 bytes.
    - `language` string: Provider-supported language code, such as en.
    - `location` string: Location to search around, such as Austin, TX. Yelp Business Lookup requires exactly one of location or coordinates. If Yelp cannot resolve the location, a completed lookup returns HTTP 200 with an empty results array and search_parameters.location_not_found: true. This successful response costs one credit.
    - `coordinates` object, required: Latitude and longitude for location targeting. Yelp Business Lookup requires exactly one of location or coordinates. If Yelp cannot resolve the location, a completed lookup returns HTTP 200 with an empty results array and search_parameters.location_not_found: true. This successful response costs one credit.
      - `latitude` number, required
      - `longitude` number, required
    - `page` integer: One-based page within the first 200 businesses. The starting offset (page - 1) × limit must be less than 200. With limit 20, pages 1 through 10 are available. Keep the other search parameters unchanged.
    - `limit` integer: Maximum businesses to return, from 1 to 100; defaults to 20. The final page stops at Yelp's 200-result lookup window.
    - `sort_by` 'recommended': Omit this field or use recommended for Yelp's native business lookup order. Rating, review-count, and distance sorting are unsupported.
    - `device` 'desktop' | 'mobile' | 'tablet': Device presentation for the source request.
    - `html` boolean: Return the encoded original response rather than parsed JSON.
    - `zero_trace` boolean: Do not archive source or parsed response artifacts.
    - `start` integer: Result offset within the first 200 businesses. Use this or page; a final page can contain fewer than limit results.
    - `l` string: Source geographic box g:west,south,east,north or neighborhood selection p:region:city::neighborhood. A neighborhood requires location. Cannot be combined with coordinates.
    - `cflt` string: Comma-separated native category aliases.
    - `attrs` string: Comma-separated native attribute filters, for example GoodForKids,DogsAllowed.
    - `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.
    - `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_restrictor` string, 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_cache` boolean, nullable: Accepted for compatibility. Searches are always fetched without a result cache for either value; normal successful-request billing applies.

## Response `200`

Request completed. One credit is charged, including an empty result when Yelp cannot resolve the supplied location. The response marks search_parameters.location_not_found: true and source_result_count: 0, with no further pages.

- CatalogYelpResponse
  - `success` true, required
  - `request_id` string, uuid, required
  - `data` union, required
    - MarkdownSearchData
      - `format` union, required
        - ''
        - 'md'
      - `content` string, required: Markdown derived from the parsed result, after any json_restrictor selection.
    - ProjectedSearchData
      - `format` union, required
        - ''
        - 'json'
      - `content` object, required: Only fields selected by json_restrictor. Selected fields retain their declared types and zero defaults.
    - object
      - `format` 'json', required
      - `content` object, required
        - `has_next_page` boolean, required
        - `next_page_token` string, required: Opaque continuation token valid for one hour and the same account. Retain search parameters, device, and result limit. Restart pagination if the token is expired or rejected; tokens from before the authenticated-token rollout cannot be reused.
        - `results` object[], required
          - `address` string, required
          - `business_id` string, required
          - `categories` object[], required
            - `id` string, required
            - `name` string, required
          - `city` string, required
          - `coordinates` object, required
            - `latitude` number, required
            - `longitude` number, required
          - `engine` string, required
          - `id` string, required
          - `name` string, required
          - `neighborhoods` string[], required
          - `phone` string, required
          - `photos` string[], required
          - `position` integer, required
          - `price` string, required
          - `rank` integer, required
          - `rating` number, required
          - `review_count` integer, required
          - `snippet` string, required
          - `thumbnail` string, required
          - `title` string, required
          - `type` string, required
          - `url` string, required
        - `search_parameters` object, required
          - `attrs` string, required
          - `cflt` string, required
          - `coordinates` object, required
            - `latitude` number, required
            - `longitude` number, required
          - `device` string, required
          - `engine` string, required
          - `l` string, required
          - `language` string, required
          - `limit` integer, required
          - `location` string, required
          - `location_not_found` boolean, required: True when Yelp's completed lookup cannot resolve the supplied location. This successful, billable response contains no results, source_result_count is zero, and has_next_page is false.
          - `operation` string, required
          - `page` integer, required
          - `pagination_limit` integer, required: The maximum native business lookup window.
          - `pagination_limited` boolean, required: True when this response reaches the 200-result window and Yelp reports additional results. has_next_page is false at that boundary.
          - `pagination_reason` string, required: stale_cursor means a valid continuation was fetched but its source inventory changed. The HTTP 200 response is billable; keep any verified results and restart pagination.
          - `query` string, required
          - `sort_by` string, required
          - `source` string, required
          - `source_result_count` integer, required: Yelp's reported total business count, which can exceed the accessible 200-result window.
          - `start` number, required
          - `type` string, required
          - `yelp_domain` string, required
        - `serp_features` object[], required
          - `confidence` number, required
          - `engine` string, required
          - `extracted_at` string, required
          - `id` string, required
          - `items` object[], required
            - `link` string, required
            - `product_id` string, required
            - `text` string, required
            - `thumbnail` string, required
            - `title` string, required
          - `links` object[], required
            - `title` string, required
            - `url` string, required
          - `position` object, required
            - `absolute` integer, required
          - `source_result_ids` string[], required
          - `text` string, required
          - `title` string, required
          - `type` string, required
    - GoogleHtmlSearchData
      - `format` union, required
        - ''
        - 'html+br+base64'
      - `content` string, byte, required: Base64-encoded bytes. Decode Base64 first, then decompress the result with Brotli. Available deferred or lazy-loaded thumbnail sources are placed in image src attributes, within size limits; image and video files are not downloaded. When rewrite_links is true, already-resolved opaque Google anchor links use their destination URLs. Unresolved links are preserved.

## Other responses

- `400`: The JSON body, source selection, or continuation is invalid. Locally malformed, forged, expired, or mismatched tokens are rejected before source work and require restarting pagination. A source may also reject an otherwise well-formed selector after acquisition. These errors do not spend a search credit. Source inventory changes discovered during a valid request return a completed response instead.
- `401`: The API token is missing, invalid, expired, or revoked.
- `402`: No credits remain.
- `429`: Account rate limit exceeded.
- `500`: The request could not be completed.

---

[API](https://skmtc.dev/prismcrawl/apis/prismcrawl-api.md) · [All operations](https://skmtc.dev/prismcrawl/apis/prismcrawl-api/llms.txt) · [OpenAPI document](https://skmtc.dev/prismcrawl/apis/prismcrawl-api/revisions/eef17f6c02a5?raw)