Technical Overview
Note: Be sure to read through our API overview before you begin development.
Users of v1.0 of the Yelp API will be able to:
- Find up to the 20 best results for a geographically-oriented search
- Find and display business contact information, overall rating and review totals, and a photo
- Find information about a specific business using its phone number
- Display the three most recent reviews of a business
- Determine accurate neighborhood name information for a particular location
The default output is JSON (JavaScript Object Notation). For more details on JSON and to obtain parsers please reference www.json.org.
Common API Parameters
The following parameter must be included in all API requests:
Required
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| YWSID | string | required | The "Yelp Web Service ID" (ywsid) that was provided when access to the Yelp API was granted. |
Optional
| Name | Data Type | Required / Optional | Description | Potential Values |
|---|---|---|---|---|
| output | string | optional | Enables response to be requested in different formats. If this parameter is not specified the default format of JSON will be used. | "json" - JavaScript Object Notation. "pickle" - serialized python response. "php" - serialized php response |