1. SDK
Dataify
  • 介绍
    • 概览
    • 支持
  • 数据服务
    • 新手指南文档
    • MCP教程配置
    • 网页采集 API
      • 简介
      • 快速入门
      • 发送您的第一个请求
      • API 请求配置
      • 请求参数说明
        • 亚马逊参数
        • Walmart 参数
        • eBay 参数
    • 视频采集 API
      • 简介
      • 快速入门
      • 发送您第一个请求
      • API 请求构建器
      • 请求参数说明
    • 搜索引擎 API
      • 简介
      • 快速入门
      • 发送您的第一次请求
      • 常见问题
      • 计费说明
      • 响应代码
      • 请求参数说明
        • Google
          • 谷歌搜索
          • 谷歌 AI mode
          • 谷歌新闻
          • 谷歌图片
          • 谷歌地图
          • 谷歌航班
          • 谷歌工作
          • 谷歌本地
          • 谷歌视频
          • 谷歌购物
          • 谷歌镜头
          • 谷歌趋势
          • 谷歌商店
          • 谷歌学术
          • 谷歌金融
          • 谷歌酒店
          • 谷歌专利
        • Bing
          • Bing 搜索
          • Bing 地图
          • Bing购物
          • Bing 视频
          • Bing图片
          • Bing 新闻
        • Yandex
          • Yandex
        • DuckDuckGo
          • DuckDuckGo搜索API
      • 返回字段说明
        • Google
          • 谷歌搜索API
          • 谷歌 AI Mode
          • 谷歌图片API
          • 谷歌购物API
          • 谷歌视频API
          • 谷歌新闻API
          • 谷歌地图API
          • 谷歌镜头API
          • 谷歌航班API
          • 谷歌学术API
          • 谷歌酒店API
          • 谷歌工作API
          • 谷歌趋势API
          • 谷歌本地API
          • 谷歌商店API
          • 谷歌金融API
        • Bing
          • Bing搜索API
          • Bing地图API
          • Bing购物API
          • Bing视频API
          • Bing搜索API
          • Bing图片API
          • Bing新闻API
        • Yandex
          • Yandex搜索API
    • 通用采集 API
      • 简介
      • 快速入门
      • 发送您的第一次请求
      • 参数说明
      • 计费说明
      • 响应代码
    • 常见问题
      • 常见问题
  • 网络基础设施
    • 动态网络服务
      • 动态住宅网络
        • 简介
        • 快速入门
          • 账密认证
          • 白名单
          • 国家/地区列表
      • 高带宽网络
        • 简介
        • 快速入门
          • 账户认证
    • 静态网络服务
      • 静态ISP网络
        • 简介
        • 快速入门
      • 静态数据中心
        • 简介
        • 快速入门
  • 公共API
    • 介绍
    • 获取token
    • 账户
      • 查询流量余额
      • 查询积分余额
      • 查询流量使用记录
    • 地理位置
      • 获取国家列表
      • 获取州列表
      • 获取城市列表
      • 获取 ASN 列表
    • 网络服务用户
      • 更新网络服务用户信息
      • 删除网络服务用户
      • 按天查询流量使用记录
      • 按小时查询流量使用记录
    • 白名单
      • 读取白名单网络地址列表
      • 创建白名单网络地址
      • 删除白名单网络地址
    • ISP/数据中心网络
      • 获取网络节点列表
      • 查询网络节点过期时间
    • 动态高带宽
      • 获取动态高带宽服务器列表
      • 重启动态高带宽服务器
      • 动态高带宽服务器续费
      • 动态高带宽升级
      • 高带宽服务器子账户白名单列表
      • 添加子账户到高带宽服务器白名单
      • 将子账户从高带宽服务器白名单删除
    • 通用采集API
      • 获取任务接口API
      • 使用统计API
    • 网页采集API
      • 网页采集使用统计
      • 任务接口API
        • 创建任务说明
        • 任务运行状态说明
        • 任务列表获取说明
        • 任务下载获取说明
        • 获取最新任务说明
    • 搜索引擎API
      • 使用统计API
      • 任务接口
        • 谷歌搜索API
        • Bing搜索API
        • Yandex搜索API
        • DuckDuckGo搜索API
  • 集成
    • AdsPower
    • BitBrowser
    • ClonBrowser
    • Hubstudio
    • Puppeteer
    • Playwright
    • Selenium
    • Chrome
  • 常见问题
    • 支付问题
    • 数据服务
    • 网络基础设施
  • SDK
    • Go SDK 使用说明
    • JavaScript SDK 使用说明
    • Python SDK 使用说明
    • TypeScript SDK 使用说明
  • SDK Copy
    • Go SDK 使用说明
    • JavaScript SDK 使用说明
    • Python SDK 使用说明
    • TypeScript SDK 使用说明
  • CLI 命令行
    • 概述
    • 安装
    • 命令
    • 示例
    • 常见问题
  • MCP 服务端
    • 概述
    • 工具
    • 使用示例
    • 数据输出格式
    • 常见问题
    • 远程模式
      • 快速入门
      • 进阶
  • SKILLS
    • SKILLS 使用说明
  1. SDK

TypeScript SDK 使用说明

本指南介绍如何安装 Dataify TypeScript 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 等)、Web Unlocker。

安装与配置#

配置#

须提供 Dataify API Key。可在 Dataify 控制台获取。
选项 1:环境变量(推荐)
选项 2:直接初始化
import { DataifyClient } from "dataify-sdk";

// 用 apiKey 初始化客户端(也可改用环境变量 DATAIFY_API_KEY)
const client = new DataifyClient({
  apiKey: "your_api_key_here",
});
DataifyClient 构造参数(DataifyClientOptions):
参数说明默认值
apiKeyDataify API Key必填
scraperBaseUrlScraper / SERP 基址https://scraperapi.dataify.com
webUnlockerBaseUrlWeb Unlocker 基址https://webunlocker.dataify.com
timeoutMs请求超时(毫秒)内置默认
fetchImpl自定义 fetch 实现全局 fetch

基本用法#

所有调用均返回 Promise,使用 await:
import { DataifyClient } from "dataify-sdk";

// 从环境变量读取 key(生产推荐)
const client = new DataifyClient({
  apiKey: process.env.DATAIFY_API_KEY!,
});

async function main() {
  // 所有调用返回 Promise,需用 await 取结果
  const result = await client.tools.google({ q: "Dataify", json: "1" });
  console.log(result);
}

// 顶层 await 不可用,用 .catch 兜住异常
main().catch(console.error);

发起搜索引擎(SERP)#

SERP 方法挂在 client.tools 下,按引擎命名(如 google、bing、googleImages、googleNews)。以下按引擎分列(若把文档部署到 VitePress / Docusaurus,可将下列分节改写为 <Tabs> 交互标签):

Google 搜索#

// q 为关键词;json:"1" 让上游返回 JSON 而非 HTML
const result = await client.tools.google({
  q: "best shoes of 2025",
  json: "1",
});
console.log(result);

Google 图片#

const result = await client.tools.googleImages({
  q: "noise cancelling headphones",
});
console.log(result);

Google 新闻 / 趋势 / 地图#

const news = await client.tools.googleNews({ q: "AI latest" });
const trends = await client.tools.googleTrends({ q: "fashion" });
const maps = await client.tools.googleMaps({ q: "coffee shop near me" });

Bing 搜索#

const result = await client.tools.bing({ q: "python tutorial" });
console.log(result);
全部 SERP 方法见 client.tools.specs。

平台专用采集(Scrapers)#

采集工具同样挂在 client.tools 下,方法名采用小驼峰(如 amazonProductByAsin、linkedinCompanyInformationByUrl)。以下按平台分列:

Amazon#

// 按 ASIN 采集商品
const product = await client.tools.amazonProductByAsin({
  asin: "B0BZYCJK89",
});
console.log(product);

// 按商品 URL 采集评论
const comments = await client.tools.amazonCommentByUrl({
  url: "https://www.amazon.com/dp/B0BZYCJK89",
});

LinkedIn#

// 按公司 URL 采集公司信息
const company = await client.tools.linkedinCompanyInformationByUrl({
  url: "https://www.linkedin.com/company/example",
});

// 按关键词采集职位列表
const jobs = await client.tools.linkedinJobListingsInformationByKeyword({
  keyword: "data engineer",
  location: "Remote",
});

Instagram / YouTube / Walmart#

const profile = await client.tools.insProfilesByUsername({ username: "nasa" });
const video = await client.tools.youtubeProductById({ videoId: "dQw4w9WgXcQ" });
const item = await client.tools.walmartProductByUrl({ url: "https://www.walmart.com/ip/..." });
全部工具名(含参数)见 client.tools.specs,或在 IDE 中将鼠标悬停在 client.tools 上查看完整列表与类型提示。

Web Unlocker#

// 解锁并抓取任意网页
const result = await client.webUnlocker.request({
  url: "https://example.com",
  type: "html",
  js_render: false, // 是否渲染 JS
});
console.log(result);

下载抓取结果#

// 按 task id 下载 JSON 结果
const json = await client.scraper.downloadTaskResult("task_id_here");
console.log(json);

// 下载为文件(格式:xlsx / csv / json)
const response = await client.scraper.downloadTaskFile("task_id_here", "xlsx");
console.log(response.status);

运行时端点与鉴权#

能力端点
Scraper / SERPhttps://scraperapi.dataify.com
Web Unlockerhttps://webunlocker.dataify.com
所有请求均携带 Authorization: Bearer <apiKey>。

安全注意事项#

不要在浏览器前端代码中直接使用本 SDK,否则 API Key 会暴露。
推荐架构:前端 → 你的后端 → dataify-sdk → Dataify APIs。

类型提示与编辑器支持(IntelliSense)#

所有方法参数、ParamRecord、返回值均有完整类型标注;在 VS Code / WebStorm 中将鼠标悬停在 client.tools.amazonProductByAsin 等上即可看到参数与文档。
运行时可用 client.tools.specs 自省全部工具元信息(含 params / required / id)。

错误处理#

所有方法返回 Promise,用 try/catch 捕获异常;异常对象(网络/上游错误)含 status 与 body 字段:
try {
  const r = await client.tools.google({ q: "Dataify", json: "1" });
  console.log(r);
} catch (e: any) {
  // 异常对象含 status(HTTP 状态码)与 body(响应体)
  console.error("HTTP", e?.status, "body:", e?.body ?? e?.message);
}

完整示例#

import { DataifyClient } from "dataify-sdk";

// 1) 用环境变量 key 初始化客户端
const client = new DataifyClient({
  apiKey: process.env.DATAIFY_API_KEY!,
});

async function main() {
  // 2) SERP:Google 搜索
  const result = await client.tools.google({
    q: "Dataify",
    json: "1",
  });
  console.log(result);

  // 3) 平台采集:按 ASIN 抓 Amazon 商品
  const product = await client.tools.amazonProductByAsin({
    asin: "B0BZYCJK89",
  });
  console.log(product);
}

main().catch(console.error);

资源#

资源说明链接
📘 GitHub 仓库查看源码、示例并做出贡献GitHub
📦 npm 页面软件包列表与发布历史记录dataify-sdk
修改于 2026-08-10 06:01:58
上一页
Python SDK 使用说明
下一页
Go SDK 使用说明
Built with