🔌 自由计算 APP

概览

API 运行与网站所使用的数学完全相同的计算。 发送计算器的字段值作为查询参数或 JSON, 并将计算结果作为 JSON 重新获取, 包括任何摊还时间表或图表数据, 计算器生成 。

• 198+ 计算器,每个计算器都有自己的终点
• 无 API 密钥 — 匿名接入,按IPIP的费率限制
• CORS — Access-Control-Allow-Origin: * (可用客户端)
• 利率限额: 60 每IP要求/小时/每IP 小时(超过429 HTTP)
• 错误是空空的 — 仅一个成功的响应(2xx)使用每月定额的一通电话。 每400、401、404、429和500个电话都不需要你花什么钱。

基点 URL

https://calculator.free/api/v1/

索引 - 列出每个计算器

GET https://calculator.free/api/v1/

返回每个字段(键、标签、类型、默认、单位)和结果键的所有计算器的机器可读列表,这些计算器足以动态构建客户端。 每个字段还带有要求的旗帜, 少数没有默认值的字段( 大多是日期) 。 发送这些标记: 几个计算器可以推断一个, 其余的则回答400个, 没有它。

计算 - 运行一个计算器

GET  https://calculator.free/api/v1/<slug>/?field=value&field=value
POST https://calculator.free/api/v1/<slug>/     (JSON or form body)

响应形状 :

{
  "ok": true,
  "slug": "mortgage",
  "country": "us",
  "inputs":   { ... the values actually computed with ... },
  "results":  { ... computed result keys ... },
  "schedule": { "columns": [...], "rows": [...] } | null,
  "chart":    { "type": "pie", "slices": [...] } | null,
  "defaults_applied": ["tax", "insurance"]
}

国家-国家-国家计算器(抵押、贷款、所得税、销售税.)接受 ?country=us|uk|ca|au|in|ie|nz|za. 未知的弹片返回 404; 不支持的国家或错误输入返回400, 并附有帮助信息及字段规格 。

参数、默认值和错误

仅发送您关心的字段。 您所漏出的任何字段都填满了该字段公布的默认缺省值 — 与计算器页面预填的值相同, 因此 API 和网站总是对相同的输入返回相同数字。 每个回复都列出它填入的 defaults_applied.

API 无法诚实解决的任何问题都是错误,从不为零:拼错参数、错误类型值、未知的下拉选项、或没有默认缺省字段(日期字段 — — 出生日期无法猜测 ) 。 每400个错误参数都点名并回响整个字段的外观,以便客户能够纠正错误。

$ curl "https://calculator.free/api/v1/mortgage/?price=350000&rate=6.5&term=30"
{
  "ok": false,
  "error": "unknown_parameter",
  "message": "Unknown parameter 'term' for calculator 'mortgage'. Did you mean 'years'? ...",
  "unknown_parameters": ["term"],
  "did_you_mean": { "term": "years" },
  "valid_parameters": ["down", "extra", "extra_onetime", "extra_yearly", "hoa",
                       "insurance", "other", "pmi", "price", "rate", "tax", "years"],
  "fields": [ ... ]
}

下 /api/v1/ 索引公布每个字段的键、类型、单位、默认值以及是否需要它——足以建立一个从未猜到的客户。

验证 & amp; 计划

匿名请求受IP限制。 对于更高的、可预测的月配额(和商业用途),请在您的账户页面上创建密钥,并发送三种方式之一:

GET  https://calculator.free/api/v1/mortgage/?price=350000&key=YOUR_KEY
curl -H "Authorization: Bearer YOUR_KEY" "https://calculator.free/api/v1/bmi/?units=metric&height=180&weight=80"
curl -H "X-Api-Key: YOUR_KEY"           "https://calculator.free/api/v1/bmi/?units=metric&height=180&weight=80"

• 自由 — 匿名(IP费率受限制)或免费钥匙,每月定额较小。
• 开发者 & mdash; 9 美元/ mo — 每月10 000个电话,商业用途。
• 商务 & mdash; 49/ mo — 每月100 000个电话,优先输送。

何为与你的配额相违背

只有一个成功响应。 1 2xx = 一次呼叫。 每个错误都是免费的: 拼错参数为400, 错误值或缺少所需的字段, 未知子弹为404, 错误键为401, 错误键为429, 以及我们这边出现的任何错误。 探索合同并按您需要的多少次修改您的请求- 您被收纳回答, 而不是更正 。

由于错误是自由的,所以错误是不受错误的,而是受费率的限制:如果一个密钥引发的超出 200 一小时后拒绝回复, 就会收到 HTTP 429 “ 太过多_ 无效_ unvalid_ requests ”, 直到时间滚动。 成功的电话从不计其数, 所以工作整合永远不会看到它 — — 它只抓住被困在回溯循环中的客户 。

当键的月配额被使用时, API 返回 HTTP 429 时, 错误为“ 配额超额 ” ; 未知或非活动键返回 HTTP 401 。 看着全全图 注册 定价 页 次 页.

实例

curl

curl "https://calculator.free/api/v1/mortgage/?price=350000&down=70000&rate=6.9&years=30"

JavaScript fetch()

const r = await fetch(
  "https://calculator.free/api/v1/bmi/?" + new URLSearchParams({
    units: "metric", height: "180", weight: "80"
  }));
const { results } = await r.json();
console.log(results.bmi, results.category);

Python

import requests

r = requests.get("https://calculator.free/api/v1/mortgage/",
                 params={"price": 350000, "down": 70000,
                         "rate": 6.9, "years": 30},
                 headers={"Authorization": "Bearer YOUR_KEY"})
print(r.json()["results"])

POST JSON

curl -X POST "https://calculator.free/api/v1/income-tax/?country=uk" \
  -H "Content-Type: application/json" \
  -d '{"income": 60000}'

所有终点

每个计算器一个端点。 字段键和每个计算器的结果键都在 /api/v1/ 指数.