What you get#
Onekey exposes Yelp as 5 endpoints behind one API key: 1 endpoint return one record (data is an object) and 4 endpoints return a list (data is an array). Every answer uses the same envelope (success, data, metadata, error), the cost is reported in metadata.credits_charged, and fields are mapped onto the unified schema so the code you write for Yelp also works for the rest of the travel, local & reviews category.
Endpoints#
| Endpoint | What it does | Parameters | Credits | Status |
|---|---|---|---|---|
business | One Yelp business by id (Fusion API). | business_id* | 1 | beta |
reviews | Up to 3 review excerpts of a Yelp business (Fusion API limit). | business_id* | 5 | beta |
search | Search Yelp businesses near a location (Fusion API). | q*, location* | 5 | beta |
search_full | Search Yelp businesses with full business cards. | query*, location*, cursor | 2 | beta needs a pack |
search_suggestions | Yelp search suggestions for a location. | query*, location* | 2 | beta needs a pack |
A * marks a required parameter. Each endpoint name links to its reference page with the full parameter table, caching window and a recorded response.
Make a request#
This calls yelp.business (1 credit, beta). Replace YOUR_API_KEY with your key; sign up, no card. 1,000 free credits cover the open-platform endpoints. Hard-to-reach platforms (X, TikTok, Instagram, Reddit, and others marked on their page) need a verified email and a purchased pack.
curl "https://api.onekey.dev/v1/yelp/business?business_id=WavvLdfdP6g8aZTtbBQHTw" \
-H "x-api-key: YOUR_API_KEY"Fields you get back#
These unified fields come back from Yelp, with the same names as on every other platform. The count is how many of its 5 mapped endpoints return the field; a field the source lacks is null, never missing. 4 platform-specific fields (ext.<name>) come on top, documented on each endpoint page.
| Field | Type | Endpoints |
|---|---|---|
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 |
The full schema is in Unified schema.
Pricing#
Yelp calls cost 1 to 5 credits, flat per endpoint. Free when served from cache (0.2 credit for a cached response over 100 KB). Invalid, failed or not-found calls are not charged. See pricing for credit packs.