/yell/businesses

POST /api/yell/businesses

Price: 10 credits

Get a Yell business profile by its URL or path: name, tagline, description, category, customer rating and review count, phone, website, social links, opening hours, payment methods, services, address with coordinates, logo, photos and recent customer reviews.

How to use it

Fetch one Yell (UK directory) business by its profile URL or path (e.g. /biz/plumbingforce-whyteleafe-8359634/). Returns id, name, alias, tagline, description, category, rating, review_count, phone, phone_secondary, website, social_links, opening_hours, payment_methods, services, address/city/postcode/region, latitude/longitude, image (logo), images (photos), reviews and profile_url.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• business string required — Yell business profile URL or path (examples: "https://www.yell.com/biz/v-i-hains-plumbing-and-gas-services-ltd-london-7514839/", "/biz/plumbingforce-whyteleafe-8359634/"; minLength: 1)

Response

• @type string (default: "YellBusiness")
• id string required
• name string required
• alias string nullable
• tagline string nullable
• description string nullable
• category string nullable
• rating number nullable
• review_count integer nullable
• phone string nullable
• phone_secondary string nullable
• website string nullable
• social_links array (default: [])
• opening_hours array (default: [])
  • @type string (default: "YellOpeningHours")
  • day string required
  • opens string nullable
  • closes string nullable
• payment_methods array (default: [])
• services array (default: [])
• address string nullable
• city string nullable
• postcode string nullable
• region string nullable
• latitude number nullable
• longitude number nullable
• image string nullable
• images array (default: [])
• reviews array (default: [])
  • @type string (default: "YellReview")
  • id string required
  • author string nullable
  • rating number nullable
  • text string nullable
  • created_at string nullable
  • business_response string nullable
  • business_response_at string nullable
• profile_url string 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 profile URL with no Yell listing) 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.