View as Markdown
Yelp Fusion icon

Yelp Fusion ACTION

Search Businesses

Search businesses matching given criteria See docs here
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Yelp Fusion account once, then configure and run Search Businesses from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "yelp-search-businesses",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    yelp: { authProvisionId: "apn_xxxxxxx" },
    location: "Location",
    latitude: "Latitude",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Search Businesses inputs
Property Type Description
location Location string
The geographic area to be used when searching for businesses. Examples: "New York City", "NYC", "350 5th Ave, New York, NY 10118".
Required if latitude and longitude are not provided.
Optional
latitude Latitude string
Latitude of the location to search from.
Required if location is not provided. If longitude is provided, latitude is required too.
Optional
longitude Longitude string
Longitude of the location to search from.
Required if location is not provided. If latitude is provided, longitude is required too.
Optional
term Search Term string
Search term, e.g. "food" or "restaurants". The term may also be the business's name, such as "Starbucks". If term is not included, the action will default to searching across businesses from a small number of popular categories.
Optional
maxResults Max Results integer
The maximum amount of businesses to be listed. Yelp enforces a limit of 1000. Default is 200.
Optional
categories Categories string[]
Categories to filter the search results with. See the list of supported categories. The category alias should be used (e.g. "discgolf", not "Disc Golf").
Optional
price Price integer[]
Pricing levels to filter the search result with.
Optional
attributes Attributes string[]
Additional filters to return specific search results. If multiple attributes are used, only businesses that satisfy all the attributes will be returned.
Optional
additionalOptions Additional Options object
Additional parameters to pass in the request, such as open_now. See the docs for all the parameters.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
yelp-search-businesses
Version
0.0.2
App
Yelp Fusion
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes