Search Businesses with Yelp Fusion API

Pipedream makes it easy to connect APIs for Yelp Fusion and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Search Businesses with the Yelp Fusion API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Search Businesses with the Yelp Fusion API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Search Businesses action
1. Connect your Yelp Fusion account
2. Optional- Configure Location
3. Optional- Configure Latitude
4. Optional- Configure Longitude
5. Optional- Configure Search Term
6. Optional- Configure Max Results
7. Optional- Configure Categories
8. Optional- Select one or more Price
9. Optional- Select one or more Attributes
10. Optional- Configure Additional Options
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Search Businesses with Yelp Fusion API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Yelp Fusion

Try it

Search Businesses with Yelp Fusion API on New Submission from Typeform API

Typeform + Yelp Fusion

Try it

Search Businesses with Yelp API on Custom Events from Zoom API

Zoom + Yelp Fusion

Try it

Search Businesses with Yelp Fusion API on New Submission (Instant) from Jotform API

Jotform + Yelp Fusion

Try it

Search Businesses with Yelp Fusion API on New Custom Webhook Events from Stripe API

Stripe + Yelp Fusion

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Search Businesses on Yelp Fusion

Description:Search businesses matching given criteria [See docs here](https://docs.developer.yelp.com/reference/v3_business_search)

Version:0.0.1

Key:yelp-search-businesses

View on GitHub

Code#

import { defineAction } from "@pipedream/types";
import yelp from "../../app/yelp.app.mjs";
import { ConfigurationError } from "@pipedream/platform";
import { ATTRIBUTE_OPTIONS, DOCS, PRICE_OPTIONS, } from "../../common/constants.mjs";
export default defineAction({
    name: "Search Businesses",
    description: `Search businesses matching given criteria [See docs here](${DOCS.searchBusinesses})`,
    key: "yelp-search-businesses",
    version: "0.0.1",
    type: "action",
    props: {
        yelp,
        location: {
            label: "Location",
            description: `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.`,
            type: "string",
            optional: true,
        },
        latitude: {
            label: "Latitude",
            description: `Latitude of the location to search from.
        \\
        Required if \`location\` is not provided. If \`longitude\` is provided, latitude is required too.`,
            type: "string",
            optional: true,
        },
        longitude: {
            label: "Longitude",
            description: `Longitude of the location to search from.
        \\
        Required if \`location\` is not provided. If \`latitude\` is provided, longitude is required too.`,
            type: "string",
            optional: true,
        },
        term: {
            label: "Search Term",
            description: "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.",
            type: "string",
            optional: true,
        },
        maxResults: {
            label: "Max Results",
            description: "The maximum amount of businesses to be listed. Yelp enforces a limit of 1000. Default is 200.",
            type: "integer",
            max: 1000,
            default: 200,
            optional: true,
        },
        categories: {
            label: "Categories",
            description: `Categories to filter the search results with. [See the list of supported categories.](${DOCS.categories}) The category alias should be used (e.g. "discgolf", not "Disc Golf").`,
            type: "string[]",
            optional: true,
        },
        price: {
            label: "Price",
            description: "Pricing levels to filter the search result with.",
            type: "integer[]",
            optional: true,
            options: PRICE_OPTIONS,
        },
        attributes: {
            label: "Attributes",
            description: "Additional filters to return specific search results. If multiple attributes are used, only businesses that satisfy all the attributes will be returned.",
            type: "string[]",
            optional: true,
            options: ATTRIBUTE_OPTIONS,
        },
        additionalOptions: {
            label: "Additional Options",
            description: `Additional parameters to pass in the request, such as \`open_now\`. [See the docs for all the parameters.](${DOCS.searchBusinesses})`,
            type: "object",
            optional: true,
        },
    },
    async run({ $ }) {
        const { additionalOptions, attributes, categories, location, latitude, longitude, maxResults, price, term, } = this;
        if (!(location || (latitude && longitude))) {
            throw new ConfigurationError("Either `location`, or `latitude` and `longitude`, must be provided.");
        }
        const params = {
            $,
            params: {
                attributes: attributes?.join(),
                categories: categories?.join(),
                location,
                latitude,
                longitude,
                term,
                maxResults,
                price: price?.join(),
                ...additionalOptions,
            },
        };
        const response = await this.yelp.searchBusinesses(params);
        const { result: { length } } = response;
        const summary = length
            ? `Listed ${length} business${length === 1
                ? ""
                : "es"}`
            : "No businesses found with the given criteria";
        $.export("$summary", summary);
        return response;
    },
});

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Yelp Fusion	`yelp`	`app`	This component uses the Yelp Fusion app.
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.
Latitude	`latitude`	`string`	Latitude of the location to search from. Required if `location` is not provided. If `longitude` is provided, latitude is required too.
Longitude	`longitude`	`string`	Longitude of the location to search from. Required if `location` is not provided. If `latitude` is provided, longitude is required too.
Search Term	`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.
Max Results	`maxResults`	`integer`	The maximum amount of businesses to be listed. Yelp enforces a limit of 1000. Default is 200.
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").
Price	`price`	`integer[]`	Select a value from the drop down menu:`{ "label": "$", "value": 1 }{ "label": "$$", "value": 2 }{ "label": "$$$", "value": 3 }{ "label": "$$$$", "value": 4 }`
Attributes	`attributes`	`string[]`	Select a value from the drop down menu:`{ "label": "Hot and New - popular businesses which recently joined Yelp", "value": "hot_and_new" }{ "label": "Request a Quote - businesses which actively reply to Request a Quote inquiries", "value": "request_a_quote" }{ "label": "Reservation - businesses with Yelp Reservations bookings enabled on their profile page", "value": "reservation" }{ "label": "Wait List Reservation - businesses with Yelp Wait List bookings enabled on their profile screen (iOS/Android)", "value": "waitlist_reservation" }{ "label": "Deals - businesses offering Yelp Deals on their profile page", "value": "deals" }{ "label": "Gender Neutral Restrooms - businesses which provide gender neutral restrooms", "value": "gender_neutral_restrooms" }{ "label": "Open to All - businesses which are Open To All", "value": "open_to_all" }{ "label": "Wheelchair Acessible - businesses which are Wheelchair Accessible", "value": "wheelchair_accessible" }`
Additional Options	`additionalOptions`	`object`	Additional parameters to pass in the request, such as `open_now`. See the docs for all the parameters.