GuidesAPI ReferenceGraphQLChangelogManage API AccessCreate Yelp Account
API Reference

Business Match

get
https://api.yelp.com/v3/businesses/matches

This endpoint lets you match business data from other sources against businesses on Yelp, based on provided business information.
For example, if you know a business's exact address and name, and you want to find that business only on Yelp.

When should you use the Business Match endpoint?
We have several endpoints that will return information on Yelp businesses. You should pick the endpoint to use based on how specific your input information is.

All of these endpoints return the same information about each business.

Note: at this time, the API does not return businesses without any reviews.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

📘

This endpoint is part of Yelp Places API, visit Yelp Places API to learn more.

Query Params
string
required
length ≤ 64

The name of the business. Only digits, letters, spaces, and !#$%&+,./:?@'are allowed.

string
required
length ≤ 64

The first line of the business's address. Only digits, letters, spaces, and '/#&,.: are allowed. An empty string is allowed; this will specifically match certain service businesses that have no street address.

string
length ≤ 64

The second line of the business's address. Only digits, letters, spaces, and '/#&,.: are allowed.

string
length ≤ 64

The third line of the business's address. Only digits, letters, spaces, and '/#&,.: are allowed.

string
required
length between 1 and 64

The city of the business. Only digits, letters, spaces, and '.() are allowed.

string
required
length between 1 and 3

The ISO 3166-2 (with a few exceptions) state code of this business.

string
required
length between 2 and 2

The ISO 3166-1 alpha-2 country code of this business.

string
length ≤ 12

The Zip code of this business.

number
-90 to 90

Required, if location is not provided. Latitude of the location to search from. If latitude is provided, longitude is required too.

number
-180 to 180

Required if location is not provided. Longitude of the location to search from. If longitude is provided, latitude is required too.

string
length between 1 and 32

The phone number of the business which can be submitted as
(a) locally formatted with digits only (e.g., 016703080) or
(b) internationally formatted with a leading + sign and digits only after (+35316703080).

string
length between 22 and 22

Unique Yelp identifier of the business if available. Used as a hint when finding a matching business.

integer
1 to 10
Defaults to 3

Number of results to return.

string
enum
Defaults to default

Specifies whether a match quality threshold should be applied to the matched businesses. Must be one of the following.
none: Do not apply any match quality threshold; all potential business matches will be returned.
default: Apply a match quality threshold such that only very closely matching businesses will be returned.
strict: Apply a very strict match quality threshold.

Allowed:
Responses

Updated 8 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago