/yelp/businesses/photos

POST /api/yelp/businesses/photos

Price: 20 credits

Get photos and videos posted for a Yelp business by alias, business id or business page URL, in the order the business page shows them. Returns media URL, thumbnail, caption, subject keywords, pixel size, upload time, like count, the review the media is attached to and the uploading Yelp user.

How to use it

Fetch the photo and video gallery of one Yelp business. business accepts an alias, a business id or a https://www.yelp.com/biz/... URL. Each item has id, media_type (photo/video), url (full-size image or mp4), thumbnail, caption, keywords (what the media shows, e.g. food/interior/menu), width/height, created_at (unix seconds), like_count, review_id (the review the media was attached to, if any) and uploader (Yelp user id, name, image, review_count, friend_count, photo_count).

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"; minLength: 1)
• count integer required — Max number of media items to return (min: 1)

Response

• @type string (default: "YelpBusinessPhoto")
• id string required
• media_type string (default: "photo"; one of: "photo", "video")
• url string nullable
• thumbnail string nullable
• caption string nullable
• keywords array (default: [])
• width integer nullable
• height integer nullable
• created_at integer nullable
• like_count integer nullable
• review_id string nullable
• uploader object nullable
  • @type string (default: "YelpPhotoUploader")
  • id string required
  • name string nullable
  • image string nullable
  • review_count integer nullable
  • friend_count integer nullable
  • photo_count integer nullable

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.