# Yelp on Onekey

> 5 endpoints for Yelp (0 stable, 5 beta), 1 to 5 credits each. Category: Travel, local & reviews. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.
Access: 2 of 5 endpoints are marked "needs a pack" or "may need a pack": free-grant credits reach only the open fetch path; a verified email and a purchased pack unlock the rest.

Page: https://onekey.dev/platforms/yelp
Reference (Markdown): https://onekey.dev/docs/api/yelp.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 5 mapped Yelp endpoints return each:

- `entity.name` (string): 4
- `entity.stats.rating` (number): 4
- `entity.id` (string): 3
- `entity.url` (URL): 3
- `media.thumbnailUrl` (URL): 3
- `entity.category` (string): 2
- `place.address` (string): 2
- `place.city` (string): 2
- `place.lat` (number): 2
- `place.lon` (number): 2
- `author.username` (string): 1
- `content.createdAt` (ISO 8601 date): 1
- `content.id` (string): 1
- `content.text` (string): 1
- `content.url` (URL): 1
- `entity.description` (string): 1
- `entity.stats.ratingCount` (integer): 1
- `entity.type` (string): 1
- plus 4 platform-specific fields under `ext.`

## Endpoints

### yelp.business

One Yelp business by id (Fusion API).
- Price: 1 credit per fresh call. Status: beta. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/yelp/business?business_id=WavvLdfdP6g8aZTtbBQHTw` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `business_id` (string, required): Yelp business id or alias
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.stats.rating`, `place.address`, `place.city`, `entity.category`, `place.lat`, `place.lon`, `media.thumbnailUrl`, `ext.reviews`, `ext.priceLevel`, `ext.phone`, `ext.closed`
- Reference: https://onekey.dev/docs/api/yelp/business.md

### yelp.reviews

Up to 3 review excerpts of a Yelp business (Fusion API limit).
- Price: 5 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/yelp/reviews?business_id=WavvLdfdP6g8aZTtbBQHTw` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `business_id` (string, required): Yelp business id or alias
- Fields returned: `content.id`, `content.text`, `content.url`, `content.createdAt`, `author.username`, `entity.stats.rating`
- Reference: https://onekey.dev/docs/api/yelp/reviews.md

### yelp.search

Search Yelp businesses near a location (Fusion API).
- Price: 5 credits per fresh call. Status: beta. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/yelp/search?q=sushi&location=San%20Francisco%2C%20CA` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search term
  - `location` (string, required): Location text, e.g. 'San Francisco, CA'
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.stats.rating`, `place.address`, `place.city`, `entity.category`, `place.lat`, `place.lon`, `media.thumbnailUrl`, `ext.reviews`, `ext.priceLevel`, `ext.phone`, `ext.closed`
- Reference: https://onekey.dev/docs/api/yelp/search.md

### yelp.search_full

Search Yelp businesses with full business cards.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/yelp/search_full?query=headphones&location=New%20York%2C%20NY` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `query` (string, required): Search query
  - `location` (string, required): City or location text
  - `cursor` (string, optional): Opaque cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
- Fields returned: `entity.id`, `entity.name`, `entity.url`, `entity.description`, `entity.stats.rating`, `entity.stats.ratingCount`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/yelp/search_full.md

### yelp.search_suggestions

Yelp search suggestions for a location.
- Price: 2 credits per fresh call. Status: beta. Access: needs a pack. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/yelp/search_suggestions?query=headphones&location=New%20York%2C%20NY` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `query` (string, required): Search query
  - `location` (string, required): City or location text
- Fields returned: `entity.name`, `entity.type`
- Reference: https://onekey.dev/docs/api/yelp/search_suggestions.md

## Sample request

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