Description Usage Arguments Value Examples
These endpoints let you match business data from other sources against businesses on Yelp, based on minimal provided information. There are two different ways to do this:
best match: This will only return 1 business that is the best match based on the information provided.
lookup: This will return up to 10 businesses that are the best matches based on the information provided. Both endpoints have the same parameters and return the same response structure.
1 | business_match_name(api_key, type = "lookup", name, city, state, country, ...)
|
api_key |
string |
type |
string. 'best match' or 'lookup' |
name |
string. The name of the business. Maximum length is 64 |
city |
string. The city of the business. Maximum length is 64 |
state |
string. The ISO 3166-2 with a few exceptions state code of this business. Maximum length is 3. |
country |
string. Required. The ISO 3166-1 alpha-2 country code of this business. Maximum length is 2 |
... |
optional parameters |
businesses: List of Yelp businesses matching the inputs
1 2 3 4 5 6 7 | key <- "######"
business_match_name(key, "lookup",
name = "Good",
city = "San Francisco",
state = "CA",
country = "US",
postal_code = "12345")
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.