SerpBase
仅 POST

API 文档

结构化网页结果、明确的请求参数和响应状态。

Base URL
https://api.serpbase.dev
认证请求头
X-API-Key: <API_KEY>
计费
每笔请求按接口价格计费;已执行的失败也可能扣费
认证

创建账户并在 API Keys 获取密钥。通过 X-API-Key 传入,不要放入 URL 或公开代码。遵循各产品的请求方法与参数。HTTP 200 不代表成功,请检查 status 和 error。Playground 请求可能消耗积分。

elapsed_ms

公共响应结构

credits_charged

每笔请求按接口价格计费;已执行的失败也可能扣费

request_id

支持请求追踪编号

最小请求
bash
curl -X POST 'https://api.serpbase.dev/google/search' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: your_api_key' \
  -d '{"device":"mobile","gl":"us","hl":"en","q":"coffee shops"}'

账号 QPS 自动升档

符合条件的充值确认入账后,按累计 USD 金额自动提升至至少以下 QPS:$3 → 2、$50 → 5、$100 → 10、$200 → 15、$1,000 → 50、$10,000 → 500。未满 $3 保持当前账户限额。只升不降,已有更高限额不会降低;不是无限 QPS。

累计符合条件的充值(USD)至少提升至(QPS,请求/秒)
≥ $32 QPS
≥ $505 QPS
≥ $10010 QPS
≥ $20015 QPS
≥ $1,00050 QPS
≥ $10,000500 QPS

仅统计已确认入账的 USD 积分包(credit_pack)和自动充值(auto_topup)付款。订阅(包括 Starter Boost)、赠送和礼品码不计入。积分余额不等于累计充值美元金额;非 USD 付款不能未经换汇直接计作 USD。

同一账户的所有 API Key、产品和网关共用一个 QPS 限额;增加 Key 不会增加限额。

符合条件的充值确认入账后自动提升账号 QPS,付款跳转回来不代表已生效。现有限额以账户显示的服务端数值为准,API Key 同步可能短暂延迟。

计费模型与扣费规则

目录每请求价格与实际扣费字段解读。

每请求按目录固定价格计费,不按返回页数计费。Web Crawl 和 User Agent 当前均为每请求 1 积分;User Agent 并非免费。有来源和资源身份依据的真实不存在结果正常收费。仅有 no_results、HTTP 404 或缺少 hydration/解析数据不能证明不存在。目前已执行的失败可能扣费,并非所有失败都保证退款。credits_charged 表示实际扣费:0 表示报告为零,null 或缺失表示未知。charge_status 为 UNKNOWN 时即使有扣费数值也仍是未知。请核对账户记录并提供 request_id 联系支持,不要假定已退款或盲目重试。

Agent 集成

如果你希望 Claude、Codex、Cursor、Cline/Roo、opencode 或其他 agent 直接用你的 API key 调用 SerpBase,可以使用开源 MCP server 或通用 Agent Skill。

MCP 配置
json
{
  "mcpServers": {
    "serpbase": {
      "command": "python",
      "args": ["-m", "serpbase_mcp"],
      "env": {
        "SERPBASE_API_KEY": "your_api_key"
      }
    }
  }
}
Skill 调用提示
text
Use $serpbase-skill to search Google through SerpBase and return cited structured results.
账户余额

查询有效 API key 所属账户的当前额度。该请求不消耗搜索额度。

GET
0 点
/account/credits

请在 X-API-Key 请求头中传入密钥。接口不接受 URL 查询参数中的 API key。

bash
curl https://api.serpbase.dev/account/credits \
  -H "X-API-Key: your_api_key"
json
{
  "status": 0,
  "credits": 12345,
  "permanent_credits": 10000,
  "expiring_credits": 2345,
  "expiring_expires_at": 1798761600
}

该接口每个账户每分钟最多调用 60 次。expiring_expires_at 为 Unix 秒级时间戳;没有有效限时额度时为 0。

公共响应结构

接口成功响应会返回同一套顶层元数据。接口自己的数据只放在 organic、images、news、videos、places 或 place 这类结果字段里。

status
必填
number

必填

业务状态码,0 表示成功。

request_id
必填
string

必填

稳定请求 ID,用于支持、重试和日志关联。

elapsed_ms
必填
number

必填

网关观测到的请求执行耗时,单位毫秒。

credits_charged
必填
number | null

必填

退款逻辑处理后实际扣除的点数。null 或 charge_status: unknown 表示尚未确认扣费。

search_type
可选
string

可选

产品返回此字段时,表示该产品的响应类型。

接口
1 点
搜索
/google/search

通过 q、语言 hl、国家 gl 和支持的设备搜索 Google 网页。结果区块取决于查询和上游响应。

1 点
图片搜索
/google/image/search

按查询搜索 Google 图片与来源链接;返回链接不授予图片使用权。

1 点
新闻搜索
/google/news/search

按主题或关键词搜索 Google 新闻。文章和发布者字段取决于上游结果。

1 点
视频搜索
/google/videos/search

按查询搜索 Google 视频条目;不提供视频下载或去水印服务。

2 点
地图搜索
/google/maps/search

按查询和位置搜索 Google Maps 地点。已识别地点详情使用独立接口。

3 点
地图详情
/google/maps/detail

按地点 ID 查询单个 Google Maps 地点,补充地点搜索,使用独立目录请求价格。

2 点
Google Maps Reviews
/google/maps/reviews

获取某个地点(按 data_id)的第一页 Google 地图评论:评分、内容、日期、照片和评论者信息;暂不包含商家回复。

1 点
Google Search Autocomplete
/google/autocomplete

获取 Google 查询前缀建议;建议不是搜索量统计。

2 点
Google Shopping Search
/google/shopping

按查询搜索 Google Shopping 条目;这是快照,不是持续价格监控。

2 点
Google Jobs Search
/google/jobs

按职位或关键词搜索 Google 招聘条目,有结果时返回;不提交求职申请。

2 点
Google Scholar Search
/google/scholar

按研究主题或关键词搜索 Google Scholar;元数据不保证论文全文访问。

1 点
Google Books Search
/google/books

按书名、作者或关键词搜索 Google Books;不提供不受限的图书下载。

1 点
Google Finance Search
/google/finance

按公司或金融词查询 Google Finance;不是流式行情或交易 API。

2 点
Google Patent Details
/google/patents/detail

按公开号获取一条 Google Patents 专利:标题、摘要、权利要求、发明人、申请人和各项日期。

1 点
Google Play Search
/google/play/search

按关键词搜索 Google Play 应用,返回应用名称、包名、图标和商店链接;不下载应用。

1 点
Google Play App Details
/google/play/app

按包名获取一个 Google Play 应用的商店页信息:名称、开发者、简介、价格、版本、发布日期和年龄分级。

2 点
Google Trends
/google/trends

Google 趋势:最多 5 个关键词(逗号分隔)的热度走势、地区分布和相关搜索。

2 点
Google Trends Autocomplete
/google/trends/autocomplete

Google 趋势的关键词联想主题,包含主题类型和标识。

2 点
Google Trends Trending Now
/google/trends/trending

Google 趋势的实时热搜:某个国家(默认美国)过去 24 小时的上升搜索。

开发中 · 已暂停
Bing Web Search
/bing/search

Execute Bing web searches with query, country cc, and language setlang parameters for organic search results.

1 点
DuckDuckGo Search
/duckduckgo/search

按查询及支持的市场、日期条件搜索 DuckDuckGo HTML。后续请求使用返回游标,而非页码。

2 点
Reddit Post & Comments
/reddit/post

Retrieve full Reddit post content, author details, upvotes, and structured comment threads from a Reddit post URL.

1 点
Reddit Search
/reddit/search

Search public Reddit posts and discussion threads across subreddits by keyword query.

2 点
TikTok Post
/tiktok/post

使用帖子 ID 和用户名查询特定 TikTok 帖子,不是账号全部帖子的发现接口。

2 点
TikTok Profile
/tiktok/profile

按用户名请求 TikTok 资料。数据取决于上游可访问性,不是受众历史档案。

1 点
TikTok Search
/tiktok/search

按关键词搜索 TikTok 视频:返回视频链接、文案、作者、播放、点赞、评论和分享数、话题标签与封面,默认每页 16 条。

1 点
X Post Details
/x/post

按 ID 查询单个 X 帖子;不是关键词搜索、时间线导出或流式接口。

1 点
YouTube Search
/youtube/search

Search YouTube videos, Shorts, and creator channels with query and region parameters.

2 点
YouTube Video Transcripts
/youtube/transcripts

Extract timestamped multi-language video transcripts and closed captions for a YouTube video ID.

2 点
Ajio Product Details
/ajio/product

从 HTTPS /p/ URL 读取单件 AJIO 商品,不是目录导出。

2 点
Amazon Product Details
/amazon/product

Retrieve detailed Amazon product data including titles, multiple variant ASINs, merchant offers, availability, and specs by ASIN.

2 点
Amazon Product Reviews
/amazon/reviews

Extract authentic customer reviews, star ratings, review text, and reviewer attributes for an Amazon product ASIN.

2 点
Amazon Product Search
/amazon/search

Search Amazon product catalog by keyword query and domain. Returns structured product listings with prices, ratings, and Prime badges.

1 点
Amazon Search Autocomplete
/amazon/autocomplete

根据前缀获取 Amazon 查询建议,不返回商品详情或价格历史。

1 点
Apple Product Details
/apple/product

使用数字应用 ID 或 apps.apple.com URL 和国家查询 App Store 应用;不是 Apple 硬件。

2 点
eBay Product Details
/ebay/product

Retrieve detailed eBay item data, current auction prices, seller ratings, and listing specifications by item ID.

1 点
eBay Product Search
/ebay/search

Search eBay auction and Buy-It-Now listings by query. Returns titles, bids, prices, and seller information.

2 点
Flipkart Product Details
/flipkart/product

从含 /p/ 的商品 URL 读取 Flipkart 商品,使用具体 URL 而非查询词。

2 点
Myntra Product Details
/myntra/product

从 /buy URL 读取单个 Myntra 商品,与 Myntra 搜索接口分开。

2 点
Myntra Search
/myntra/search

使用查询或支持的搜索 URL 搜索 Myntra。支持页码,不支持游标或覆盖每页数量。

2 点
Walmart Product Details
/walmart/product

Extract full Walmart product specification, pricing, variant details, and descriptions using Walmart item ID.

2 点
Walmart Product Search
/walmart/search

Search Walmart retail inventory by keyword query. Returns product cards, prices, seller information, and stock status.

1 点
Walmart Search Autocomplete
/walmart/autocomplete

按查询获取 Walmart 搜索建议,不读取 Walmart 商品页。

1 点
User-Agent Generator
/web/user-agent

使用 user_agent_type 和 user_agent_count(1–5)生成桌面或移动 UA。此本地操作仍按目录价格收费。

1 点
Web Crawl
/web/crawl

从公开网站 URL 开始有界抓取;每个客户请求固定计价,不乘以返回页数。

1 点
Web Scrape
/web/scrape

按 URL 提取公开 HTTP/HTTPS 网页,支持文本、HTML、Markdown 和选择器选项;来源限制仍适用。不支持抓取谷歌页面,请使用 /google/search 等谷歌接口。

2 点
Zillow Property Search
/zillow/search

从支持的 Zillow homes URL 读取搜索结果;这是房源快照,不是估价或成交流。

POST
可调用
/google/image/search

图片搜索

按查询搜索 Google 图片与来源链接;返回链接不授予图片使用权。

type
images
result
images
计费
1 点

按查询搜索 Google 图片与来源链接;返回链接不授予图片使用权。

参数
q
必填
string

必填

搜索查询字符串。

hl
可选
string

可选

语言代码,默认 en。

gl
可选
string

可选

国家代码,默认 us。

page
可选
number

可选

从 1 开始的页码,默认 1。

query
示例
string

目录示例;必填规则由接口校验。

示例: "red pandas"

json
{
  "query": "red pandas"
}
在 Playground 中调用
响应字段
query
必填
string

必填

请求中的标准化 query。

page
必填
number

必填

当前页码,从 1 开始。

images
可选
ImageResult[]

解析到图片结果时返回。

Google 图片结果。

ImageResult 结果项字段
rank
必填
number

必填

当前响应里的 1-based 排名。

position
可选
number

可用时作为 rank 的别名。

给客户端使用的标准化排名别名。

title
可选
string

解析到图片标题或 alt 文本时返回。

结果标题。

link
必填
string

必填

parser 返回的主链接。

url
可选
string

结果链接可归一化时返回。

规范化目标 URL,通常和 link 相同。

source_url
可选
string

只有观测到 Google 跳转/来源 URL 时返回。

保留的原始 Google URL,用于调试和溯源。

display_url
可选
string

当 Google 展示文本或域名可解析时返回。

展示 URL 或来源域名。

image_url
必填
string

必填

完整图片 URL。

thumbnail_url
可选
string

Google 暴露缩略图时返回。

缩略图 URL。

thumbnail
可选
string

可用时作为 thumbnail_url 的别名。

标准化缩略图别名。

source
可选
string

解析到来源文本时返回。

图片来源名称。

domain
可选
string

能从来源页面解析域名时返回。

来源页面域名。

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/google/image/search' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"query":"red pandas"}'
现有 Google 请求示例
bash
curl -X POST https://api.serpbase.dev/google/image/search \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key" \
  -d '{
    "q": "iphone 15 pro blue",
    "hl": "en",
    "gl": "us",
    "page": 1
  }'
说明

视觉搜索、商品监控、图片来源发现。

Google 图片存在多种页面结构,有些样本只稳定暴露 rank/link,不一定都有 url、display_url、source_url、position、thumbnail 这些别名,客户端应按可选字段处理。

POST
可调用
/google/news/search

新闻搜索

按主题或关键词搜索 Google 新闻。文章和发布者字段取决于上游结果。

type
news
result
news
计费
1 点

按主题或关键词搜索 Google 新闻。文章和发布者字段取决于上游结果。

参数
q
必填
string

必填

搜索查询字符串。

hl
可选
string

可选

语言代码,默认 en。

gl
可选
string

可选

国家代码,默认 us。

page
可选
number

可选

从 1 开始的页码,默认 1。

query
示例
string

目录示例;必填规则由接口校验。

示例: "semiconductor supply"

json
{
  "query": "semiconductor supply"
}
在 Playground 中调用
响应字段
query
必填
string

必填

请求中的标准化 query。

page
必填
number

必填

当前页码,从 1 开始。

news
可选
NewsResult[]

解析到新闻结果时返回。

Google 新闻结果。

NewsResult 结果项字段
rank
必填
number

必填

当前响应里的 1-based 排名。

position
可选
number

可用时作为 rank 的别名。

给客户端使用的标准化排名别名。

title
必填
string

必填

结果标题。

link
必填
string

必填

parser 返回的主链接。

url
可选
string

结果链接可归一化时返回。

规范化目标 URL,通常和 link 相同。

source_url
可选
string

只有观测到 Google 跳转/来源 URL 时返回。

保留的原始 Google URL,用于调试和溯源。

display_url
可选
string

当 Google 展示文本或域名可解析时返回。

展示 URL 或来源域名。

source
可选
string

解析到发布方文本时返回。

发布方或来源名称。

time
可选
string

Google 暴露时间文本时返回。

原始发布时间文本。

published_at
可选
string

解析到 time 时返回的发布时间别名。

标准化发布时间别名。

snippet
可选
string

解析到摘要时返回。

新闻摘要。

thumbnail_url
可选
string

Google 暴露缩略图时返回。

缩略图 URL。

thumbnail
可选
string

可用时作为 thumbnail_url 的别名。

标准化缩略图别名。

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/google/news/search' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"query":"semiconductor supply"}'
现有 Google 请求示例
bash
curl -X POST https://api.serpbase.dev/google/news/search \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key" \
  -d '{
    "q": "apple event",
    "hl": "en",
    "gl": "us",
    "page": 1
  }'
说明

品牌监控、趋势跟踪、媒体发现。

source 和 time 来自 Google 紧凑元数据文本,客户端应按可选字段处理。

POST
可调用
/google/videos/search

视频搜索

按查询搜索 Google 视频条目;不提供视频下载或去水印服务。

type
videos
result
videos
计费
1 点

按查询搜索 Google 视频条目;不提供视频下载或去水印服务。

参数
q
必填
string

必填

搜索查询字符串。

hl
可选
string

可选

语言代码,默认 en。

gl
可选
string

可选

国家代码,默认 us。

page
可选
number

可选

从 1 开始的页码,默认 1。

query
示例
string

目录示例;必填规则由接口校验。

示例: "how espresso machines work"

json
{
  "query": "how espresso machines work"
}
在 Playground 中调用
响应字段
query
必填
string

必填

请求中的标准化 query。

page
必填
number

必填

当前页码,从 1 开始。

videos
可选
VideoResult[]

解析到视频结果时返回。

Google 视频结果。

VideoResult 结果项字段
rank
必填
number

必填

当前响应里的 1-based 排名。

position
可选
number

可用时作为 rank 的别名。

给客户端使用的标准化排名别名。

title
必填
string

必填

结果标题。

link
必填
string

必填

parser 返回的主链接。

url
可选
string

结果链接可归一化时返回。

规范化目标 URL,通常和 link 相同。

source_url
可选
string

只有观测到 Google 跳转/来源 URL 时返回。

保留的原始 Google URL,用于调试和溯源。

display_url
可选
string

当 Google 展示文本或域名可解析时返回。

展示 URL 或来源域名。

source
可选
string

解析到来源或频道时返回。

视频来源或频道。

duration
可选
string

结果文本包含时长时返回。

视频时长文本。

time
可选
string

解析到发布时间时返回。

原始发布时间文本。

published_at
可选
string

解析到 time 时返回的时间别名。

标准化发布时间别名。

thumbnail_url
可选
string

Google 暴露缩略图时返回。

缩略图 URL。

thumbnail
可选
string

可用时作为 thumbnail_url 的别名。

标准化缩略图别名。

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/google/videos/search' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"query":"how espresso machines work"}'
现有 Google 请求示例
bash
curl -X POST https://api.serpbase.dev/google/videos/search \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key" \
  -d '{
    "q": "python asyncio tutorial",
    "hl": "en",
    "gl": "us",
    "page": 1
  }'
说明

视频搜索、教程发现、媒体监控。

如果没有解析到专用视频卡片,parser 会对兼容的 Google 布局回退到 news 风格提取。

POST
可调用
/google/maps/detail

地图详情

按地点 ID 查询单个 Google Maps 地点,补充地点搜索,使用独立目录请求价格。

type
maps_detail
result
place
计费
3 点

按地点 ID 查询单个 Google Maps 地点,补充地点搜索,使用独立目录请求价格。

参数
feature_id
必填
string

必填

使用 Maps Search 地点结果返回的 feature_id 字段,格式类似 0x...:0x...。

hl
可选
string

可选

语言代码,默认 en。

gl
可选
string

可选

国家代码,默认 us。

id
示例
string

目录示例;必填规则由接口校验。

示例: "ChIJVVVVVYxK1EARyQpK5cQqEAA"

json
{
  "id": "ChIJVVVVVYxK1EARyQpK5cQqEAA"
}
在 Playground 中调用
响应字段
feature_id
必填
string

必填

地图详情请求解析出的 feature_id。

page
必填
number

必填

地图详情固定为 1。

place
可选
MapsPlace

解析到地点详情时返回。

单个地点详情对象。

MapsPlace 结果项字段
position
可选
number

仅 Maps Search 返回。

地点在本地结果列表中的排名。

name
必填
string

必填

地点名称。

title
必填
string

必填

name 的别名。

feature_id
必填
string

必填

Google Maps feature id。

place_id
可选
string

Google 暴露时返回。

Google place id。

data_id
可选
string

feature_id 的别名。

Maps data id。

cid
可选
string

可从 feature_id 解析时返回。

Google CID。

kgmid
可选
string

Maps payload 中存在时返回。

知识图谱机器 ID。

google_maps_url
可选
string

Google 暴露 Maps URL 时返回。

Google Maps URL。

url
可选
string

来自 google_maps_url,缺失时回退到 website。

地点主 URL。

rating
可选
number

存在评分时返回。

Google 评分。

types
可选
string[]

存在分类时返回。

地点类型标签。

category
可选
object

解析到分类块时返回。

结构化分类数据。

address
可选
string

存在地址时返回。

格式化地址。

address_components
可选
object

存在地址组件时返回。

街道、城市、邮编、国家代码。

plus_code
可选
object

存在 plus code 时返回。

global_code 和 compound_code。

phone
可选
string

存在电话时返回。

本地电话号码。

phone_international
可选
string

存在时返回。

国际电话号码。

phone_uri
可选
string

存在时返回。

电话 URI。

website
可选
string

存在官网时返回。

商户官网。

website_domain
可选
string

存在官网域名时返回。

商户官网域名。

latitude
可选
number

存在坐标时返回。

纬度。

longitude
可选
number

存在坐标时返回。

经度。

image
可选
string

存在图片时返回。

地点主图。

thumbnail
可选
string

image 可用时作为别名返回。

主图别名。

photos
可选
MapsPhoto[]

解析到照片时返回。

照片 ID、URL、尺寸和可选坐标。

hours
可选
Record<string,string>

解析到营业时间时返回。

按星期组织的营业时间。

open_status
可选
object

存在营业状态时返回。

营业状态文本和当前营业时间。

attributes
可选
object[]

解析到属性时返回。

分组地点属性。

related_places
可选
object[]

存在相关地点时返回。

Maps payload 中的相关地点。

short_description
可选
string

存在描述块时返回。

地点短描述。

description
可选
string

存在描述块时返回。

地点长描述。

snippet
可选
string

来自 short_description 或 description。

标准化文本摘要。

timezone
可选
string

存在时返回。

地点时区。

region
可选
string

存在时返回。

区域标签。

country_code
可选
string

存在时返回。

国家代码。

language
可选
string

存在时返回。

Maps payload 中的语言代码。

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/google/maps/detail' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"id":"ChIJVVVVVYxK1EARyQpK5cQqEAA"}'
现有 Google 请求示例
bash
curl -X POST https://api.serpbase.dev/google/maps/detail \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key" \
  -d '{
    "feature_id": "0x8085809c2c6fdc63:0x4b3f2d70e4f5a123",
    "hl": "en",
    "gl": "us"
  }'
说明

地点补全、本地 CRM 数据、详情页。

使用 Maps Search 地点结果里的 feature_id 字段请求详情。格式正确但不存在的 feature_id 会返回 status 1004。

POST
可调用
/google/maps/reviews

Google Maps Reviews

获取某个地点(按 data_id)的第一页 Google 地图评论:评分、内容、日期、照片和评论者信息;暂不包含商家回复。

type
google_maps_reviews
result
schemas.source_data
计费
2 点

获取某个地点(按 data_id)的第一页 Google 地图评论:评分、内容、日期、照片和评论者信息;暂不包含商家回复。

参数
data_id
示例
string

目录示例;必填规则由接口校验。

示例: "0x89c25896f660c26f:0x3b2fa4f4b6c6a1fa"

country
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

cursor
可选
string

可选

pagination.cursor 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

dataID
可选
string

可选

data_id 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

device
可选
string

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gl
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

google_domain
可选
string

可选

locale.engine_domain 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gooogle_domain
可选
string

可选

locale.engine_domain 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

hl
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

html
可选
boolean

可选

include_html 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

language
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

limit
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

markdown
可选
boolean

可选

include_markdown 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

mobile
可选
boolean

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

next_page_token
可选
string

可选

next_token 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

num
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

page
可选
integer

可选

pagination.page 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

q
可选
string

可选

query 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

results
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

topic_id
可选
string

可选

attributes.topic_id 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

json
{
  "data_id": "0x89c25896f660c26f:0x3b2fa4f4b6c6a1fa"
}
在 Playground 中调用

响应遵循此产品契约;暂未发布已记录的响应示例。schemas.source_data

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/google/maps/reviews' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"data_id":"0x89c25896f660c26f:0x3b2fa4f4b6c6a1fa"}'
说明

从目录示例开始调用,并查看接口实际返回的 JSON。

示例展示请求参数用法,不代表完整契约。接口会校验已知字段,并允许额外参数。

POST
可调用
/google/autocomplete

Google Search Autocomplete

获取 Google 查询前缀建议;建议不是搜索量统计。

type
google_autocomplete
result
schemas.autocomplete
计费
1 点

获取 Google 查询前缀建议;建议不是搜索量统计。

参数
query
示例
string

目录示例;必填规则由接口校验。

示例: "weather"

json
{
  "query": "weather"
}
在 Playground 中调用

响应遵循此产品契约;暂未发布已记录的响应示例。schemas.autocomplete

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/google/autocomplete' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"query":"weather"}'
说明

从目录示例开始调用,并查看接口实际返回的 JSON。

示例展示请求参数用法,不代表完整契约。接口会校验已知字段,并允许额外参数。

POST
可调用
/google/patents/detail

Google Patent Details

按公开号获取一条 Google Patents 专利:标题、摘要、权利要求、发明人、申请人和各项日期。

type
google_patents_detail
result
schemas.source_data
计费
2 点

按公开号获取一条 Google Patents 专利:标题、摘要、权利要求、发明人、申请人和各项日期。

参数
id
示例
string

目录示例;必填规则由接口校验。

示例: "US8244737B2"

country
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

cursor
可选
string

可选

pagination.cursor 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

device
可选
string

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gl
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

google_domain
可选
string

可选

locale.engine_domain 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gooogle_domain
可选
string

可选

locale.engine_domain 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

hl
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

html
可选
boolean

可选

include_html 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

lanaguage
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

language
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

limit
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

markdown
可选
boolean

可选

include_markdown 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

mobile
可选
boolean

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

num
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

page
可选
integer

可选

pagination.page 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

patent_id
可选
string

可选

id 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

q
可选
string

可选

query 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

results
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

json
{
  "id": "US8244737B2"
}
在 Playground 中调用

响应遵循此产品契约;暂未发布已记录的响应示例。schemas.source_data

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/google/patents/detail' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"id":"US8244737B2"}'
说明

从目录示例开始调用,并查看接口实际返回的 JSON。

示例展示请求参数用法,不代表完整契约。接口会校验已知字段,并允许额外参数。

POST
可调用
/google/play/app

Google Play App Details

按包名获取一个 Google Play 应用的商店页信息:名称、开发者、简介、价格、版本、发布日期和年龄分级。

type
google_play_app
result
schemas.source_data
计费
1 点

按包名获取一个 Google Play 应用的商店页信息:名称、开发者、简介、价格、版本、发布日期和年龄分级。

参数
id
示例
string

目录示例;必填规则由接口校验。

示例: "com.spotify.music"

country
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

cursor
可选
string

可选

pagination.cursor 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

device
可选
string

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gl
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

google_domain
可选
string

可选

locale.engine_domain 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gooogle_domain
可选
string

可选

locale.engine_domain 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

hl
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

html
可选
boolean

可选

include_html 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

language
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

limit
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

markdown
可选
boolean

可选

include_markdown 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

mobile
可选
boolean

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

num
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

page
可选
integer

可选

pagination.page 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

q
可选
string

可选

query 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

results
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

json
{
  "id": "com.spotify.music"
}
在 Playground 中调用

响应遵循此产品契约;暂未发布已记录的响应示例。schemas.source_data

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/google/play/app' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"id":"com.spotify.music"}'
说明

从目录示例开始调用,并查看接口实际返回的 JSON。

示例展示请求参数用法,不代表完整契约。接口会校验已知字段,并允许额外参数。

POST
可调用
/reddit/post

Reddit Post & Comments

Retrieve full Reddit post content, author details, upvotes, and structured comment threads from a Reddit post URL.

type
reddit_post
result
schemas.source_data
计费
2 点

Retrieve full Reddit post content, author details, upvotes, and structured comment threads from a Reddit post URL.

参数
url
示例
string

目录示例;必填规则由接口校验。

示例: "https://www.reddit.com/r/technology/comments/1example/new_ai_breakthrough/"

country
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

cursor
可选
string

可选

pagination.cursor 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

device
可选
string

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gl
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

hl
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

html
可选
boolean

可选

include_html 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

language
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

limit
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

markdown
可选
boolean

可选

include_markdown 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

mobile
可选
boolean

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

num
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

page
可选
integer

可选

pagination.page 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

q
可选
string

可选

query 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

json
{
  "url": "https://www.reddit.com/r/technology/comments/1example/new_ai_breakthrough/"
}
在 Playground 中调用

响应遵循此产品契约;暂未发布已记录的响应示例。schemas.source_data

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/reddit/post' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"url":"https://www.reddit.com/r/technology/comments/1example/new_ai_breakthrough/"}'
说明

从目录示例开始调用,并查看接口实际返回的 JSON。

示例展示请求参数用法,不代表完整契约。接口会校验已知字段,并允许额外参数。

POST
可调用
/tiktok/post

TikTok Post

使用帖子 ID 和用户名查询特定 TikTok 帖子,不是账号全部帖子的发现接口。

type
tiktok_post
result
schemas.source_data
计费
2 点

使用帖子 ID 和用户名查询特定 TikTok 帖子,不是账号全部帖子的发现接口。

参数
id
示例
string

目录示例;必填规则由接口校验。

示例: "7123456789012345678"

username
示例
string

目录示例;必填规则由接口校验。

示例: "tiktok"

country
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

cursor
可选
string

可选

pagination.cursor 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

device
可选
string

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gl
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

hl
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

html
可选
boolean

可选

include_html 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

language
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

limit
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

markdown
可选
boolean

可选

include_markdown 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

mobile
可选
boolean

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

num
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

page
可选
integer

可选

pagination.page 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

post_id
可选
string

可选

id 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

q
可选
string

可选

query 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

json
{
  "id": "7123456789012345678",
  "username": "tiktok"
}
在 Playground 中调用

响应遵循此产品契约;暂未发布已记录的响应示例。schemas.source_data

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/tiktok/post' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"id":"7123456789012345678","username":"tiktok"}'
说明

从目录示例开始调用,并查看接口实际返回的 JSON。

示例展示请求参数用法,不代表完整契约。接口会校验已知字段,并允许额外参数。

POST
可调用
/tiktok/profile

TikTok Profile

按用户名请求 TikTok 资料。数据取决于上游可访问性,不是受众历史档案。

type
tiktok_profile
result
schemas.source_data
计费
2 点

按用户名请求 TikTok 资料。数据取决于上游可访问性,不是受众历史档案。

参数
username
示例
string

目录示例;必填规则由接口校验。

示例: "tiktok"

country
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

cursor
可选
string

可选

pagination.cursor 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

device
可选
string

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gl
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

hl
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

html
可选
boolean

可选

include_html 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

language
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

limit
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

markdown
可选
boolean

可选

include_markdown 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

mobile
可选
boolean

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

num
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

page
可选
integer

可选

pagination.page 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

q
可选
string

可选

query 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

json
{
  "username": "tiktok"
}
在 Playground 中调用

响应遵循此产品契约;暂未发布已记录的响应示例。schemas.source_data

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/tiktok/profile' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"username":"tiktok"}'
说明

从目录示例开始调用,并查看接口实际返回的 JSON。

示例展示请求参数用法,不代表完整契约。接口会校验已知字段,并允许额外参数。

POST
可调用
/x/post

X Post Details

按 ID 查询单个 X 帖子;不是关键词搜索、时间线导出或流式接口。

type
x_post
result
schemas.source_data
计费
1 点

按 ID 查询单个 X 帖子;不是关键词搜索、时间线导出或流式接口。

参数
id
示例
string

目录示例;必填规则由接口校验。

示例: "1234567890123456789"

country
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

cursor
可选
string

可选

pagination.cursor 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

device
可选
string

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gl
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

hl
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

html
可选
boolean

可选

include_html 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

language
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

limit
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

markdown
可选
boolean

可选

include_markdown 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

mobile
可选
boolean

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

num
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

page
可选
integer

可选

pagination.page 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

q
可选
string

可选

query 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

tweetId
可选
string

可选

id 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

json
{
  "id": "1234567890123456789"
}
在 Playground 中调用

响应遵循此产品契约;暂未发布已记录的响应示例。schemas.source_data

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/x/post' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"id":"1234567890123456789"}'
说明

从目录示例开始调用,并查看接口实际返回的 JSON。

示例展示请求参数用法,不代表完整契约。接口会校验已知字段,并允许额外参数。

POST
可调用
/youtube/transcripts

YouTube Video Transcripts

Extract timestamped multi-language video transcripts and closed captions for a YouTube video ID.

type
youtube_transcripts
result
schemas.source_data
计费
2 点

Extract timestamped multi-language video transcripts and closed captions for a YouTube video ID.

参数
id
示例
string

目录示例;必填规则由接口校验。

示例: "dQw4w9WgXcQ"

country
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

cursor
可选
string

可选

pagination.cursor 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

device
可选
string

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gl
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

hl
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

html
可选
boolean

可选

include_html 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

language
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

limit
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

markdown
可选
boolean

可选

include_markdown 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

mobile
可选
boolean

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

num
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

page
可选
integer

可选

pagination.page 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

q
可选
string

可选

query 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

v
可选
string

可选

id 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

video_link
可选
string

可选

url 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

json
{
  "id": "dQw4w9WgXcQ"
}
在 Playground 中调用

响应遵循此产品契约;暂未发布已记录的响应示例。schemas.source_data

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/youtube/transcripts' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"id":"dQw4w9WgXcQ"}'
说明

从目录示例开始调用,并查看接口实际返回的 JSON。

示例展示请求参数用法,不代表完整契约。接口会校验已知字段,并允许额外参数。

POST
可调用
/ajio/product

Ajio Product Details

从 HTTPS /p/ URL 读取单件 AJIO 商品,不是目录导出。

type
ajio_product
result
schemas.source_data
计费
2 点

从 HTTPS /p/ URL 读取单件 AJIO 商品,不是目录导出。

参数
url
示例
string

目录示例;必填规则由接口校验。

示例: "https://www.ajio.com/sample/p/1234567890"

country
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

cursor
可选
string

可选

pagination.cursor 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

device
可选
string

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gl
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

hl
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

html
可选
boolean

可选

include_html 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

language
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

limit
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

markdown
可选
boolean

可选

include_markdown 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

mobile
可选
boolean

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

num
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

page
可选
integer

可选

pagination.page 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

q
可选
string

可选

query 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

json
{
  "url": "https://www.ajio.com/sample/p/1234567890"
}
在 Playground 中调用

响应遵循此产品契约;暂未发布已记录的响应示例。schemas.source_data

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/ajio/product' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"url":"https://www.ajio.com/sample/p/1234567890"}'
说明

从目录示例开始调用,并查看接口实际返回的 JSON。

示例展示请求参数用法,不代表完整契约。接口会校验已知字段,并允许额外参数。

POST
可调用
/amazon/product

Amazon Product Details

Retrieve detailed Amazon product data including titles, multiple variant ASINs, merchant offers, availability, and specs by ASIN.

type
amazon_product
result
schemas.source_data
计费
2 点

Retrieve detailed Amazon product data including titles, multiple variant ASINs, merchant offers, availability, and specs by ASIN.

参数
asin
示例
string

目录示例;必填规则由接口校验。

示例: "B08N5WRWNW"

domain
示例
string

目录示例;必填规则由接口校验。

示例: "amazon.com"

amazon_domain
可选
string

可选

domain 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

country
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

cursor
可选
string

可选

pagination.cursor 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

device
可选
string

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gl
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

hl
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

html
可选
boolean

可选

include_html 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

language
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

limit
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

markdown
可选
boolean

可选

include_markdown 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

mobile
可选
boolean

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

num
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

page
可选
integer

可选

pagination.page 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

q
可选
string

可选

query 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

type
可选
string

可选

search_type 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

json
{
  "asin": "B08N5WRWNW",
  "domain": "amazon.com"
}
在 Playground 中调用

响应遵循此产品契约;暂未发布已记录的响应示例。schemas.source_data

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/amazon/product' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"asin":"B08N5WRWNW","domain":"amazon.com"}'
说明

从目录示例开始调用,并查看接口实际返回的 JSON。

示例展示请求参数用法,不代表完整契约。接口会校验已知字段,并允许额外参数。

POST
可调用
/amazon/reviews

Amazon Product Reviews

Extract authentic customer reviews, star ratings, review text, and reviewer attributes for an Amazon product ASIN.

type
amazon_reviews
result
schemas.source_data
计费
2 点

Extract authentic customer reviews, star ratings, review text, and reviewer attributes for an Amazon product ASIN.

参数
asin
示例
string

目录示例;必填规则由接口校验。

示例: "B08N5WRWNW"

domain
示例
string

目录示例;必填规则由接口校验。

示例: "amazon.com"

amazon_domain
可选
string

可选

domain 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

country
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

cursor
可选
string

可选

pagination.cursor 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

device
可选
string

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

filter_by_star
可选
string

可选

review_rating 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gl
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

hl
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

html
可选
boolean

可选

include_html 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

language
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

limit
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

markdown
可选
boolean

可选

include_markdown 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

mobile
可选
boolean

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

num
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

page
可选
integer

可选

pagination.page 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

q
可选
string

可选

query 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

reviewer_type
可选
string

可选

review_type 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

type
可选
string

可选

search_type 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

json
{
  "asin": "B08N5WRWNW",
  "domain": "amazon.com"
}
在 Playground 中调用

响应遵循此产品契约;暂未发布已记录的响应示例。schemas.source_data

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/amazon/reviews' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"asin":"B08N5WRWNW","domain":"amazon.com"}'
说明

从目录示例开始调用,并查看接口实际返回的 JSON。

示例展示请求参数用法,不代表完整契约。接口会校验已知字段,并允许额外参数。

POST
可调用
/amazon/autocomplete

Amazon Search Autocomplete

根据前缀获取 Amazon 查询建议,不返回商品详情或价格历史。

type
amazon_autocomplete
result
schemas.source_data
计费
1 点

根据前缀获取 Amazon 查询建议,不返回商品详情或价格历史。

参数
prefix
示例
string

目录示例;必填规则由接口校验。

示例: "laptop"

amazon_domain
可选
string

可选

domain 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

country
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

cursor
可选
string

可选

pagination.cursor 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

device
可选
string

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gl
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

hl
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

html
可选
boolean

可选

include_html 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

language
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

limit
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

markdown
可选
boolean

可选

include_markdown 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

mid
可选
string

可选

marketplace_id 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

mobile
可选
boolean

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

num
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

page
可选
integer

可选

pagination.page 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

q
可选
string

可选

query 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

type
可选
string

可选

search_type 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

json
{
  "prefix": "laptop"
}
在 Playground 中调用

响应遵循此产品契约;暂未发布已记录的响应示例。schemas.source_data

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/amazon/autocomplete' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"prefix":"laptop"}'
说明

从目录示例开始调用,并查看接口实际返回的 JSON。

示例展示请求参数用法,不代表完整契约。接口会校验已知字段,并允许额外参数。

POST
可调用
/apple/product

Apple Product Details

使用数字应用 ID 或 apps.apple.com URL 和国家查询 App Store 应用;不是 Apple 硬件。

type
apple_product
result
schemas.source_data
计费
1 点

使用数字应用 ID 或 apps.apple.com URL 和国家查询 App Store 应用;不是 Apple 硬件。

参数
id
示例
string

目录示例;必填规则由接口校验。

示例: "284882215"

country
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

cursor
可选
string

可选

pagination.cursor 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

device
可选
string

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gl
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

hl
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

html
可选
boolean

可选

include_html 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

language
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

limit
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

markdown
可选
boolean

可选

include_markdown 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

mobile
可选
boolean

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

num
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

page
可选
integer

可选

pagination.page 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

product_id
可选
string

可选

id 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

q
可选
string

可选

query 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

type
可选
string

可选

search_type 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

json
{
  "id": "284882215"
}
在 Playground 中调用

响应遵循此产品契约;暂未发布已记录的响应示例。schemas.source_data

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/apple/product' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"id":"284882215"}'
说明

从目录示例开始调用,并查看接口实际返回的 JSON。

示例展示请求参数用法,不代表完整契约。接口会校验已知字段,并允许额外参数。

POST
可调用
/ebay/product

eBay Product Details

Retrieve detailed eBay item data, current auction prices, seller ratings, and listing specifications by item ID.

type
ebay_product
result
schemas.source_data
计费
2 点

Retrieve detailed eBay item data, current auction prices, seller ratings, and listing specifications by item ID.

参数
domain
示例
string

目录示例;必填规则由接口校验。

示例: "ebay.com"

id
示例
string

目录示例;必填规则由接口校验。

示例: "123456789012"

country
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

cursor
可选
string

可选

pagination.cursor 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

device
可选
string

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gl
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

hl
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

html
可选
boolean

可选

include_html 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

language
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

limit
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

markdown
可选
boolean

可选

include_markdown 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

mobile
可选
boolean

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

num
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

page
可选
integer

可选

pagination.page 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

q
可选
string

可选

query 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

json
{
  "domain": "ebay.com",
  "id": "123456789012"
}
在 Playground 中调用

响应遵循此产品契约;暂未发布已记录的响应示例。schemas.source_data

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/ebay/product' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"domain":"ebay.com","id":"123456789012"}'
说明

从目录示例开始调用,并查看接口实际返回的 JSON。

示例展示请求参数用法,不代表完整契约。接口会校验已知字段,并允许额外参数。

POST
可调用
/flipkart/product

Flipkart Product Details

从含 /p/ 的商品 URL 读取 Flipkart 商品,使用具体 URL 而非查询词。

type
flipkart_product
result
schemas.source_data
计费
2 点

从含 /p/ 的商品 URL 读取 Flipkart 商品,使用具体 URL 而非查询词。

参数
url
示例
string

目录示例;必填规则由接口校验。

示例: "https://www.flipkart.com/item/p/itm1234567890"

country
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

cursor
可选
string

可选

pagination.cursor 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

device
可选
string

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gl
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

hl
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

html
可选
boolean

可选

include_html 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

language
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

limit
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

markdown
可选
boolean

可选

include_markdown 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

mobile
可选
boolean

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

num
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

page
可选
integer

可选

pagination.page 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

q
可选
string

可选

query 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

json
{
  "url": "https://www.flipkart.com/item/p/itm1234567890"
}
在 Playground 中调用

响应遵循此产品契约;暂未发布已记录的响应示例。schemas.source_data

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/flipkart/product' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"url":"https://www.flipkart.com/item/p/itm1234567890"}'
说明

从目录示例开始调用,并查看接口实际返回的 JSON。

示例展示请求参数用法,不代表完整契约。接口会校验已知字段,并允许额外参数。

POST
可调用
/myntra/product

Myntra Product Details

从 /buy URL 读取单个 Myntra 商品,与 Myntra 搜索接口分开。

type
myntra_product
result
schemas.source_data
计费
2 点

从 /buy URL 读取单个 Myntra 商品,与 Myntra 搜索接口分开。

参数
url
示例
string

目录示例;必填规则由接口校验。

示例: "https://www.myntra.com/shoes/nike/123456/buy"

country
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

cursor
可选
string

可选

pagination.cursor 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

device
可选
string

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gl
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

hl
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

html
可选
boolean

可选

include_html 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

language
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

limit
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

markdown
可选
boolean

可选

include_markdown 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

mobile
可选
boolean

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

num
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

page
可选
integer

可选

pagination.page 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

q
可选
string

可选

query 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

json
{
  "url": "https://www.myntra.com/shoes/nike/123456/buy"
}
在 Playground 中调用

响应遵循此产品契约;暂未发布已记录的响应示例。schemas.source_data

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/myntra/product' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"url":"https://www.myntra.com/shoes/nike/123456/buy"}'
说明

从目录示例开始调用,并查看接口实际返回的 JSON。

示例展示请求参数用法,不代表完整契约。接口会校验已知字段,并允许额外参数。

POST
可调用
/walmart/product

Walmart Product Details

Extract full Walmart product specification, pricing, variant details, and descriptions using Walmart item ID.

type
walmart_product
result
schemas.source_data
计费
2 点

Extract full Walmart product specification, pricing, variant details, and descriptions using Walmart item ID.

参数
id
示例
string

目录示例;必填规则由接口校验。

示例: "133497934"

country
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

cursor
可选
string

可选

pagination.cursor 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

device
可选
string

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gl
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

hl
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

html
可选
boolean

可选

include_html 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

language
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

limit
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

markdown
可选
boolean

可选

include_markdown 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

mobile
可选
boolean

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

num
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

page
可选
integer

可选

pagination.page 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

q
可选
string

可选

query 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

json
{
  "id": "133497934"
}
在 Playground 中调用

响应遵循此产品契约;暂未发布已记录的响应示例。schemas.source_data

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/walmart/product' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"id":"133497934"}'
说明

从目录示例开始调用,并查看接口实际返回的 JSON。

示例展示请求参数用法,不代表完整契约。接口会校验已知字段,并允许额外参数。

POST
可调用
/walmart/autocomplete

Walmart Search Autocomplete

按查询获取 Walmart 搜索建议,不读取 Walmart 商品页。

type
walmart_autocomplete
result
schemas.source_data
计费
1 点

按查询获取 Walmart 搜索建议,不读取 Walmart 商品页。

参数
query
示例
string

目录示例;必填规则由接口校验。

示例: "laptop"

country
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

cursor
可选
string

可选

pagination.cursor 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

device
可选
string

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gl
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

hl
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

html
可选
boolean

可选

include_html 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

language
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

limit
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

markdown
可选
boolean

可选

include_markdown 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

mobile
可选
boolean

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

num
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

page
可选
integer

可选

pagination.page 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

q
可选
string

可选

query 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

json
{
  "query": "laptop"
}
在 Playground 中调用

响应遵循此产品契约;暂未发布已记录的响应示例。schemas.source_data

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/walmart/autocomplete' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"query":"laptop"}'
说明

从目录示例开始调用,并查看接口实际返回的 JSON。

示例展示请求参数用法,不代表完整契约。接口会校验已知字段,并允许额外参数。

POST
可调用
/web/user-agent

User-Agent Generator

使用 user_agent_type 和 user_agent_count(1–5)生成桌面或移动 UA。此本地操作仍按目录价格收费。

type
web_user_agent
result
schemas.source_data
计费
1 点

使用 user_agent_type 和 user_agent_count(1–5)生成桌面或移动 UA。此本地操作仍按目录价格收费。

参数
user_agent_count
示例
number

目录示例;必填规则由接口校验。

示例: 1

user_agent_type
示例
string

目录示例;必填规则由接口校验。

示例: "desktop"

country
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

cursor
可选
string

可选

pagination.cursor 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

device
可选
string

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gl
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

hl
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

html
可选
boolean

可选

include_html 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

language
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

limit
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

markdown
可选
boolean

可选

include_markdown 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

mobile
可选
boolean

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

num
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

page
可选
integer

可选

pagination.page 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

q
可选
string

可选

query 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

uanum
可选
integer

可选

user_agent_count 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

uatype
可选
string

可选

user_agent_type 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

json
{
  "user_agent_count": 1,
  "user_agent_type": "desktop"
}
在 Playground 中调用

响应遵循此产品契约;暂未发布已记录的响应示例。schemas.source_data

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/web/user-agent' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"user_agent_count":1,"user_agent_type":"desktop"}'
说明

从目录示例开始调用,并查看接口实际返回的 JSON。

示例展示请求参数用法,不代表完整契约。接口会校验已知字段,并允许额外参数。

POST
可调用
/web/crawl

Web Crawl

从公开网站 URL 开始有界抓取;每个客户请求固定计价,不乘以返回页数。

type
web_crawl
result
schemas.source_data
计费
1 点

从公开网站 URL 开始有界抓取;每个客户请求固定计价,不乘以返回页数。

参数
url
示例
string

目录示例;必填规则由接口校验。

示例: "https://example.com"

country
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

cursor
可选
string

可选

pagination.cursor 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

device
可选
string

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gl
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

hl
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

html
可选
boolean

可选

include_html 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

language
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

limit
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

markdown
可选
boolean

可选

include_markdown 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

mobile
可选
boolean

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

num
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

page
可选
integer

可选

pagination.page 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

q
可选
string

可选

query 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

json
{
  "url": "https://example.com"
}
在 Playground 中调用

响应遵循此产品契约;暂未发布已记录的响应示例。schemas.source_data

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/web/crawl' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"url":"https://example.com"}'
说明

从目录示例开始调用,并查看接口实际返回的 JSON。

示例展示请求参数用法,不代表完整契约。接口会校验已知字段,并允许额外参数。

POST
可调用
/web/scrape

Web Scrape

按 URL 提取公开 HTTP/HTTPS 网页,支持文本、HTML、Markdown 和选择器选项;来源限制仍适用。不支持抓取谷歌页面,请使用 /google/search 等谷歌接口。

type
web_scrape
result
schemas.source_data
计费
1 点

按 URL 提取公开 HTTP/HTTPS 网页,支持文本、HTML、Markdown 和选择器选项;来源限制仍适用。不支持抓取谷歌页面,请使用 /google/search 等谷歌接口。

参数
url
示例
string

目录示例;必填规则由接口校验。

示例: "https://example.com"

country
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

cursor
可选
string

可选

pagination.cursor 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

custom_headers
可选
object

可选

headers 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

device
可选
string

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

gl
可选
string

可选

locale.country 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

hl
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

html
可选
boolean

可选

include_html 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

language
可选
string

可选

locale.language 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

limit
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

markdown
可选
boolean

可选

include_markdown 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

mobile
可选
boolean

可选

options.device 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

num
可选
integer

可选

pagination.limit 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

page
可选
integer

可选

pagination.page 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

q
可选
string

可选

query 的兼容写法。每次使用其中一种;接口会校验本产品支持的参数与取值。

json
{
  "url": "https://example.com"
}
在 Playground 中调用

响应遵循此产品契约;暂未发布已记录的响应示例。schemas.source_data

代码与响应示例
bash
curl -X POST 'https://api.serpbase.dev/web/scrape' \
  -H "Content-Type: application/json" \
  -H 'X-API-Key: YOUR_API_KEY' \
  -d '{"url":"https://example.com"}'
说明

从目录示例开始调用,并查看接口实际返回的 JSON。

示例展示请求参数用法,不代表完整契约。接口会校验已知字段,并允许额外参数。

错误
error
必填
string

必填

可读错误信息。

0
SUCCESS

请求成功完成。请检查产品响应字段;no_results 本身不能证明 HTTP 404。

扣费

1000
INVALID_REQUEST

请求体或参数缺失/无效。

不扣费先修正请求再发

1001
UNAUTHORIZED

API key 缺失、无效或已撤销。

不扣费先修正请求再发

1004
NOT_FOUND

网关未注册此路由或资源不存在。

不扣费先修正请求再发

1020
INSUFFICIENT_CREDITS

账号余额不足。

不扣费先修正请求再发

1029
RATE_LIMITED

QPS 或并发限制已触发。

不扣费可以重试

1500
INTERNAL_ERROR

意外的内部服务错误。

不扣费可以重试

1502
UPSTREAM_FAILED

worker 返回上游抓取或解析错误。

不扣费可以重试

1503
SERVICE_UNAVAILABLE

当前没有可用 worker 会话。

不扣费可以重试

1504
UPSTREAM_TIMEOUT

网关等待 worker 结果超时。

不扣费可以重试

json
{
  "status": 1001,
  "error": "unauthorized",
  "request_id": "0f3576b2-6e2e-4f1e-bb0e-8cb0d4a60195",
  "elapsed_ms": 0,
  "credits_charged": 0
}
响应头

每个接口响应都带有这些响应头,客户端可以据此控制节奏、判断是否重试,不用解析错误文字。

X-RateLimit-Limit
你的账户每秒允许的请求数。
X-RateLimit-Remaining
当前这一秒还能再发多少个请求。
Retry-After
被拒绝时,建议等几秒再发。
X-SerpBase-Retryable
true 表示原样重发有可能成功;false 表示请求本身要改。
联系客服时
请附上响应里的 request_id(成功和失败的响应都有)以及调用时间。有了它我们几秒钟就能找到那次请求,没有的话只能来回询问。
隐私与留存
搜索词可能用于计费、排障、风控和账号日志。具体留存说明见隐私页面。