Yelp

Search for businesses on Yelp

Changed on Nov 21, 2024

Search for businesses on Yelp given a query, location, and other criteria

post/yelp/search-businesses

Request

Base URL
https://api.exfunc.dev
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/carvedai/apis/exfunc-apis/docs/yelp/search-businesses/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

querystring required

The search term to find businesses

locationstring required

The location to search for businesses

sort_by'recommended' | 'highest_rated' | 'review_count'

The criteria to sort the results (e.g., "recommended", "highest_rated", etc.)

startinteger

The starting index for pagination (default is 0)

countinteger

The number of businesses to retrieve

Response

SearchBusinesses API successful response

Changes

Nov 21, 20249d3028e39d19 Revision changes
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status
- info
  added the new optional request property

Operation history