APIドキュメントは英語で提供しています。

Yelp Place

Get a Yelp business's details and menu.

GET/api/v1/yelp/place

Costs 1 credit per request; failed requests are refunded. Authentication, the search_metadata envelope and error codes are the same as for every endpoint (see the API reference). Try it in the playground.

Parameters

Place details

Resolve a Yelp business and its menu.

ParameterTypeDescription
place_idrequiredstringRequired Yelp encoded business ID or business alias.
yelp_domainstringSupported localized Yelp hostname.Default: www.yelp.com.
business_alertbooleanInclude business alert information when available.Default: false.
full_menubooleanFetch the full menu when available; otherwise return place details with an explanation.Default: false.
menu_namestringSelect a named menu when more than one is available. Requires full_menu=true.

Response

A JSON object with search_metadata (request id, credits used and remaining) and the result data: place_results. Groups and fields depend on the content of each page, so treat every field as optional.

Examples

cURL
curl "https://serpfast.com/api/v1/yelp/place?place_id=arabica-brooklyn" \
  -H "Authorization: Bearer $SERPFAST_KEY"
Node.js 18+
const params = new URLSearchParams({
  "place_id": "arabica-brooklyn"
});
const res = await fetch(`https://serpfast.com/api/v1/yelp/place?${params}`, {
  headers: { Authorization: `Bearer ${process.env.SERPFAST_KEY}` },
});
const data = await res.json();
console.log(data);
Python
import os, requests

params = {
  "place_id": "arabica-brooklyn"
}
res = requests.get(
    "https://serpfast.com/api/v1/yelp/place",
    params=params,
    headers={"Authorization": f"Bearer {os.environ['SERPFAST_KEY']}"},
    timeout=120,
)
print(res.json())