/yellowpages/businesses

POST /api/yellowpages/businesses

Price: 5 credits

Get a Yellow Pages business profile by its profile (MIP) URL or path: name, alternate names, categories, customer rating and review count, phone, email, website, address with coordinates, neighborhoods served, description, founding year, hours, payment methods, services, brands, languages, primary photo and logo.

How to use it

Fetch one Yellow Pages business by its profile (MIP) URL or path (e.g. /los-angeles-ca/mip/emergency-rooter-542379108). A bare ypid alone does not resolve — the full city+slug MIP path is required.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• business string required — Yellow Pages business profile (MIP) URL or path (examples: "https://www.yellowpages.com/los-angeles-ca/mip/emergency-rooter-542379108", "/los-angeles-ca/mip/ritz-plumbing-heating-air-electrical-9270807"; minLength: 1)

Response

• @type string (default: "YellowpagesBusiness")
• id string required
• name string required
• alias string nullable
• alt_names array (default: [])
• categories array (default: [])
• category string nullable
• rating number nullable
• review_count integer nullable
• phone string nullable
• email string nullable
• web_url string nullable
• other_urls array (default: [])
• address string nullable
• city string nullable
• state string nullable
• zip_code string nullable
• formatted_address string nullable
• latitude number nullable
• longitude number nullable
• area_served string nullable
• neighborhoods array (default: [])
• description string nullable
• founding_year integer nullable
• hours string nullable
• payment_methods array (default: [])
• services array (default: [])
• brands array (default: [])
• languages array (default: [])
• social_links array (default: [])
• image string nullable
• logo 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 Yellow Pages 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.