仅 POST

API 文档

按接口拆开的 Google Search、Images、News、Videos、Maps Search 和 Maps Detail 参考文档。

Base URL
https://test-api.serpbase.dev
认证请求头
X-API-Key
计费
成功请求按 1 或 2 点扣费
认证

使用 POST JSON 请求,并在 X-API-Key 请求头传入 API key。成功和失败都会返回 JSON body。

elapsed_ms

公共响应结构

credits_charged

成功请求按 1 或 2 点扣费

request_id

support trace id

最小请求
bash
curl -X POST https://test-api.serpbase.dev/google/search \
  -H "Content-Type: application/json" \
  -H "X-API-Key: your_api_key" \
  -d '{"q":"openai realtime api","hl":"en","gl":"us"}'
公共响应结构

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

status
必填
number

必填

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

request_id
必填
string

必填

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

elapsed_ms
必填
number

必填

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

credits_charged
必填
number

必填

退款逻辑处理后实际扣除的点数。

search_type
必填
string

必填

解析后的接口类型:search、images、news、videos、maps_search 或 maps_detail。

接口
POST
/google/images

图片搜索

图片 URL、缩略图、来源页面和域名。

type
images
result
images
计费
2 点
参数
q
必填
string

必填

搜索查询字符串。

hl
可选
string

可选

语言代码,默认 en。

gl
可选
string

可选

国家代码,默认 us。

page
可选
number

可选

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

响应字段
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://test-api.serpbase.dev/google/images \
  -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

新闻搜索

新闻文章,包含发布方、时间文本、摘要和缩略图。

type
news
result
news
计费
1 点
参数
q
必填
string

必填

搜索查询字符串。

hl
可选
string

可选

语言代码,默认 en。

gl
可选
string

可选

国家代码,默认 us。

page
可选
number

可选

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

响应字段
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://test-api.serpbase.dev/google/news \
  -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

视频搜索

视频结果链接,包含来源、时长、时间和缩略图。

type
videos
result
videos
计费
1 点
参数
q
必填
string

必填

搜索查询字符串。

hl
可选
string

可选

语言代码,默认 en。

gl
可选
string

可选

国家代码,默认 us。

page
可选
number

可选

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

响应字段
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://test-api.serpbase.dev/google/videos \
  -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

地图详情

通过 Google Maps feature_id 获取单个地点详情。

type
maps_detail
result
place
计费
2 点
参数
feature_id
必填
string

必填

Google Maps feature id,格式类似 0x...:0x...。

hl
可选
string

可选

语言代码,默认 en。

gl
可选
string

可选

国家代码,默认 us。

响应字段
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://test-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,再请求详情。

错误
error
必填
string

必填

可读错误信息。

0
SUCCESS

请求成功完成。

1000
INVALID_REQUEST

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

1001
UNAUTHORIZED

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

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
}
隐私与留存
搜索词可能用于计费、排障、风控和账号日志。具体留存说明见隐私页面。