• Installs:
  • Today: 14337
  • All Time: 1419696
Developer:userserg.osipchuk

YelpAPI API Package

Access local businesses data from the Yelp database.

List of Endpoints
This is the list of endpoints this API includes. To add any of the endpoints to your app, please click on “Connect to endpoint” text.
See All
Discussions
user thumbnail
animeshkumar9608: How to call to get Accesstoken ...
user thumbnail
aloy42: yelp updated the way you authenticate ...
user thumbnail
AnkushSharma26: Oauth Token End Point Is Depricated How To solve this Problem? ...
user thumbnail
AnkushSharma26: Oauth Token End Point Is Depricated How To solve this Problem? ...
user thumbnail
TruJared: typo in word 'bussinessId' ...
user thumbnail
collid5: Need help grabbing data for YELP Reviews ...
See All
Readme

YelpAPI

YelpAPI Package

Yelp's Fusion API allows you to get the best local business information and user reviews of over million businesses in 32 countries.

  • Domain: yelp.com
  • Credentials: appId, appSecret

How to get credentials:

  1. Sign up or Log in to Yelp
  2. Go to Create App
  3. In the create new app form, enter information about your app accordingly, then agree to Yelp API Terms of Use and Display Requirements. Then click the Submit button.
  4. Now you can get the App ID and App Secret.

TOC:

<a name="getAccessToken"/>

YelpAPI.getAccessToken

Allows to get an access token.

FieldTypeDescription
appIdcredentialsRequired: Your App ID obtained from Yelp.
appSecretcredentialsRequired: Your App Secret obtained from Yelp.

<a name="getBusinesses"/>

YelpAPI.getBusinesses

This endpoint returns up to 1000 businesses based on the provided search criteria. It has some basic information about the business.

FieldTypeDescription
accessTokenStringRequired: Access Token obtained from getAccessToken endpoint.
termStringOptional: Search term (e.g. "food", "restaurants"). If term isn’t included we search everything. The term keyword also accepts business names such as "Starbucks".
locationStringOptional: Required if either latitude or longitude is not provided. Specifies the combination of "address, neighborhood, city, state or zip, optional country" to be used when searching for businesses.
latitudeStringOptional: Required if location is not provided. Latitude of the location you want to search near by.
longitudeStringOptional: Required if location is not provided. Latitude of the location you want to search near by.
radiusStringOptional: Search radius in meters. If the value is too large, a AREA_TOO_LARGE error may be returned. The max value is 40000 meters (25 miles).
categoriesStringOptional: Categories to filter the search results with. See the list of supported categories. The category filter can be a list of comma delimited categories. For example, "bars,french" will filter by Bars and French. The category identifier should be used (for example "discgolf", not "Disc Golf").
localeStringOptional: Specify the locale to return the business information in.
limitStringOptional: Number of business results to return. By default, it will return 20. Maximum is 50.
offsetStringOptional: Offset the list of returned business results by this amount.
sortByStringOptional: Sort the results by one of the these modes: best_match, rating, review_count or distance. By default it's best_match. The rating sort is not strictly sorted by the rating value, but by an adjusted rating value that takes into account the number of ratings, similar to a bayesian average. This is so a business with 1 rating of 5 stars doesn’t immediately jump to the top.
priceStringOptional: Pricing levels to filter the search result with: 1 = $, 2 = $$, 3 = $$$, 4 = $$$$. The price filter can be a list of comma delimited pricing levels. For example, "1, 2, 3" will filter the results to show the ones that are $, $$, or $$$.
openNowStringOptional: Default to false. When set to true, only return the businesses open now. Notice that open_at and open_now cannot be used together.
openAtStringOptional: An integer represending the Unix time in the same timezone of the search location. If specified, it will return business open at the given time. Notice that open_at and open_now cannot be used together.
attributesStringOptional: Additional filters to search businesses. You can use multiple attribute filters at the same time by providing a comma separated string, like this "attribute1,attribute2". Currently, the valid values are hot_and_new and deals.

<a name="getSingleBusiness"/>

YelpAPI.getSingleBusiness

This endpoint returns the detail information of a business.

FieldTypeDescription
accessTokenStringRequired: Access Token obtained from getAccessToken endpoint.
bussinessIdStringRequired: The business ID.

<a name="getBusinessesByPhoneNumber"/>

YelpAPI.getBusinessesByPhoneNumber

This endpoint returns a list of businesses based on the provided phone number. It is possible for more than one businesses having the same phone number (for example, chain stores with the same +1 800 phone number).

FieldTypeDescription
accessTokenStringRequired: Access Token obtained from getAccessToken endpoint.
phoneStringRequired: Phone number of the business you want to search for. It must start with + and include the country code, like +14159083801.

<a name="getBusinessesByTransaction"/>

YelpAPI.getBusinessesByTransaction

This endpoint returns a list of businesses which support certain transactions.

FieldTypeDescription
accessTokenStringRequired: Access Token obtained from getAccessToken endpoint.
transactionTypeStringRequired: Valid values for transaction_type are: delivery.
locationStringOptional: Required when latitude and longitude aren't provided. Address of the location you want to deliver to.
latitudeStringOptional: Required when location isn't provided. Latitude of the location you want to deliver to.
longitudeStringOptional: Required when location isn't provided. Longitude of the location you want to deliver to.

<a name="getBusinessReviews"/>

YelpAPI.getBusinessReviews

This endpoint returns the up to three reviews of a business.

FieldTypeDescription
accessTokenStringRequired: Access Token obtained from getAccessToken endpoint.
bussinessIdStringRequired: The business ID.
localeStringOptional: Specify the interface locale; this determines the language of reviews to return.

<a name="getAutocomplete"/>

YelpAPI.getAutocomplete

This endpoint returns autocomplete suggestions for search keywords, businesses and categories, based on the input text.

FieldTypeDescription
accessTokenStringRequired: Access Token obtained from getAccessToken endpoint.
textStringRequired: Text to return autocomplete suggestions for.
latitudeStringRequired: Required if want to get autocomplete suggestions for businesses. Latitude of the location to look for business autocomplete suggestions.
longitudeStringRequired: Required if want to get autocomplete suggestions for businesses. Longitude of the location to look for business autocomplete suggestions.
localeStringOptional: Specify the locale to return the autocomplete suggestions in.
x
circle
YelpAPI
$ / m
We will charge your card every month for the plan amount, as well as any overages incurred in the previous month.
?

Oops, we are missing some details

Looks like there are a few missing details that you haven't filled in yet.
These details are important and will help us protect you and let you know about anything new.

x

Why sign up to RapidAPI?

  • integrate
    Integrate APIs into your app
    Ruby, Java, Elixir, Node.js, Phyton, Objective C, Swift, PHP and MORE
  • keys
    Save all API keys in one place
  • notifications
    Get notifications about API changes
  • stats
    Get stats and monitor API connections
__SING_UP_WITH_GITHUB__
__SING_UP_WITH_FACEBOOK__
__SING_UP_WITH_GOOGLE__
  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Authentication

    Authenticate
    esccloses this view