/yelp/businesses

POST /api/yelp/businesses

Price: 5 credits

Get full Yelp business details by alias, business id or business page URL: name, the owner's own description and history, rating, review count, price range, phone, postal address, coordinates, categories, weekly opening hours, open/closed state, amenity attributes and photos.

How to use it

Fetch one Yelp business by alias ('molinari-delicatessen-san-francisco'), business id ('FmGF1B-Rpsjq1f5b56qMwg') or a full https://www.yelp.com/biz/... URL. Returns id, alias, url, name, description, history, established_year, owner_name and owner_bio (what the business says about itself), image/images, rating, review_count, price_range ($ to $$$$), phone, address (line1/line2/line3/city/region_code/postal_code/country_code), latitude/longitude, categories (alias + title + root_alias), is_closed (permanently closed), is_open_now, hours per weekday and attributes (credit cards, parking, wheelchair access, outdoor seating, delivery, reservations and more). Use photo_count to control how many photo URLs come back.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• business string required — Yelp business alias, business id or a business page URL (examples: "molinari-delicatessen-san-francisco", "FmGF1B-Rpsjq1f5b56qMwg", "https://www.yelp.com/biz/tonys-pizza-napoletana-san-francisco"; minLength: 1)
• photo_count integer — Max number of business photos to return (default: 10; min: 0)

Response

• @type string (default: "YelpBusiness")
• id string required
• alias string required
• url string required
• name string nullable
• description string nullable
• history string nullable
• established_year integer nullable
• owner_name string nullable
• owner_bio string nullable
• image string nullable
• images array (default: [])
• rating number nullable
• review_count integer nullable
• price_range string nullable
• phone string nullable
• address object nullable
  • @type string (default: "YelpBusinessAddress")
  • line1 string nullable
  • line2 string nullable
  • line3 string nullable
  • city string nullable
  • region_code string nullable
  • postal_code string nullable
  • country_code string nullable
• latitude number nullable
• longitude number nullable
• categories array (default: [])
  • @type string (default: "YelpBusinessCategory")
  • id string required
  • alias string required
  • category_title string nullable
  • root_alias string nullable
• is_closed boolean nullable
• is_open_now boolean nullable
• hours array (default: [])
  • @type string (default: "YelpBusinessHours")
  • day_of_week string required
  • hours array (default: [])
  • has_special_hours boolean nullable
• attributes array (default: [])
  • @type string (default: "YelpBusinessAttribute")
  • alias string required
  • is_enabled boolean nullable
  • values array (default: [])

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Business not found (well-formed identifier but no such Yelp business) Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.