Yelp关键词搜索 API

POST

接口健康状态

24h 健康值
正常
24h 平均耗时
—
  • 健康 / 正常
  • 可用
  • 少量可用
  • 基本不可用
正常

关键词搜索:返回列表,默认 10 条、单次最多 50 条;主要字段 id、name、url、rating、rating_scale、review_count。

单价 $1.39 / 千次(每次 $0.001389),失败与空结果不扣费。 同步返回;慢任务可在请求体加 "mode": "async",先拿 job_id 再轮询。

AI 提示词

复制下面这段给你常用的 AI 助手:里面写好了这个接口的参数、返回字段和示例请求,它会先问清你的需求,再帮你写采集脚本。

请帮我用 EveryInfra 的「Yelp 关键词搜索」接口(yelp/search)写一个数据采集脚本。

接口约定:
- 请求:POST https://api.everyinfra.com/api/v1/social,请求头 Authorization: Bearer <API Key>;Key 从环境变量 EVERYINFRA_API_KEY 读取,不要写进代码。
- 请求体里 platform 填 yelp,action 填 search,参数放在 params 里。
- 必填参数:
  - keyword:本地商户或服务关键词,例如 coffee;需要结合 location,否则默认在 New York 搜索,并非全球检索。
- 可选参数:
  - location:城市、街区或邮编位置,例如 Austin, TX 或 78701;这是商户所在地,不是评论作者位置。
  - limit:这次调用最多返回的条数,整数,1–50;不传按默认值,实际返回可能少于这个数。超过上限会在扣费前返回 422。(默认 10)
- 返回一组记录,每条记录的主要字段:id、name、url、rating、rating_scale、review_count、price_range(价位档($ 到 $$$$))、phone、website、categories(商家分类)、cuisine(菜系)、description;一共 26 个字段,完整列表见 https://api.everyinfra.com/api/v1/social/catalog?platform=yelp。
- 示例请求体:
{
  "platform": "yelp",
  "action": "search",
  "params": {
    "keyword": "coffee"
  }
}
- 计费:$1.39 / 千次;失败和空结果不扣费。
- 一次要采几十上百个时,在请求体加 "mode": "async":先拿到 job_id,再轮询 GET https://api.everyinfra.com/api/v1/jobs/{job_id} 取结果。
- 返回 422 时,按错误信息里的候选参数和允许值修正;返回 429 或 503 时,按 Retry-After 等待后重试。

写代码前,先问清楚我要采哪些对象、一共多少个、需要哪些字段、结果存成什么格式,再把方案和大概花费讲给我确认。

请求参数

参数名位置类型必填默认值说明
Authorizationheaderstring是-Bearer 加你的 API Key。在控制台创建;不要放进网址或代码仓库。
platformbodystring是yelp平台标识,固定值。
actionbodystring是search能力标识,固定值。
keywordbody.params未声明是-本地商户或服务关键词,例如 coffee;需要结合 location,否则默认在 New York 搜索,并非全球检索。
locationbody.params未声明否-城市、街区或邮编位置,例如 Austin, TX 或 78701;这是商户所在地,不是评论作者位置。
limitbody.paramsinteger (1–50)否10这次调用最多返回的条数,整数,1–50;不传按默认值,实际返回可能少于这个数。超过上限会在扣费前返回 422。

代码示例

bash
curl -X POST 'https://api.everyinfra.com/api/v1/social' \
  -H "Authorization: Bearer $EVERYINFRA_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "platform": "yelp",
  "action": "search",
  "params": {
    "keyword": "coffee"
  }
}'

[OpenAPI 定义 (JSON)]示例从环境变量 EVERYINFRA_API_KEY 读取 Key,复制出去的代码不含你的 Key。

这里填写商家类别或名称;地点条件按该接口的地区参数设置。

响应示例

字段预览

这组示例参数还没有真实样例:这里只按契约列出响应结构和字段,值用 … 占位,不是一次真实调用的结果。

json
{
  "id": "req_…",
  "platform": "yelp",
  "action": "search",
  "results": [
    {
      "id": …,
      "name": …,
      "url": …,
      "rating": …,
      "rating_scale": …,
      "review_count": …,
      "price_range": …,
      "phone": …,
      "website": …,
      "categories": …,
      "cuisine": …,
      "description": …,
      "address": …,
      "city": …,
      "region": …,
      "postal_code": …,
      "country": …,
      "is_claimed": …,
      "is_verified": …,
      "health_score": …,
      "established_year": …,
      "image_url": …,
      "platform": …,
      "images": …,
      "amenities": …,
      "highlights": …,
      "hours": …
    }
  ],
  "count": …,
  "billing": {
    "charged": …,
    "charged_usd": …,
    "balance_after_usd": …,
    …
  },
  "quota": { … }
}

返回字段

业务数据在 results 里;下表是每条记录可能包含的字段,平台没有提供的值不会被补造。

字段含义
id该记录在原平台上的唯一标识。仅在同一平台内唯一,跨平台可能重复。
name名称。用于账号/商品/商家类能力,指该对象本身的名字。
url该记录在原平台上的可访问链接。
rating评分。分制随平台而异,同一行的 rating_scale 给出该平台满分 (多数是 5,Booking/豆瓣/爱奇艺/NAVER 是 10)。跨平台比较前必须先按 rating_scale 换算 —— 直接比数字会得出反的结论。
rating_scale上一列 rating 的满分。5 表示五星制、10 表示十分制。只在该行有 rating 时出现。
review_count评价条数,用于商品/商家类能力。null 表示不公开,不等于 0。
price_range价位档($ 到 $$$$)。
phone联系电话,原文透传,未做号码格式归一。
website账号或商家填写的外链网址。
categories商家分类。
cuisine菜系。
description简介或描述,通常比 text 短。
address详细地址,原文透传。
city城市名,用原平台的语言书写,未做中英归一。
region区域。
postal_code邮编。
country国家或地区。可能是全称也可能是 ISO 代码,取决于平台,未归一。
is_claimed商家是否已认领主页。未认领说明店家不运营 Yelp,信息可能过时。
is_verified是否为平台认证账号(蓝V等)。null 表示无法判定。
health_score卫生检查评分(政府数据,餐厅类才有)。
established_year开业年份。
image_url图片链接。多图能力可能返回 image_urls 数组。
platform数据来源平台标识,与请求里的 platform 一致(如 xiaohongshu、tiktok)。
images图片链接数组,按平台展示顺序;没有图片时不出现这个字段。
amenities设施与服务列表,按 Yelp 页面原文;没有时不出现这个字段。
highlightsYelp 页面上的商家亮点标签,按页面原文;没有时不出现这个字段。
hours营业时间,键是星期几的缩写(如 Mon),值是当天的营业时段原文;没有时不出现这个字段。

错误与计费

401
缺少 Key 或 Key 无效。先鉴权再校验参数,未鉴权的请求拿不到参数结构。
422
参数名或取值不对。错误信息会列出这项能力支持的参数、允许值和最接近的候选,按它改即可;发生在扣费之前。
402
余额不足,请先充值。
429
超过账户的每分钟请求上限(名下所有 Key 合计;Key 自设了更低上限时先按它算),按 Retry-After 等待后再试。需要更高上限可在控制台买提速包。
503
暂时无法完成。已预扣的费用按原账本退回;响应里的 billing 与 refund 写明实际结果,结果未知时会明确标出,不要直接重发。
200 空结果
请求完成但没有数据,不扣费(billing.reason = empty_result_refunded)。