> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Yelp

> Yelp Fusion API provides access to business search, reviews, ratings, and local business information with rich data for location-based services

![Yelp logo](https://mintcdn.com/composio-preview/11RkPhDhzt1wdr6a/images/toolkits/yelp.svg?fit=max\&auto=format\&n=11RkPhDhzt1wdr6a\&q=85\&s=f92510579d68701f2d175afcfd53bfc9)

* **Category:** reviews
* **Auth:** NO\_AUTH, API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 12
* **Triggers:** 0
* **Slug:** `YELP`
* **Version:** 20261101\_00
* **Instant:** Supported on the latest version. Support varies by tool.

## Tools

> [accordion] Autocomplete Search
>
> **Slug:** `YELP_GET_AUTOCOMPLETE`
>
> Get autocomplete suggestions for businesses, categories, and search terms on Yelp based on partial text input. Returns matching businesses with their Yelp IDs, relevant category suggestions, and additional search term recommendations. Use this action when users are typing search queries and need real-time suggestions to refine their search before executing a full business search. Location coordinates (latitude/longitude) are optional but can improve suggestion relevance for geographic searches.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.021 per successful API call
>
> #### Input Parameters
>
> **text** `string` *required*
>
> Search text to autocomplete. Provide partial business names, categories, or search terms to get suggestions.
>
> **locale** `string`
>
> Locale code in the format \{language\_code}\_\{country\_code}. See Yelp's list of supported locales. Defaults to en\_US.
>
> **latitude** `number`
>
> Latitude of the location to search from. If provided, longitude is also required. Used to refine autocomplete suggestions based on geographic location.
>
> **longitude** `number`
>
> Longitude of the location to search from. If provided, latitude is also required. Used to refine autocomplete suggestions based on geographic location.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Business Details
>
> **Slug:** `YELP_GET_BUSINESS_DETAILS`
>
> Get detailed information about a Yelp business by ID or alias, including location, photos, rating, review count and, when available, hours and phone number. The returned URL is the Yelp listing page.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.021 per successful API call
>
> #### Input Parameters
>
> **locale** `string`
>
> Locale for the business details. Defaults to en\_US.
>
> **business\_id** `string` *required*
>
> IMPORTANT: This is NOT the business name. Must be the unique Yelp business ID (e.g., 'WavvLdfdP6g8aZTtbBQHTw') or URL-friendly alias (e.g., 'north-india-restaurant-san-francisco') obtained from YELP\_SEARCH\_BUSINESSES or YELP\_SEARCH\_BY\_PHONE. Business names like 'Almar Cleaners' or 'Pizza Hut' will be rejected. Use the search action first to find the business and get its ID or alias.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Business Reviews
>
> **Slug:** `YELP_GET_BUSINESS_REVIEWS`
>
> Get reviews for a specific business on Yelp using its business ID or alias. Returns up to 3 review excerpts for the business.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.021 per successful API call
>
> #### Input Parameters
>
> **locale** `string`
>
> Locale for the reviews. Defaults to en\_US. If reviews list is empty but total > 0, the locale may be mismatched — check possible\_languages in the response and set locale explicitly to match.
>
> **sort\_by** `string`
>
> Sort reviews by: yelp\_sort (default), newest, or oldest.
>
> **business\_id** `string` *required*
>
> Yelp business ID or alias. Can be the unique ID or the business alias from search results. Must be obtained first via a business search tool (e.g., search by name or phone); passing a plain business name directly is not supported.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Category Details
>
> **Slug:** `YELP_GET_CATEGORY`
>
> Get detailed information about a specific Yelp category by its alias. Returns category metadata including the human-readable title, parent categories, and country availability lists. Use this action when you need to understand category hierarchies, check category availability by country, or get the proper display name for a category alias. The alias parameter must be a valid Yelp category identifier — use the list categories endpoint to discover available aliases.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.021 per successful API call
>
> #### Input Parameters
>
> **alias** `string` *required*
>
> Yelp category alias that identifies the specific category to retrieve. The alias can be found using the /v3/categories endpoint or from business category lists (e.g., 'restaurants', 'coffee', 'active' for Active Life).
>
> **locale** `string`
>
> Locale for the category details. Defaults to en\_US.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Event Details
>
> **Slug:** `YELP_GET_EVENT`
>
> Get details of a Yelp event by its event ID, including dates, location, cost, attendance counts and, when available, the associated business ID.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.021 per successful API call
>
> #### Input Parameters
>
> **locale** `string`
>
> Locale for the event details in the format of \{language\_code}\_\{country\_code}. See Yelp's list of supported locales. Defaults to en\_US.
>
> **event\_id** `string` *required*
>
> Unique identifier for the event. Event IDs can be obtained from YELP\_SEARCH\_EVENTS or YELP\_GET\_EVENTS\_FEATURED actions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Featured Event
>
> **Slug:** `YELP_GET_FEATURED_EVENT`
>
> Get the featured event for a given location on Yelp. Featured events are chosen by Yelp's community managers and represent notable happenings in the specified area. Use this action when you need to discover the highlighted or recommended event for a specific city, region, or coordinates. The returned `event_site_url` is the Yelp event page, not the event's own external website. Response fields such as `business_id`, `cost`, and `tickets_url` may be null; handle missing values explicitly.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.021 per successful API call
>
> #### Input Parameters
>
> **locale** `string`
>
> Locale for the event details. Defaults to en\_US.
>
> **latitude** `number`
>
> Latitude coordinate for the location. Must be provided with longitude. Provide EITHER 'location' OR both 'latitude' and 'longitude', not both. If both are provided, coordinates take precedence.
>
> **location** `string`
>
> Location to get featured event for. Can be an address, city, state, or zip code. Provide EITHER 'location' OR both 'latitude' and 'longitude', not both. If coordinates are also provided, coordinates will be used instead of location.
>
> **longitude** `number`
>
> Longitude coordinate for the location. Must be provided with latitude. Provide EITHER 'location' OR both 'latitude' and 'longitude', not both. If both are provided, coordinates take precedence.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Review Highlights
>
> **Slug:** `YELP_GET_REVIEW_HIGHLIGHTS`
>
> Get review highlights for a specific business on Yelp using its business ID or alias. Returns summarized key points and themes from customer reviews. IMPORTANT: This endpoint requires Yelp Places API Premium Plan access. Without Premium Plan, requests will return a 403 NOT\_AUTHORIZED error. For basic review access, consider using the Get Business Reviews action instead, which is available on Enhanced and Premium plans. Note: Get Business Reviews returns at most 3 recent reviews per call, while this action synthesizes themes across the full review history.
>
> #### Input Parameters
>
> **count** `integer`
>
> Number of review highlights to return. Maximum is 10.
>
> **business\_id** `string` *required*
>
> Yelp business ID or alias. Use the 'id' or 'alias' field from Search Businesses or Get Business Details response. Examples: unique ID like 'WavvLdfdP6g8aZTtbBQHTw' or alias like 'north-india-restaurant-san-francisco'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Categories
>
> **Slug:** `YELP_LIST_CATEGORIES`
>
> List all Yelp business categories across all locales by default. Returns category aliases, titles, parent relationships, and geographic availability. Use this action when you need to discover valid category aliases for filtering business searches or when building category-based navigation. The locale parameter allows filtering to categories available in specific regions while translating category names to the local language.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.021 per successful API call
>
> #### Input Parameters
>
> **locale** `string`
>
> Locale for filtering and translating category names. Filters to only categories available in the specified locale while translating category titles. Defaults to returning all categories across all locales in English.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search and Chat
>
> **Slug:** `YELP_SEARCH_AND_CHAT`
>
> Chat with Yelp's AI assistant to search for businesses, get recommendations, and ask questions. A chat ID can continue a conversation; responses may include a natural language answer and business data such as ratings, review counts, locations, and attributes.
>
> #### Input Parameters
>
> **query** `string` *required*
>
> Natural language query to ask Yelp's AI assistant. Can be questions about finding businesses (e.g., 'best sushi in Manhattan'), details about specific businesses (e.g., 'what are the hours for Purple Pig Chicago'), or follow-up questions in an ongoing conversation.
>
> **chat\_id** `string`
>
> Optional chat session ID returned from a previous request. Pass this to continue a conversation and maintain context across multiple queries. If not provided, starts a new conversation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Businesses
>
> **Slug:** `YELP_SEARCH_BUSINESSES`
>
> Search Yelp businesses by location, term, categories and other filters, with up to 50 results per call and offset pagination. Results may extend beyond the specified area and exclude businesses without reviews; location-not-found errors are returned as empty results with an explanatory message.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.021 per successful API call
>
> #### Input Parameters
>
> **term** `string`
>
> Search term (e.g. food, restaurants, bars, etc.). If not provided, will search for all businesses.
>
> **limit** `integer`
>
> Number of businesses to return. Maximum is 50.
>
> **price** `string`
>
> Price filter: 1 = \$, 2 = \$\$, 3 = \$\$\$, 4 = \$\$\$\$. Comma-separated for multiple. Must use numeric strings only (e.g., '1,2') — currency symbols or words silently fail. Note: the price field may be absent from some results; guard against missing values to avoid dropping valid businesses.
>
> **locale** `string`
>
> Locale for the search results. Defaults to en\_US.
>
> **offset** `integer`
>
> Offset for pagination. Used to get more results beyond the limit. Hard cap around offset 1000; stop paginating when a page returns fewer items than requested.
>
> **radius** `integer`
>
> Search radius in meters. Maximum is 40000 meters (25 miles). The distance field in results is also in meters and must be converted for display.
>
> **open\_at** `integer`
>
> Filter for businesses open at a specific Unix timestamp.
>
> **sort\_by** `string`
>
> Sort businesses by: best\_match, rating, review\_count, or distance.
>
> **latitude** `number`
>
> Latitude coordinate for search location. Must be provided with longitude. Use coordinates instead of location names for regions where name-based search returns LOCATION\_NOT\_FOUND (e.g., South Africa, most of Africa). Note: unsupported regions may have no business data even with valid coordinates. Provide EITHER 'location' OR both 'latitude' and 'longitude', not both. If both are provided, coordinates take precedence.
>
> **location** `string`
>
> Location to search for businesses. Can be an address, city, state, or zip code. Yelp operates in 32 countries including US, Canada, UK, Australia, Japan, and most of Europe. Countries NOT supported include India, China, South Africa, most of Africa, and parts of Asia - searches in unsupported regions will return LOCATION\_NOT\_FOUND errors for city names. Use coordinates (latitude/longitude) for unsupported regions, though business data may be unavailable. Provide EITHER 'location' OR both 'latitude' and 'longitude', not both. If coordinates are also provided, coordinates will be used instead of location.
>
> **open\_now** `boolean`
>
> Filter for businesses that are open now.
>
> **longitude** `number`
>
> Longitude coordinate for search location. Must be provided with latitude. Use coordinates instead of location names for regions where name-based search returns LOCATION\_NOT\_FOUND (e.g., South Africa, most of Africa). Note: unsupported regions may have no business data even with valid coordinates. Provide EITHER 'location' OR both 'latitude' and 'longitude', not both. If both are provided, coordinates take precedence.
>
> **attributes** `string`
>
> Additional filters. Comma-separated list of attributes.
>
> **categories** `string`
>
> Categories to filter by. Comma-separated list of category aliases.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Business by Phone
>
> **Slug:** `YELP_SEARCH_BY_PHONE`
>
> Search for a business by phone number on Yelp. Returns business data including business\_id, required by YELP\_GET\_BUSINESS\_DETAILS, YELP\_GET\_BUSINESS\_REVIEWS, and YELP\_GET\_REVIEW\_HIGHLIGHTS. Empty results are inconclusive due to incomplete Yelp coverage.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.021 per successful API call
>
> #### Input Parameters
>
> **phone** `string` *required*
>
> Phone number to search for in E.164 format. Must include country code (e.g., +1 for US, +44 for UK). Example: +14159083801 for a US number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Events
>
> **Slug:** `YELP_SEARCH_EVENTS`
>
> Search for events on Yelp by location, categories, and other filters. Returns events happening in the specified area with details like time, cost, and attendance. Use this action when you need to find local events, activities, or happenings in a specific geographic area. Events can be filtered by category (music, food, sports), cost (free or paid), and time range. Results are sorted by popularity or start time and can be paginated using limit and offset parameters.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Estimated \$0.021 per successful API call
>
> #### Input Parameters
>
> **limit** `integer`
>
> Number of event results to return. By default, it will return 25. Maximum is 50.
>
> **locale** `string`
>
> Locale code in the format of \{language code}\_\{country code}. See the list of supported locales.
>
> **offset** `integer`
>
> Offset the list of returned results by this amount.
>
> **radius** `integer`
>
> Search radius in meters. Maximum is 40000 meters (about 25 miles). If the value is too large, an AREA\_TOO\_LARGE error may be returned.
>
> **is\_free** `boolean`
>
> Filter whether the events are free to attend. By default no filter is applied so both free and paid events will be returned.
>
> **sort\_by** `string ("asc" | "desc")`
>
> Sort order for event results.
>
> **sort\_on** `string ("popularity" | "time_start")`
>
> Field to sort events by.
>
> **end\_date** `integer`
>
> Unix timestamp. Will return events that only end at or before the specified time.
>
> **latitude** `number`
>
> Required if location is not provided. Latitude of the location to search from. If latitude is provided, longitude is required too.
>
> **location** `string`
>
> Required if either latitude or longitude is not provided. Geographic area for searching events. Examples: 'New York City', 'NYC', '350 5th Ave, New York, NY 10118'. Events returned may not be strictly within the specified location.
>
> **longitude** `number`
>
> Required if location is not provided. Longitude of the location to search from. If longitude is provided, latitude is required too.
>
> **categories** `array`
>
> List of category aliases to filter events by.
>
> **start\_date** `integer`
>
> Unix timestamp. Will return events that only begin at or after the specified time.
>
> **excluded\_events** `array`
>
> List of event ids. Events associated with these event ids in this list will not show up in the response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
