yelp.business

beta Standard

One Yelp business by id (Fusion API).

GET /v1/yelp/business

What you get#

One Yelp record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

Also known as: /yelp/business/info on APIs that nest their paths. See Alternatives and equivalents.

What it costs#

Standard · 1 credit for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`business_id`	string	yes	(required)	Yelp business id or alias	max 101 chars; must match `[A-Za-z0-9][A-Za-z0-9_-]{5,100}`; trimmed

Request#

curl "https://api.onekey.dev/v1/yelp/business?business_id=WavvLdfdP6g8aZTtbBQHTw" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Yelp response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": {
    "entity": {
      "id": "WavvLdfdP6g8aZTtbBQHTw",
      "name": "Gary Danko",
      "url": "https://www.yelp.com/biz/gary-danko-san-francisco",
      "stats": {
        "rating": 4.5
      },
      "category": "American (New)"
    },
    "ext": {
      "reviews": 6600,
      "priceLevel": "$$$$",
      "phone": "+14157492060",
      "closed": false
    },
    "place": {
      "address": "800 N Point St",
      "city": "San Francisco",
      "lat": 37.8058,
      "lon": -122.4224
    },
    "media": {
      "thumbnailUrl": "https://s3-media0.fl.yelpcdn.com/bphoto/abc/o.jpg"
    }
  },
  "metadata": {
    "platform": "yelp",
    "endpoint": "business",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`id`	`entity.id`	-
`name`	`entity.name`	-
`url`	`entity.url`	`safeUrl`
`rating`	`entity.stats.rating`	`toNumber`
`review_count`	`ext.reviews`	`toNumber`
`price`	`ext.priceLevel`	-
`phone`	`ext.phone`	-
`location.address1`	`place.address`	-
`location.city`	`place.city`	-
`categories.0.title`	`entity.category`	-
`coordinates.latitude`	`place.lat`	`toNumber`
`coordinates.longitude`	`place.lon`	`toNumber`
`is_closed`	`ext.closed`	`toBoolean`
`image_url`	`media.thumbnailUrl`	`safeUrl`

Caching and freshness#

Fresh for about 30 minutes. Repeat calls in that window are served from cache and are free.
Between 30 minutes and 6 hours the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 day more (marked stale).
A "not found" is remembered for 5 minutes and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	That record does not exist. Free; do not retry.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: beta (not yet verified against the live source).