@ 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 密码 | 含义 |
|---|---|---|
BadRequestError | 400个 | 输入失败验证 |
AuthenticationError | 401 (中文(简体) ) | 缺少或无效的 API 密钥 |
InsufficientBalanceError | 402 (韩语) | 超过每把钥匙的钱包余额或上限 |
NotFoundError | 404 (韩语) | 块或资源不存在 |
ResultNotFoundError | - 说吧 | unwrap 在空白的查找数据结果上 |
RateLimitedError | 429个 | 请求过多( 自动重审) |
UpstreamError | 502 (中文(简体) ) | 上游后端失败 |
ConnectionError | 0 个 | 网络故障或运输故障 |
TimeoutError | 0 个 | 请求超时( 未重审) |
全部扩展 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 (英语)。 。 。 .
许可证
麻省理工学院