Python SDK 使用说明

本指南介绍如何安装 Dataify Python SDK 并调用其全部功能：SERP 搜索引擎（Google、Bing、Yandex、DuckDuckGo、Google Images / News / Maps 等）与平台专用采集（Amazon、LinkedIn、Instagram、TikTok、YouTube、Reddit、Twitter、Airbnb、Booking、Crunchbase、eBay、Facebook、GitHub、Glassdoor、Indeed、Walmart、Zillow、Google Maps 等）。SDK 零第三方依赖（仅标准库 urllib）、同步 HTTP，每个工具函数的签名都完整暴露全部上游参数。

安装与配置

通过 pip 安装：

安装后导入包名为 dataify_sdk（注意下划线，不是连字符）。

配置

须提供 Dataify API Token。可在 Dataify 控制台获取。

选项 1：环境变量（推荐）

选项 2：直接初始化

DataifyClient 构造参数：

参数	说明	默认值
`token`	Dataify API Token	必填（或经环境变量 `DATAIFY_TOKEN`）
`base_url`	上游基址	`https://scraperapi.dataify.com`
`timeout`	请求超时（秒）	`120`

基本用法

DataifyClient 为同步实现（零依赖，无异步客户端）。每个工具是一个独立函数，签名已带默认值，docstring 列出全部上游参数：

省略 client= 时会自动使用进程级默认客户端（需先在环境中设置 DATAIFY_TOKEN）：
result = google_images(q="noise cancelling headphones")。

发起搜索引擎（SERP）

SERP 工具函数按引擎命名，挂在 dataify_sdk.tools.<模块> 下。

Google 搜索

Google 图片

Google 新闻

Bing 搜索

全部 SERP 引擎（含 google_maps、google_trends、google_finance、duckduckgo、yandex 等）的工具名见 docs/api_reference.md。

平台专用采集（Scrapers）

平台采集工具是一个独立函数，命名规律为「上游 spider_id 去掉连字符转为下划线」（如 amazon_product_by_asin、linkedin_company_information_by_url）。以下按平台分列：

Amazon

Google Maps

Instagram / YouTube / Walmart

如何找到某个工具

全部 113 个工具名、参数表与中文说明见仓库内 docs/api_reference.md。

在 Python 中查看已导出工具名：

底层客户端方法（高级用法）

如需自己拼装请求，可使用底层方法（request_serp 走搜索通道、request_scraper 走采集通道）：

返回值与错误处理

request_serp / request_scraper 与所有工具函数均返回解析后的 dict；HTTP 状态码只在出错时由异常携带。

所有异常继承自 dataify_sdk.errors.DataifyError：

异常	含义
`DataifyAPIError(message, status_code, body)`	上游返回错误（`status_code` 为 HTTP 状态码，`body` 为响应体）
`DataifyConnectionError`	网络不可达
`DataifyTimeoutError`	请求超时

安全注意事项

Token 等同于账号凭证，不要提交到代码仓库或写入前端代码；推荐使用环境变量 DATAIFY_TOKEN。

本 SDK 为纯服务端同步库，不涉及浏览器，但请妥善保管 Token 不外泄。

推荐架构：前端 → 你的后端 → dataify_sdk → Dataify APIs。

类型提示与编辑器支持

Python 为动态语言，无编译期类型校验，但每个工具函数都带有：

完整参数默认值与类型标注（def google_images(q: str = 'pizza', client: DataifyClient | None = None)）；

中文 docstring 列出全部上游参数与必填项。

在支持的语言服务器（VS Code + Pylance、PyCharm）中，将鼠标悬停在函数名上即可看到参数与说明；完整参数表见 docs/api_reference.md。

完整示例

资源

资源	说明	链接
📘 GitHub 仓库	查看源码、示例并做出贡献	GitHub
📦 PyPI 页面	软件包列表与发布历史记录	dataify-sdk

Python SDK 使用说明

安装与配置#

配置#

基本用法#

发起搜索引擎（SERP）#

Google 搜索#

Google 图片#

Google 新闻#

Bing 搜索#

平台专用采集（Scrapers）#

Amazon#

LinkedIn#

Google Maps#

Instagram / YouTube / Walmart#

如何找到某个工具#

底层客户端方法（高级用法）#

返回值与错误处理#

安全注意事项#

类型提示与编辑器支持#

完整示例#

资源#