Yelp API: Search businesses

Runs a Yelp business search and returns one page of results, with Yelp's ranking and ads labelled. Organic rows carry only business_id and alias; only ads carry a populated business (see hydration_note). start must be a multiple of 10. data is null only if Yelp returned no page.

1 credit / requestBilled only on success

Authorization

ApiKeyAuth

x-api-key<token>

In: header

Query Parameters

find_desc*string

What to search for — Yelp's own find_desc. Free text: a category ("coffee", "plumbers") or a business name.

Length1 <= length <= 120

find_loc*string

Where to search — Yelp's own find_loc. Free text, and deliberately not alphabet-restricted or coerced into a format, because people write a location every way there is: "San Francisco, CA", "94110", "Mission District, San Francisco".

Length1 <= length <= 120

start?|

Result offset in steps of 10: 0, 10, 20, and so on. Other values are rejected.

Range0 <= value <= 990

Default0

curl -X GET "https://example.com/v1/yelp/search?find_desc=coffee&find_loc=San+Francisco%2C+CA" \  -H "x-api-key: YOUR_API_KEY"

{  "data": {    "find_desc": "coffee",    "find_loc": "San Francisco, CA",    "start": 0,    "pagination": {      "total_results": 240,      "results_per_page": 10,      "start_result": 0    },    "count": 12,    "organic_count": 10,    "ad_count": 2,    "hydrated_count": 2,    "hydration_note": "Organic rows carry a null searchResultBusiness: Yelp fills that in client-side and serves it to neither the JSON nor the HTML. Use the row's alias with /v1/yelp/business to fetch each business.",    "sections": [      {        "component_type": "searchResultsFooter",        "is_ad_only": true,        "count": 10,        "results": [          {            "business_id": "kHFPKRnQPfBnBMr4XvQKcQ",            "alias": "kissaten-hifi-san-francisco",            "url": "https://www.yelp.com/biz/kissaten-hifi-san-francisco?osq=coffee",            "is_ad": false,            "rank": 3,            "snippet": "string",            "is_hydrated": false,            "business": {              "name": "Kissaten Hi-Fi",              "alias": "kissaten-hifi-san-francisco",              "phone": "(415) 555-0134",              "rating": 4.5,              "review_count": 312,              "review_count_display": "string",              "categories": [                {                  "title": "Coffee & Tea",                  "url": "https://www.yelp.com/search?cflt=coffee&find_loc=San+Francisco"                }              ],              "formatted_address": "600 Guerrero St, San Francisco, CA 94110",              "neighborhoods": [                "Mission District"              ],              "price_range": "$$",              "service_area": "string",              "parent_business": "string",              "alternate_names": [                "string"              ],              "service_offerings_count": 0            }          }        ]      }    ]  }}