🔌 Вільний API калькулятора

Огляд

API працює з тією ж математикою, яку використовує сайт. Надсилайте значення полів калькулятора з параметрами запиту або JSON і отримайте обчислені результати назад, що і JSON } Включаючи будь- який розклад амортизації або дані діаграми, які створює калькулятор.

• 198+ калькулятори, кожен з яких має свою кінцеву точку
• Немає ключа API — анонімний доступ, обмеження швидкості за допомогою IP
• CORS — Access-Control-Allow-Origin: * (придатний для використання клієнтська сторона)
• Обмеження швидкості: 60 запити/ години на IP (HTTP 429, якщо перевищено)
• Помилки безкоштовні — лише успішне (2xx) відповідь використовує один виклик з вашої місячної квоти. Кожне 400, 401, 404, 429 і 500 - не коштуватиме вам нічого.

Базова адреса URL

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

Індекс ⇩ Показує список кожного калькулятора

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

Повертає придатний для читання комп' ютерний список всіх калькуляторів з полями кожного з них (ключ, label, type, default, unit) і клавіш, які можна прочитати, щоб зібрати клієнтів динамічно. Крім того, кожне поле має обов' язковий прапор } Правильно для декількох полів, які не мають типових (датів, здебільшого). Надсилайте ці поля: пара калькуляторів може використовувати один, решта відповідає 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.

Будь- що, що не може бути вирішене чесно, є помилкою, ніколи не нульовим: помилковим параметром, значенням неправильного типу, невідомим параметром пропускання або відсутнім полем, де немає типового (поля дати } дати } дата народження не можна вгадати). Кожні 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"

• Вільно — анонімний (у обмеженнях на IP) або вільний ключ з малою квотою на місяць. Некомерційною.
• Розробник - $9/mo — 10 000 дзвінків на місяць, комерційне використання.
• Бізнес - $49/ m — 100 000 дзвінків/місяць, першочергова сеть.

Що має значення проти вашої квоти

Це робить лише успішне повідомлення. Один 2xx = один виклик. Кожна помилка вільна: 400 - для неправильного написання параметра, погана вартість або відсутність потрібного поля, 404 - для невідомого слимака, 401 - для поганих ключів, 429 - і все, що може бути несправним. Вирішіть контракт і виправте ваші прохання стільки разів, скільки вам потрібно, і ви не отримаєте відповідей на виправлення.

Оскільки помилки вільні, вони обмежуються частотою замість: якщо одна клавіша викликає більше, ніж 200 Відмовлені відповіді протягом години, програма отримує HTTP 429 "до_ множества_ невиправданих_ запитів" до закінчення години. Успішні виклики ніколи не враховуються до цього, отже робоча інтеграція ніколи не побачить його, він отримує лише клієнта, що застряг у циклі повторення.

Якщо буде використано місячну квоту ключа, API поверне HTTP 429 з помилкою " quota_ exceed "; невідомий або неактивний ключ поверне 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/ індекс.