yelp

Get a Yelp business by encid

Returns a unified Place for one Yelp business: name, alias URL, unrounded star rating on a 5-star scale, exact review count, price level, address, coordinates, categories, photos, and timezone. Identify the business by its 22-character Yelp encid (id). A Yelp URL works only when the /biz/ segment is that encid; alias slugs return 404 (auto-refunded). Phone is not present on the upstream payload. To find an encid, start from GET /v1/yelp/search.

get/yelp/business/info

Request

  • Base URL: https://www.socialcrawl.dev/v1
  • URL: https://www.socialcrawl.dev/v1/yelp/business/info
  • Auth: API key in header x-api-key

Query parameters

idstring

Yelp business encid, the 22-character opaque id (for example zj8Lq1T8KIC5zwFief15jg for Prince Street Pizza). Alias slugs such as prince-street-pizza-new-york-2 are not accepted on this surface: they come back as not found. (one of: id, url; at least one required)

urlstring

Yelp business URL. Only URLs whose /biz/ segment is the 22-character encid resolve. Alias URLs such as https://www.yelp.com/biz/prince-street-pizza-new-york-2 come back as not found. (one of: id, url; at least one required)

Headers

Cache-Controlstring

Send no-cache to bypass the response cache and force a live fetch. Billed at the normal endpoint cost; the fresh result is written back to cache for the next caller. Only the no-cache directive triggers this. See the Response Schema guide for details.

Idempotency-Keystring

Optional UUID that makes the request safely retriable. The key is reserved atomically per account before billing. A concurrent retry receives 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After of 1 second while the original is young, growing to a quarter of the time it has been running (at most 30); a crashed reservation expires after 5 minutes. A replay keeps the cached payload immutable except for billing metadata: credits_used becomes 0, idempotent_replay becomes true, and credits_remaining is refreshed to the current balance. A known current balance appears in both the body and X-Credits-Remaining header; no balance row resolves to 0. On a transient lookup failure, body credits_remaining is null and X-Credits-Remaining is omitted. Completed outcomes expire after 24 hours. If the claim store is unavailable, the request fails closed before billing. GET endpoints do not combine idempotent replay with Server-Sent Events: use Accept: application/json when sending this header. The unsupported key-plus-SSE combination is rejected before billing.

Response

Successful response

successboolean required

Whether the request succeeded

platformstring required

Platform name

endpointstring required

API endpoint path

credits_usedinteger required

Number of credits consumed

credits_remaininginteger nullable required

Current account balance, or null when this response could not establish one. Free cache hits always return null because they do not establish an authoritative post-request balance. An idempotency replay also returns null when its current-balance lookup fails. It is never a fabricated zero, so a zero here means the account really is empty. The authoritative reading is the one on a billed response, which comes straight from the deduction.

request_idstring required

Unique request identifier for support

cachedboolean required

Whether the response was served from cache

idempotent_replayboolean

True only when this response is an idempotency replay

Example response

{
  "success": true,
  "platform": "yelp",
  "endpoint": "/v1/yelp/business/info",
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "req-abc123",
  "idempotent_replay": true,
  "meta": {
    "hint": {
      "code": "search_multi",
      "message": "You searched \"matcha\" on 3 platforms one call at a time; /v1/search/multi returns each platform's own search rows in one call at the same price per platform, and a platform with no rows is not charged.",
      "method": "GET",
      "path": "/v1/search/multi?query=matcha&platforms=instagram,tiktok,youtube"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.