🔌 Свободный калькулятор API

Общий обзор

API работает по точно такой же математике, как и на сайте. Отправьте данные калькулятора в качестве параметров запроса или JSON и получите вычисленные результаты в качестве JSON, включая любой график амортизации или данные карты, которые генерирует калькулятор.

• 198+ калькуляторы, каждый с собственной конечной точкой
• Нет ключа API — анонимный доступ, ограниченная по ставкам IP
• CORS — Access-Control-Allow-Origin: * (Полезная сторона клиента)
• Предельный показатель: 60 Количество запросов/час на КП (превышение ПЗВП 429)
• Ошибки свободны — Только успешный ответ (2хх) использует один звонок из вашей месячной квоты.

Базовый 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": [ ... ]
}

The /api/v1/ Индекс публикует ключ, тип, единицу, по умолчанию и требует ли он того, чтобы создать клиента, который никогда не догадается.

Аутентификация и планы

Вы можете позвонить в API без ключа вообще — анонимные запросы ограничены по ставкам 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"

• Свободный — anonymous (IP rate-limited) or a free key with a small monthly quota. Non-commercial.
• Разработчик & mdash; 9 долл. США/мо — 10 000 звонков в месяц, коммерческое использование.
• Бизнес & mdash; 49 долл. США/мо — 100 000 звонков в месяц, приоритетная пропускная способность.

Что имеет значение по твоей квоте

Только успешный ответ. Один 2хх = один звонок. Каждая ошибка свободна: 400 за неправильно выбранный параметр, плохое значение или отсутствующее требуемое поле, 404 за неизвестный пулю, 401 за плохой ключ, 429 и все, что пойдёт не так с нашей стороны. Изучайте контракт и исправьте вашу просьбу столько раз, сколько вам потребуется — вы должны отвечать, а не вносить исправления.

Потому что ошибки свободны, они ограничены по ставкам: если один ключ провоцирует больше, чем 200 Отклоненные ответы за час, HTTP 429 получает «слишком много недействительных_просьбы» до тех пор, пока час не перевернется. Успешные звонки никогда не рассчитываются на это, так что рабочая интеграция никогда не увидит его — он поймает только клиента, застрявшего в цикле ретрити.

Когда используется месячная квота ключа, API возвращает HTTP 429 с ошибкой " " `reed " ; неизвестный или неактивный ключ возвращает 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/ указатель.