← Yelp

Search Businesses with Yelp API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Search Businesses with the Yelp API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
4 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

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

  1. Configure the Search Businesses action
    1. Connect your Yelp 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
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Search Businesses with Yelp API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Yelp
 
Try it
Search Businesses with Yelp API on New Submission from Typeform API
Typeform + Yelp
 
Try it
Search Businesses with Yelp API on Custom Events from Zoom API
Zoom + Yelp
 
Try it
Search Businesses with Yelp API on New Submission (Instant) from Jotform API
Jotform + Yelp
 
Try it
Search Businesses with Yelp API on New Custom Webhook Events from Stripe API
Stripe + Yelp
 
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
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

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.
LabelPropTypeDescription
YelpyelpappThis component uses the Yelp app.
Locationlocationstring

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.

Latitudelatitudestring

Latitude of the location to search from.

Required if location is not provided. If longitude is provided, latitude is required too.

Longitudelongitudestring

Longitude of the location to search from.

Required if location is not provided. If latitude is provided, longitude is required too.

Search Termtermstring

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 ResultsmaxResultsinteger

The maximum amount of businesses to be listed. Yelp enforces a limit of 1000. Default is 200.

Categoriescategoriesstring[]

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").

Pricepriceinteger[]Select a value from the drop down menu:{ "label": "$", "value": 1 }{ "label": "$$", "value": 2 }{ "label": "$$$", "value": 3 }{ "label": "$$$$", "value": 4 }
Attributesattributesstring[]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 OptionsadditionalOptionsobject

Additional parameters to pass in the request, such as open_now. See the docs for all the parameters.

Authentication

Yelp uses API keys for authentication. When you connect your Yelp account, Pipedream securely stores the keys so you can easily authenticate to Yelp APIs in both code and no-code steps.

To retrieve your API key for Yelp,

  • Navigate to your Yelp account and sign in
  • Go to “General” > “Manage App”

About Yelp

Connecting people with great local businesses.

More Ways to Use Yelp

Actions

Get Business Details with the Yelp API

Get details about a business See docs here

 
Try it
List Business Reviews with the Yelp API

List the reviews for a business See docs here

 
Try it
Search Businesses By Phone Number with the Yelp API

Search businesses by phone number See docs here

 
Try it

Explore Other Apps

1
-
24
of
2,000+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Salesforce (REST API)
Salesforce (REST API)
Web services API for interacting with Salesforce
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify Developer App
Shopify Developer App
Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Snowflake
Snowflake
A data warehouse built for the cloud
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.