@getanyapi/sdk

中文文档
0.154.0发布于 2026/11/16MITTypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 4万

AnyAPI的官方打入了TypeScript SDK:任意API,一个钱包,$,没有订阅.

中文使用文档
文档目录10 节
  1. 快速启动
  2. 未找到 vs 错误
  3. 发现
  4. 倾斜
  5. 请求选项( 文本成本保存器)
  6. 错误和重复
  7. 等待一个仍在飞行的跑道
  8. 代理注册
  9. 文档
  10. 许可证

@ getanyapi/ sdk 时

正式键入类型SDK AnAPI 软件: 任何API,一个钱包,$, 无订阅。 通过一个接口和一个键,达到数百个刮取和数据API; 按实际美元计算。 零运行时间依赖关系(全球) fetch),无害环境管理+CJS, 18+节点和边缘运行时间.

npm install @getanyapi/sdk

快速启动

import { AnyAPI } from "@getanyapi/sdk";

// Reads ANYAPI_API_KEY from the environment when apiKey is omitted.
const client = new AnyAPI({ apiKey: process.env.ANYAPI_API_KEY });

const res = await client.reddit.search({ query: "mechanical keyboard" });
if (res.output.found) {
  for (const post of res.output.data.posts) console.log(post.title, post.score);
}
console.log("charged", res.costUsd, "USD");

每个SKU都是其平台命名空间下的一种打入方法(client.amazon.reviews(...), (中文(简体) ), client.google.search(...)) (中文(简体) ). 您也可以一般地用 sKU 拨打全打字 :

const rev = await client.run("amazon.reviews", {
  product: "B07FZ8S74R",
  limit: 3,
});

未找到 vs 错误

一个成功的呼吁总是解决的。 对于大多数SKU来说,有效载荷被包裹在一个 found 旗帜 : output.found 实值 false 当上游没有匹配的实体时(这不是错误). 使用 unwrap 获取数据或丢出 ResultNotFoundError 空时 :

import { unwrap, ResultNotFoundError } from "@getanyapi/sdk";

const res = await client.amazon.reviews({ product: "B07FZ8S74R" });
try {
  const data = unwrap(res); // the typed data payload, or throws
} catch (e) {
  if (e instanceof ResultNotFoundError) {
    // empty result (found: false), not an HTTP failure
  }
}

ResultNotFoundError 扩展 NotFoundError这样 catch (NotFoundError) 两个都抓了 HTTP 404 和空结果; 捕获 ResultNotFoundError 只处理空结果。 如果有的话 未来承诺的计划使用裸出,生成的打入直接返回其数据对象 而不是依赖硬编码的SKU列表.

发现

const apis = await client.catalog({ category: "search" });
const matches = await client.search({
  query: "web search",
  platform: "google",
  limit: 10,
});
const api = await client.describe(matches.results[0]!.slug);
console.log(api.pricing.from, api.pricing.failoverMaxUsd, api.inputSchema);

catalog 是只分类浏览。 排名查询总是使用 search返回时 results, (中文(简体) ), total,以及 ranking· ; describe 包括计划 发现的价格是嵌入的 美元平价/线性报价,车道匿名,提供商总是 "AnyAPI"网关 拥有验证、路由、车道顺序、故障、定价关系、健康语义和 计费 这个手写发现客户端安全扫描 反应,项目已知的字段, 将计划保留为不透明 JSON, 并忽略安全的添加。 它不重算网关 商业规则。 生成的每SKU方法仍然是单独的OpenAPI驱动表面.

每个目录和搜索结果都带有网关 method, (中文(简体) ), path执行 模式。 巷道携带其公共来源身份,健康时完整健康样本计数 可用。 符合条件的API可以携带 tryMaxItems; 排名搜索带有网关的故障 事实. describe ưμ㼯a latency,或者整个后台窗口 p50/p95/p99 分发或 null 当没有样本时.

倾斜

被涂装的 SKUs 暴露出一个显示器,该显示器可跨页输出项目并跟踪光标 你吗? 打电话 .pages() 以行走整个结果(每个结果都有自己的 costUsd) (中文(简体) ).

// Flatten items across pages, capped at 100 total.
for await (const post of client.reddit.iterSearch(
  { query: "coffee" },
  { maxItems: 100 },
)) {
  console.log(post.title);
}

// Or walk pages to read per-page cost.
for await (const page of client.reddit
  .iterSearch({ query: "coffee" })
  .pages()) {
  console.log(page.costUsd);
}

请求选项( 文本成本保存器)

传出第二个论点来塑造反应. 这些修剪什么回来 但不要改变 价格 :

await client.google.search(
  { query: "coffee" },
  {
    fields: ["title", "link"], // keep only these keys on each item
    maxItems: 5, // cap result rows returned
    summary: true, // structural outline instead of full data
  },
);

按呼号运输超常: timeoutMs, (中文(简体) ), maxRetries, (中文(简体) ), maxInProgressWaitMs,则 AbortSignal 通过 signal。 。 。 .

错误和重复

类HTTP 密码含义
BadRequestError400个输入失败验证
AuthenticationError401 (中文(简体) )缺少或无效的 API 密钥
InsufficientBalanceError402 (韩语)超过每把钥匙的钱包余额或上限
NotFoundError404 (韩语)块或资源不存在
ResultNotFoundError- 说吧unwrap 在空白的查找数据结果上
RateLimitedError429个请求过多( 自动重审)
UpstreamError502 (中文(简体) )上游后端失败
ConnectionError0 个网络故障或运输故障
TimeoutError0 个请求超时( 未重审)

全部扩展 AnyAPIError (与 status 财务报告和审定财务报表 requestId) (中文(简体) ). 复数为429个,一个具体409个 (以下),而且网络故障在发出请求之前就已经证明存在,而且感到焦虑 指数背向荣誉 Retry-After默认 maxRetries 是 2 (最多3次尝试); 设置 客户或每个请求。 超时从不复试. a 期间或之后的连接失败 已计费 POST /v1/run 没有再审,因为电话可能已经发出。 当 发送相位未知, SDK 不重试 。 配置为 new AnyAPI({ timeoutMs, maxRetries })。 。 。 .

等待一个仍在飞行的跑道

和解与你的连接脱节,所以在连接下降后,运行会持续进行. 何时 你重新发出一个电话 谁的 Idempotency-Key 仍在执行中, 网关答案 409 与 code: "idempotency_in_progress" 财务报告和审定财务报表 Retry-After: 30SDK在等待 完全的延迟和 重试,所以获得原跑的重放结果(replayed: true,无第二次收费) 而不是错误.

8s普通后退上限在此不适用;单独实行全程预算. maxInProgressWaitMs (默认) 60000以总时间为上限 run() 可能屏蔽这些 等待,每一次重试。 与剩余预算不符的等待被拒绝 409 被扔,而不是被切入 一个尝试,无论如何会失败。 设定 maxInProgressWaitMs: 0 以表面显示 409 马上处理好.

没有其他 409 重试 : idempotency_conflict (同一个键,有不同的输入)和 idempotency_needs_review 是呼叫方的问题 重试无法解决.

自动重试已计费的网络 run() 需要结构化运行时间证据,以证明 未发送请求正文 :

运行时间自动计费运行的网络重试SDK掌握的证据
带有内置 Undici 的节点 18+ fetch对DNS 和连接代码, 连接相位超时, 或一个 undici socket 报告零字节已写入
1.3.11号舱对ConnectionRefused,而Bun 1.3.11仅在确定来源或代理连接时发出
云花岗工人没有retryable: true 是指瞬时的,不是未交付的;可以在原产地收到完整尸体后出现
德诺没有获取仅显示没有结构化连接代码的 prose
浏览器没有获取一般会暴露不透明 TypeError

在没有严格不交付证据的运行时间,SDK不为一个自动网络重试 已计费 run()HTTP 429 重试不变。 仅在您 应用可以确定不交货.

代理注册

无账户的密钥( 对于自动代理) :

import { agentSignup } from "@getanyapi/sdk";

const { secret, capUsd } = await agentSignup({ label: "my-agent" });
const client = new AnyAPI({ apiKey: secret });

关键船的启动平衡小,每把钥匙的开销上限 授权 OAuth 上的 AnyAPI 钱包, 如 代理自动签名。 。 。 .

文档

完整的 API 参考和目录 : geanyapi.com/docs (英语)。 。 。 .

许可证

麻省理工学院

版本与发布记录

@getanyapi/sdk 共发布 434 个版本,首次发布于 2026/07/06;过去 12 个月发布了 434 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.154.0latest2026/11/16今天
0.153.12026/11/16今天
0.153.02026/11/16今天
0.152.142026/11/16今天
0.152.132026/11/16今天
0.152.122026/11/16今天

关于 @getanyapi/sdk 的常见问题

@getanyapi/sdk 是什么?

AnyAPI的官方打入了TypeScript SDK:任意API,一个钱包,$,没有订阅.

如何安装 @getanyapi/sdk?

在项目目录运行 npm install @getanyapi/sdk,或使用 pnpm add / yarn add / bun add。

@getanyapi/sdk 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@getanyapi/sdk 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@getanyapi/sdk 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=18。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@getanyapi/sdk 可以商用吗?

@getanyapi/sdk 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@getanyapi/sdk 的下载量有多少?

根据 npm 官方下载统计,@getanyapi/sdk 在 2026/10/17 – 2026/11/15 这 30 天内被下载 39,819 次,日均约 1,327 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@getanyapi/sdk 还在维护吗?

最新版本 0.154.0 发布于 2026/11/16(今天);至今共发布 434 个版本,其中过去 12 个月发布了 434 个;首次发布于 2026/07/06。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。