用店名与地点试查 Yelp 商家
从控制台获取你有权使用的平台 API 密钥,将示例中的 <API_KEY> 替换为该密钥。请求 URL 含密钥,请勿放入公开链接、截图、代码仓库或日志;生产环境建议由服务端发起请求。
只读示例调用 quick-search,使用 location=San Francisco, CA、query=Golden Boy Pizza、limit=3,最多查找 3 个商家候选,无需 Yelp 账号凭据。候选可能包含同名分店或邻近城市,需核对地址;当前可用性、返回条数与字段不作保证。打开页面、切换页面、展开面板或复制示例都不会发送数据请求。
基础 URL https://api.opendata-api.com
curl -X GET 'https://api.opendata-api.com/api/project/yelp/quick-search?key=<API_KEY>&limit=3&location=San+Francisco%2C+CA&query=Golden+Boy+Pizza'import requests
response = requests.request(
"GET",
"https://api.opendata-api.com/api/project/yelp/quick-search",
params={
"key": "<API_KEY>",
"limit": "3",
"location": "San Francisco, CA",
"query": "Golden Boy Pizza",
},
timeout=30,
)
response.raise_for_status()
print(response.json())const url = new URL("https://api.opendata-api.com/api/project/yelp/quick-search");
url.search = new URLSearchParams({
"key": "<API_KEY>",
"limit": "3",
"location": "San Francisco, CA",
"query": "Golden Boy Pizza",
}).toString();
const response = await fetch(url, {
method: "GET",
});
if (!response.ok) throw new Error(`HTTP ${response.status}`);
console.log(await response.json());请求前先确认
- 同一店名可能匹配多个分店或邻近城市。对照返回的商家 ID、别名、名称和详细地址后,再查询详情与评论;不要默认选取第一条,也不要把不同分店合并成同一家。
- 快速搜索适合按名称与地点查找少量候选,不是全城商家目录,也不保证穷尽结果。批量查询接收已知商家标识,不接受自由文本店名;地点或搜索词补全也不能替代商家列表查询。
- 评论采集要记录商家、筛选条件、页码和实际返回条数,逐页去重并保存进度。reviews=[] 只表示这次返回了空列表,count=null 表示总数未知,不能改写为零;总数字段也不等于已采集条数,未经核对不要标为全量。
- 读取答案时,question 要填写商家问题列表返回的问题 ID 或问题链接,不能用商家标识代替。按话题查询评论时,topic 要使用同一商家话题列表返回的名称,不要把任意关键词当作已支持的话题。
- 菜单、菜品、照片、动态、问答、活动及用户内容的覆盖各不相同,可能为空或缺少字段;分页参数不保证对应页面有数据。展示的标价和日期只是查询时的信息,使用前应另行核实。
- 公开可见不等于可以无限保存、再分发或用于营销。采集前请确认访问、存储、分析、署名及再利用权限,尽量减少用户信息留存;公开用户关系不是联系许可,未推荐评论也不能直接判定为虚假评论。
核对响应与商家身份
先检查 HTTP 状态,再查看响应体中的 code、message 与 data。HTTP 2xx 不等于业务一定成功,请结合业务状态和实际数据判断;空列表或缺失字段也不能证明数据完整。
选择适合当前任务的接口
- 按名称匹配门店
-
先提供店名或关键词与地点获取候选,并核对分店地址。批量查询需要用逗号分隔已知商家标识,最多 20 个;查看相关商家则需先选定一家商家。
- 读取商家与餐厅资料
-
详情、菜单、热门菜品、照片与动态均需门店的商家别名、ID 或链接。先确认分店,再查看各类可用内容;菜单标价不代表实时成交价。
- 采集与分析门店评论
-
评论列表、高频片段、话题与未推荐评论都需要商家标识。按话题查看评论前,先读取同一商家的话题名称并填入 topic;常规评论可按需设置评分、语言、关键词和分页参数。
- 查看商家问答
-
用商家标识读取问题列表,再将选定问题的 ID 或问题链接填入 question 读取答案。答案接口不能用商家别名代替问题标识,问题与答案需分别分页。
- 查找本地活动
-
活动搜索必填城市短名或 Yelp 活动列表链接,可另设日期范围与分类。查看单个活动时,需使用活动列表中选定活动的短名或链接,而不是商家 ID。
- 构建地点与分类输入
-
地点补全和搜索词补全都需要 query,后者可另传 location。分类查询可选填国家、父分类或关键词;筛选项查询必填 location,可附加关键词或分类。建议值用于辅助填写,不等于完整商家列表。
- 查看公开贡献者动态
-
先从评论作者等公开记录取得用户标识,再查看资料、历史评论、照片、收到的赞誉、关注与好友列表。各接口都必填 user,分页与排序支持以对应参数为准;公开关系不是身份核验或联系许可。
商家匹配
/api/project/yelp/batch-business-lookup 批量查询最多 20 家已知 Yelp 商家
完整文档 →说明
根据已知 Yelp 商家标识列表,批量获取精简商家信息。必填查询参数 businesses 是一个以英文逗号分隔的字符串,每次最多包含 20 个商家别名、ID 或 Yelp 商家页面链接。此接口用于按标识补全商家资料,不是按地点搜索或全城商家发现接口。 文档列出的返回信息包括评分、电话、网站、地址、坐标和照片。这些是文档描述的信息类别,并非已确认的 JSON 字段名:目前没有实际批量响应的观测结果,所给响应示例也只有一个空对象。响应外层结构、记录顺序、未匹配输入的表示方式,以及部分查询失败时的处理方式均未验证。将其用于正式数据导入前,应先确认这些细节,不要直接按结果位置与输入逐项匹配。
参数与调试 1 项必填 · 0 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query |
调用成本暂不可用,未假定任何价格。
商家资料
/api/project/yelp/business-details 获取单家 Yelp 商家的详细档案
完整文档 →说明
通过必填查询参数 business 获取一家已知 Yelp 商家的档案。参数支持商家别名、22 位商家 ID 或 Yelp 商家页面链接。将资料关联到自己的记录前,请先确认选中的是目标门店。 实际观测到的一次成功响应为商家对象,包含 id、alias、name、rating 和 review_count,以及地址、联系信息、营业时间、设施与服务信息和 popular_dishes。测试中的 Gary Danko 档案返回 rating 为 4.5、review_count 为 6148;这些只是样本观测值,不是固定数值,也不代表数据时效承诺。文档还列出了电话、网站和卫生评分信息,但实际响应摘要未确认是否提供卫生评分。 所给响应示例还包含 about、alternate_links 和 alternate_names。其中可见的 about 字段包括 history、owner、specialties 和 year_established;地址字段包括 city、country_code、formatted、line1、line2、line3、postal_code 和 state。示例中的 amenities 条目还包含 name 和 is_available。这些示例特有的结构未在实际测试摘要中得到独立验证,示例本身也不完整。不要将未返回的属性直接视为否或不可用。针对一个故意构造的不存在商家的查询,测试返回 HTTP 404 和 error 字段,因此调用方应将未找到商家的响应与成功获取档案的响应分开处理。
参数与调试 1 项必填 · 0 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query |
调用成本暂不可用,未假定任何价格。
菜单
商家图片
/api/project/yelp/business-photos 按分类或图片说明关键词获取 Yelp 商家照片
完整文档 →说明
获取一家 Yelp 商家的照片元数据,支持使用商家别名、22 位商家 ID 或 Yelp 商家页面 URL。可通过 category 选择照片分类,也可通过 query 按图片说明中的关键词筛选。文档规定的默认值为 category=all、page=1、page_size=30;page 支持 1–1000,page_size 支持 1–100。请读取响应中的 categories,了解该商家实际可用的分类别名。 一份 page=1、page_size=3 的已记录响应中,count 为 14885,但本页实际只返回了 3 张照片,并非一次返回 14885 条记录。顶层分页字段包括 count、per_page、current_page、total_pages、next 和 previous。business 对象包含 id、alias、name 和 link;categories 中的记录包含 alias、name 和 photo_count。photos 中的每条记录包含 id、原始尺寸图片链接 link、thumbnail_link、caption、width、height、uploaded_at、tags、like_count、uploaded_by 和 review_id。uploaded_by 对象包含 id、name、link、location、photo_link、review_count、friend_count、photo_count、elite_year、is_elite 和 is_elite_all_star。在这份响应中出现这些字段,并不保证其他商家或其他页面中的每个字段都有值。 文档还提到了 videos 分类,但上述照片响应未核验视频专有字段。媒体链接只是资源引用,不代表已获准下载或转载。对于上传者信息,请仅保留获准用途所必需的内容。
参数与调试 1 项必填 · 4 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query |
展开可选参数 (1)
| 参数 | 位置 | 值 |
|---|---|---|
| query |
调用成本暂不可用,未假定任何价格。
餐厅菜品
/api/project/yelp/popular-dishes 获取 Yelp 餐厅热门菜品及评分、评论和照片数量
完整文档 →说明
查询一家 Yelp 餐厅的热门菜品,支持使用商家别名、22 位商家 ID 或 Yelp 商家页面 URL。可选整数参数 limit 用于限制请求的菜品数量,支持 1–50,默认值为 20。此接口面向已选定餐厅的菜品查询,不用于搜索餐厅,也不用于获取完整菜单。 文档描述的菜品信息包括名称、评分、评论数、照片数、价格和照片。该接口尚无经过独立核验的非空响应,现有示例为空对象。因此,这些内容只能视为文档中描述的数据概念,不能当作已确认的 JSON 属性名或保证有值的字段。现有证据尚未明确数据可用性、排序、响应外层结构及缺失值处理方式。 请将评分、评论数和照片数作为互动参考,而非订单量、营收或销量排名。菜品价格需要核实现时信息;热门菜品不一定仍在当前菜单上,也不一定适用于其他分店。建议与单独获取的菜单数据对照,并对无法确定的菜名匹配进行人工审核。
参数与调试 1 项必填 · 1 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query |
调用成本暂不可用,未假定任何价格。
商家动态
/api/project/yelp/business-posts 获取 Yelp 商家自行发布的动态与公告
完整文档 →说明
通过必填参数 business 提供 Yelp 商家别名、22 位商家 ID 或 Yelp 商家页面 URL,获取该商家自行发布的动态与公告。此接口没有文档说明的页码、数量上限或日期筛选参数。返回内容面向商家自行发布的更新,而非顾客评论。 文档描述的内容包括带有照片、链接和点赞信息的动态与公告。该接口尚无经过独立核验的非空响应,现有示例为空对象。因此,这些内容属于文档描述的内容属性,不能视为已确认的 JSON 属性名,也不保证相关字段一定有值。现有证据尚未明确响应外层结构、排序、发布时间、促销有效期、内容完整性,以及没有动态的商家会返回什么结果。 如果返回了内容,可将其纳入编辑审核队列。使用促销或营业相关公告前,应确认其当前是否仍然适用;未提供有效期时,不要自行推断。文档所述的点赞信息属于互动概念,不是经过核验的顾客数量或购买量。请将商家自行发布的内容与顾客反馈分开处理,并遵守相关媒体的使用权限。
参数与调试 1 项必填 · 0 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query |
调用成本暂不可用,未假定任何价格。
社区问答
/api/project/yelp/business-questions 获取商家社区问题与主要回答
完整文档 →说明
分页获取指定 Yelp 商家的社区问题,以及文档所述的每个问题的主要回答。必填参数 business 支持 Yelp 商家别名、22 个字符的商家 ID 或 Yelp 商家页面 URL;它用于定位一家已知商家,而非搜索全城商家。可选整数参数 page 默认为 1,允许范围为 1 至 1000,文档说明每页返回 10 个问题。文档描述的内容包括社区问题及其主要回答;如需进一步查看某个问题的回答,可将此接口取得的问题标识用于「问题回答列表」接口。此接口尚无实际响应观测记录,提供的 HTTP 200 文档示例为空对象({}),因此具体 JSON 字段名、嵌套结构、总条数、分页元数据及未获回答问题的处理方式均未核实。社区回答应作为有作者归属、需要核查的意见看待,不能视为已确认的商家政策或完整回答历史。
参数与调试 1 项必填 · 1 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query |
调用成本暂不可用,未假定任何价格。
/api/project/yelp/question-answers 分页获取单个社区问题的回答
完整文档 →说明
分页获取一个 Yelp 社区问题下的回答。必填参数 question 支持从「商家社区问题」接口取得的 22 个字符的问题 ID,或 Yelp 问题页面 URL。可选整数参数 page 默认为 1,允许范围为 1 至 1000,文档说明每页返回 10 条回答。文档描述的响应内容包括回答、回答作者及「有帮助」投票信息。这是分页回答列表,不能保证一次请求即可取得全部回答。此接口尚无实际响应观测记录,提供的 HTTP 200 文档示例为空对象({}),因此具体 JSON 字段名、作者子字段、投票表示形式、回答顺序、总条数及分页元数据均未核实。比较社区说法时,应结合作者归属和可获得的投票背景;无论回答本身还是「有帮助」投票,都不代表商家已正式确认其内容。
参数与调试 1 项必填 · 1 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query |
调用成本暂不可用,未假定任何价格。
相关商家
评论
/api/project/yelp/business-reviews 获取 Yelp 商家评论
完整文档 →说明
使用 Yelp 商家别名、22 位商家 ID 或 Yelp 商家页面网址,分页获取一家商家的评论。可组合使用关键词、星级和评论原文语言筛选条件,从六种文档列出的排序方式中选择一种,也可通过两位语言代码请求额外译文。默认获取第 1 页,每页 20 条;文档规定页码范围为 1–1000,每页条数范围为 1–49。 已保存的成功响应包含 count、per_page、current_page、total_pages、next、previous、business 和 reviews。business 对象包含 id、alias、name、link、rating、review_count、rating_distribution 和 languages,其中 languages 的每一项包含 language 和 count。已观察到的评论记录包含 id、link、rating、text、language、translated_text、created_at、date、author、reactions 和 photos。author 包括作者身份、个人主页链接、所在地、头像链接、贡献数量和精英用户状态相关字段。reactions 包含 helpful、thanks、love_this 和 oh_no。照片条目包含照片标识、图片链接、尺寸、上传时间、like_count 和 uploaded_by;caption 和 tags 可能为 null。评论还包含 is_updated、is_first_review、check_in_count、made_reservation、paid_through_yelp 和 was_appreciated_by_business。已观察记录中的 videos、owner_reply、previous_reviews、review_of_the_day 和 expert_badge 等字段均为 null,尚不能确定这些字段有值时的结构。 一次使用 newest 排序的已保存请求返回了三条带有正文、评分、作者和日期的评论。另一次包含合成测试关键词的已保存请求返回 reviews=[]、count=null,翻页导航值也为 null。这条记录不能确定响应为空的原因;count 为 null 表示总数未知,不能认定为零。已观察记录中的 translated_text 均为 null。其他排序方式、星级与语言筛选以及翻译行为仅有文档说明,尚未通过独立请求验证。不要假定能够获取完整历史评论,也不要将 newest 排序视为有保证的增量更新流。
参数与调试 1 项必填 · 7 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query | ||
| query |
展开可选参数 (3)
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query | ||
| query |
调用成本暂不可用,未假定任何价格。
/api/project/yelp/reviews-by-topic 按主题获取 Yelp 商家评论
完整文档 →说明
获取一家 Yelp 商家与指定主题相关的评论。需提供商家别名、22 位商家 ID 或 Yelp 商家页面网址,以及从该商家的“评论主题”接口获取的主题名称。文档说明结果包含所选主题的相关评论及匹配片段,每页 20 条。page 默认值为 1,文档规定范围为 1–1000;本接口不提供 page_size 参数。 本接口没有已保存的响应实测记录,提供的响应示例也仅为空对象。主题相关评论和匹配片段属于文档描述的内容,尚无独立观察结果确认具体字段。现有证据无法确定 JSON 属性名称、片段结构、分页元数据、评论标识或无匹配结果时的行为,不要据此推断本接口沿用普通商家评论接口的响应结构。可用片段核查主题所依据的评论内容,但不要将主题标签视为顾客体验的完整概括或情感评分。
参数与调试 2 项必填 · 1 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query | ||
| query |
调用成本暂不可用,未假定任何价格。
/api/project/yelp/review-highlights 获取 Yelp 商家评论亮点
完整文档 →说明
使用 Yelp 商家别名、22 位商家 ID 或 Yelp 商家页面网址,获取评论者最常提及的短语。文档说明每条评论亮点包含短语、支撑片段、评论数量和照片。本接口仅接受 business 参数,不提供主题、关键词、星级、排序或分页设置。 本接口没有已保存的响应实测记录,提供的响应示例也仅为空对象。短语、片段、评论数量和照片均为文档描述的内容,而非已独立观察到的字段。现有证据无法确定具体 JSON 键名、响应外层结构、照片表示方式、字段是否可为 null、计数方法或空结果行为。不要假定亮点中的数量就是商家评论总数,也不要假定一定有照片。评论亮点适合作为进一步阅读评论的线索;提及频率不代表正面情感,也不能据此确定排序算法或认定结果完整覆盖全部评论。
参数与调试 1 项必填 · 0 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query |
调用成本暂不可用,未假定任何价格。
/api/project/yelp/not-recommended-reviews 获取 Yelp 未获推荐评价
完整文档 →说明
查询某家商家被 Yelp 标记为“未获推荐”的评价。必填参数 business 支持 Yelp 商家别名、22 位商家 ID 或 Yelp 商家页面 URL。可选参数 page 默认为 1,支持第 1 至 1000 页,文档注明每页 10 条评价。 文档描述的返回内容为一页未获推荐评价及作者的公开统计数据。目前没有包含实际评价的响应示例,也没有该接口的成功响应观测记录,因此具体评价字段、作者字段、总数字段及空页行为均未验证。请勿假设每家商家都有结果,也不要将分页结果视为完整评价历史。 保存或比较结果时,应保留“未获推荐”标记。这是评价的可见性状态,并不能证明评价虚假或涉及欺诈。请将这些记录与常规评价样本分开保存,不要用它们重算商家页面上显示的评分。
参数与调试 1 项必填 · 1 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query |
调用成本暂不可用,未假定任何价格。
/api/project/yelp/review-topics 获取 Yelp 评价主题与情感占比
完整文档 →说明
查询某家 Yelp 商家的评价讨论主题,例如餐食、服务或环境。必填参数 business 支持 Yelp 商家别名、22 位商家 ID 或 Yelp 商家页面 URL。文档未列出主题筛选或分页参数。 文档描述的返回内容包括评价主题、各主题的评价数量及情感占比。目前没有包含实际主题数据的响应示例,也没有该接口的成功响应观测记录。因此,具体 JSON 字段名、情感标签、占比单位、聚合覆盖范围及空结果行为均未验证;不要预设占比采用百分比,也不要假定存在某种固定的情感分类。 应将这些结果视为接口报告的主题汇总数据,而非基于本地完整评价语料计算出的情感分析。若要通过单独的 reviews-by-topic 接口获取某个主题的评价,请使用本接口实际返回的主题值,不要自行构造主题标识,也不要用商家分类别名替代。
参数与调试 1 项必填 · 0 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query |
调用成本暂不可用,未假定任何价格。
商家分类
/api/project/yelp/categories 查询 Yelp 商家分类
完整文档 →说明
查询 Yelp 商家分类的名称、别名及父级关系。三个查询参数均为可选:country 使用 US 等两位国家代码,限定该国家使用的分类;parent 使用 restaurants 等父级分类别名,筛选该父级下的分类;query 按分类名称或别名中的文本匹配,例如 pizza。这些条件筛选的是分类定义,不是商家列表。 一次使用 country=US 和 query=pizza 的成功请求返回了一个对象,其中 count=1,categories 数组包含一项。已观测到的条目字段为 alias(pizza)、title(Pizza)、parent_aliases(包含 restaurants 的数组)和 countries(null)。应将 countries=null 视为国家元数据未指定,而不是全球支持的证据。这次单分类结果只确认了该示例中的父子关系,并未验证整个分类体系的覆盖范围。 文档称分类目录包含超过 1,500 个分类,并提供父级与支持国家的元数据。这一总量以及 countries 非空值的结构尚未独立验证。无匹配时的行为、观测结果以外的 count 含义,以及其他国家或父级筛选条件的覆盖范围也仍未验证。
参数与调试 0 项必填 · 3 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query |
展开可选参数 (1)
| 参数 | 位置 | 值 |
|---|---|---|
| query |
调用成本暂不可用,未假定任何价格。
本地活动
/api/project/yelp/event-details 通过活动短名称或链接查询 Yelp 活动详情
完整文档 →说明
使用必填的 event 字符串查询单个 Yelp 活动的详情。可传入 huntington-beach-oktoberfest-on-thursdays-4 这样的活动短名称(slug),也可传入 Yelp 活动链接。此接口用于查询某一场活动,不用于搜索城市中的活动。 文档描述的内容包括活动介绍、开始和结束时间、场地地址、价格及感兴趣人数。这些仅是文档说明,并非已观测到的响应字段:目前没有此接口的实测响应,提供的 HTTP 200 示例也是空对象。因此,具体 JSON 键名、嵌套结构、数据类型和字段是否可选均未验证。 活动时间和价格应以实际返回的信息为准,不要推断缺失的时区、币种或门票余量。感兴趣人数仅代表关注意向,不代表确认出席人数。获得活动详情也不意味着可以完成预订或购票。
参数与调试 1 项必填 · 0 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query |
调用成本暂不可用,未假定任何价格。
/api/project/yelp/search-events 按城市、类别和日期范围搜索 Yelp 活动
完整文档 →说明
使用必填的 city 字符串浏览 Yelp 活动列表,参数内容为 Yelp 活动页面的城市短名称(slug)或城市活动链接。可通过 category、start_date 和 end_date 缩小范围;传入字符串 official_only=true 可仅查询 Yelp 官方活动;还可设置 sort_by 排序方式和 page 页码。日期格式为 YYYY-MM-DD。文档给出的默认值为 official_only=false、sort_by=popular、page=1。 文档说明每页包含 15 场活动,并提供场地和开始时间信息。支持的页码范围为 1 至 100,但这不代表每页都有结果,也不保证覆盖城市中的全部活动。目前没有此接口的实测响应,提供的 HTTP 200 示例也是空对象。具体活动字段、列表嵌套结构、标识符字段、数据类型、数量信息和分页元数据均未验证。 应将结果作为来自 Yelp 的活动候选清单,而不是完整活动目录或门票余量数据源。选定活动后,可通过 event-details 接口传入活动短名称或链接查看详情;现有示例无法确认这些标识在搜索结果中的具体表示方式。
参数与调试 1 项必填 · 6 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query |
展开可选参数 (3)
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query | ||
| query |
调用成本暂不可用,未假定任何价格。
地点
/api/project/yelp/location-autocomplete 根据部分地名获取 Yelp 地点自动补全建议
完整文档 →说明
在必填的 query 字符串中输入部分地名,例如 Beverly Hills,即可请求地点建议。文档描述的建议范围包括城市、街区和地区。此接口用于地理位置输入建议,不用于商家名称搜索、商家匹配、地址验证或地理边界查询。 目前没有此接口的实测响应,提供的 HTTP 200 示例也是空对象。文档虽然描述了地点建议,但没有确认具体响应键名、列表嵌套结构、建议类型、排序规则、标识符、坐标、结果数量上限或分页方式,不应默认存在这些字段。 可使用建议帮助用户先选择地点名称,再单独进行商家查询或地理信息审核。需要追溯时,应同时保留原始查询和所选建议。文档没有保证建议结果可直接用作 Yelp 活动页面的城市短名称,建议地点也不能证明某家商家确实位于那里。
参数与调试 1 项必填 · 0 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query |
调用成本暂不可用,未假定任何价格。
搜索与建议
/api/project/yelp/search-autocomplete 获取 Yelp 搜索词与商家联想建议
完整文档 →说明
根据必填的 query 获取搜索联想建议,可输入 piz 这样的部分搜索词。可选的 location 用于提供地理位置上下文,让建议更贴近目标地区。文档列出的建议类型包括分类、热门搜索短语和匹配商家。目前没有该接口的非空响应独立验证记录,提供的响应示例也是空对象,因此尚未确认建议的属性名、分组键或商家标识符字段。应将这些建议类型视为文档描述的能力,而不是已经确认的响应结构。联想建议不构成完整商家名录,热门搜索建议也不能证明实际搜索量。
参数与调试 1 项必填 · 1 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query |
调用成本暂不可用,未假定任何价格。
/api/project/yelp/search-filters 查看 Yelp 搜索筛选选项
完整文档 →说明
查看文档中针对特定 Yelp 搜索场景提供的筛选选项。location 为必填参数,支持城市、街区、地址或邮政编码,文档默认值为 Austin, TX。还可通过 query 指定搜索词,或通过 category 指定 Yelp 分类别名、分类名称,或含有 cflt= 的 Yelp 搜索网址。文档列出的筛选分组涵盖价格、特色、分类、距离和服务类型。该接口没有非空响应记录,提供的响应示例也是空对象,因此尚未确认具体响应字段名、选项标识符、分组结构以及各筛选项是否可用。此接口仅用于了解筛选选项,不执行带筛选条件的商家搜索。本项目未包含主要商家搜索接口,快速搜索也不接受这些筛选选项。
参数与调试 1 项必填 · 2 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query | ||
| query |
调用成本暂不可用,未假定任何价格。
/api/project/yelp/quick-search 按名称和地点查找 Yelp 候选商家
完整文档 →说明
通过必填的 query 和 location 字符串查找少量 Yelp 候选商家。query 支持商家名称或关键词,文档默认值为 coffee;location 支持城市、街区、地址或邮政编码。可选的整数参数 limit 在文档中的默认值为 10,允许范围为 1 至 25。已有一条 HTTP 200 响应记录:以 Golden Boy Pizza 为搜索词、San Francisco, CA 为地点并设置 limit=3,请求返回了一个包含 results 的对象,其中有三个商家地点,包括两家旧金山门店。记录中的商家数据包含标识符、别名、评分、电话、网站和结构化地址。上述字段由该次响应记录支持;单独提供的静态响应示例为空对象,不能据此确认其他属性名、地址子字段、分页字段或可用性保证。1 至 25 的范围及默认值 10 来自文档,尚未独立测试边界行为。选择用于后续详情、菜单或评论查询的标识符前,应先比较门店地址和电话。此接口用于查找候选商家,不是完整城市商家名录,不保证名称精确匹配,也不能替代完整商家搜索;它不接受分类、价格、距离或服务筛选条件。
参数与调试 2 项必填 · 1 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query | ||
| query |
调用成本暂不可用,未假定任何价格。
公开用户资料与动态
/api/project/yelp/user-compliments 获取 Yelp 用户收到的公开赞赏
完整文档 →说明
分页获取一位 Yelp 社区贡献者收到的公开赞赏。必填参数 user 支持 22 位 Yelp 用户 ID 或 Yelp 个人主页 URL。可选参数 page 用于选择第 1 至 1000 页,默认值为 1;page_size 用于设置每页 1 至 50 条赞赏,默认值为 20。接口文档描述的内容包括每条赞赏的类型、留言、日期和发送者。这些只是文档说明的属性,并非已经核实的 JSON 字段名:此接口尚无实际响应可供核验,现有 HTTP 200 示例也仅为空对象。因此,响应嵌套结构、发送者的具体字段、分页元数据及无结果时的返回方式均未核实。赞赏仅代表社区认可,不代表已核实的专业能力、商家背书,也不意味着获得了联系他人的许可。
参数与调试 1 项必填 · 2 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query | ||
| query |
调用成本暂不可用,未假定任何价格。
/api/project/yelp/user-profile 获取 Yelp 贡献者的公开资料与活动统计
完整文档 →说明
获取一位 Yelp 社区贡献者的公开资料。必填参数 user 支持 22 位 Yelp 用户 ID 或 Yelp 个人主页 URL。已观察到的 HTTP 200 成功响应直接返回用户对象,而非结果列表。该响应中的身份与资料字段包括 id、name、first_name、link、location、joined、tagline 和 about;joined 是包含月份和年份的展示文本,tagline 和 about 则为 null。整数类型的活动统计字段包括 review_count、review_update_count、first_to_review_count、photo_count、video_count、friend_count、follower_count、following_count、question_count、answer_count、events_created_count、expert_recognition_count、compliment_count 和 reactions_received。compliments 对象中包含 thank_you、good_writer、great_photo、just_a_note、cute_pic、hot_stuff、like_your_profile、write_more、you_are_cool、great_lists 和 you_are_funny 等整数计数,这些统计不是单条赞赏留言。Elite 相关字段中,is_elite 为布尔值;已观察响应中的 elite_year、elite_years 和 is_elite_all_star 均为 null。profile_photos 数组内的对象包含字符串类型的 id、link 和 thumbnail_link,以及 caption、width、height 和 uploaded_at;在已检查的照片条目中,后四项均为 null。功能说明中虽提到个人简介及 Elite 年份内容,但该样本无法核实这些字段非空时的值及格式;现有接口成功示例本身也仅为空对象。请保留字段缺失或为 null 的状态,不要编造数据。统计值和公开资料仅提供账号活动背景,不代表身份已经验证或可信度评分,也不提供邮箱发现能力或联系当事人的许可。
参数与调试 1 项必填 · 0 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query |
调用成本暂不可用,未假定任何价格。
/api/project/yelp/user-following 查询 Yelp 用户关注的公开账号列表
完整文档 →说明
分页查询所选 Yelp 社区贡献者关注的公开用户。关注方向是从所选用户指向其关注的账号;此接口不是粉丝列表,也不能据此认定双方互为好友。必填参数 user 支持 22 位 Yelp 用户 ID 或 Yelp 个人主页 URL。可选参数 page 支持第 1 至 1000 页,默认值为 1;page_size 支持每页 1 至 50 位用户,默认值为 20。文档描述的被关注用户信息包括所在地、Elite 身份和评论数量。这些只是文档说明的属性,并非已核实的 JSON 字段名:此接口尚无实际响应可供核验,现有 HTTP 200 示例也仅为空对象。响应外层结构、标识符键名、Elite 身份的表示方式、总数、分页元数据及无结果时的返回方式均未核实。请仅将返回的关注关系视为有限的公开快照,不要当作完整社交关系图谱、私下关系证明或联系账号的许可。
参数与调试 1 项必填 · 2 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query | ||
| query |
调用成本暂不可用,未假定任何价格。
/api/project/yelp/user-friends 分页查询 Yelp 用户的公开好友
完整文档 →说明
按页获取指定 Yelp 贡献者的公开好友列表。必填参数 user 支持 22 个字符的 Yelp 用户 ID 或 Yelp 个人主页链接。page 的取值范围为 1–1000,文档默认值为 1;page_size 的取值范围为 1–50,文档默认值为 20。sort_by 支持 newest、oldest、name、name_desc 和 recently_reviewed,文档默认值为 newest。 接口文档列出的好友信息包括所在地、精英(Elite)身份,以及点评数、照片数和好友数。该接口尚无已观测响应,提供的成功示例仅为空对象({})。这些内容属于文档描述的能力,并非已验证的 JSON 字段;确切字段名、列表外层结构、分页元数据及缺失值的处理方式均未确认。请将返回页面视为有限的好友关系快照,而不是完整的关系网络。好友列表与关注列表并不等同。
参数与调试 1 项必填 · 3 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query | ||
| query |
展开可选参数 (1)
| 参数 | 位置 | 值 |
|---|---|---|
| query |
调用成本暂不可用,未假定任何价格。
/api/project/yelp/user-photos 分页查询 Yelp 用户上传的照片
完整文档 →说明
按页获取指定 Yelp 贡献者上传的照片。必填参数 user 支持 22 个字符的 Yelp 用户 ID 或 Yelp 个人主页链接。page 的取值范围为 1–1000,文档默认值为 1;page_size 的取值范围为 1–50,文档默认值为 20。该接口没有文档列明的排序、照片说明文字搜索或商家筛选参数。 接口文档描述了每张照片的说明文字、日期及拍摄所关联的商家。该接口尚无已观测响应,提供的成功示例仅为空对象({})。说明文字、日期和商家关联属于文档描述的能力,并非已验证的 JSON 字段;确切字段名、图片链接字段、日期格式、分页元数据及缺失值的处理方式均未确认。缺少商家关联时,应将其标记为待确认。返回某一页不代表已获取完整上传历史;能够读取照片元数据,也不代表拥有图片使用权,更不能据此认定贡献者曾到访某个地点。
参数与调试 1 项必填 · 2 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query | ||
| query |
调用成本暂不可用,未假定任何价格。
/api/project/yelp/user-reviews 按分类与关键词筛选 Yelp 用户点评
完整文档 →说明
分页查询指定 Yelp 贡献者撰写的点评,可选用分类、关键词和排序条件。必填参数 user 支持 22 个字符的 Yelp 用户 ID 或 Yelp 个人主页链接。category 支持 Yelp 分类别名(如 pizza)、分类名称(如 Coffee & Tea),或包含 cflt= 的 Yelp 搜索链接。query 用于请求提及指定关键词(如 noodles)的点评,文档未进一步说明匹配规则。sort_by 支持 newest、oldest、highest_rated 和 lowest_rated;不传时使用 Yelp 默认排序,文档未说明该默认排序是否对应上述某个选项。page 的取值范围为 1–1000,文档默认值为 1;page_size 的取值范围为 1–50,文档默认值为 20。 接口文档描述了用户撰写的点评及其所评商家。该接口尚无已观测响应,提供的成功示例仅为空对象({})。点评与商家的关联属于文档描述的能力,并非已验证的 JSON 字段。确切的点评及商家字段名、是否提供评分、日期或正文、分页元数据及缺失值的处理方式均未确认。请将结果视为限定范围的点评历史快照,不承诺获取全部点评,不据此推断实际到访,也不根据返回内容作出身份或欺诈判定。
参数与调试 1 项必填 · 5 项可选
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query | ||
| query | ||
| query |
展开可选参数 (2)
| 参数 | 位置 | 值 |
|---|---|---|
| query | ||
| query |
调用成本暂不可用,未假定任何价格。
接口能力
围绕已知门店或店名与地点,接入 Yelp 商家资料与评论数据,服务于海外门店口碑监测、商家信息补全和餐饮竞品分析。
- 门店匹配:按名称与地点查找候选,批量查询已知商家,并查看相关商家;补全资料前先核对分店地址
- 餐厅资料:读取商家详情、菜单分区与标价、热门菜品、图片和商家动态,具体内容以实际可用数据为准
- 评论分析:分页获取评论,按需使用关键词、评分和语言参数,并区分话题、评论高频片段与未推荐评论
- 社区问答:查看商家问题列表,再通过选定问题的标识读取答案
- 本地发现:获取分类与搜索词建议、地点补全、可用筛选项及本地活动信息
- 公开贡献记录:查看用户公开资料、历史评论、照片、收到的赞誉、关注和好友列表
不同商家与请求的数据覆盖可能不同。评论返回空列表或总数未知,不代表商家没有评论;本接口也不是全城商家的完整目录。采集、存储或再利用公开内容前,请先确认相应权限。