---
title: "Mortgage Calculator"
method: POST
path: "/api/v1/tools/mortgage-calculator"
tags: ["tools"]
---

# Mortgage Calculator

`POST /api/v1/tools/mortgage-calculator`

## Request

- Base URL: `https://toolforte.com`
- URL: `https://toolforte.com/api/v1/tools/mortgage-calculator`
- Auth: HTTP bearer

Work out the payment on a home loan from the price, the deposit, the rate and the term, paid monthly, bi-weekly or weekly. Returns the payment per period, the total paid, the total interest, the loan-to-value ratio and an amortisation schedule of up to 360 periods showing how each payment splits between principal and interest.

## Request body

- object
  - `homePrice` integer
  - `downPayment` integer
  - `annualRatePercent` number
  - `termYears` integer
  - `paymentFrequency` string

## Response `200`

Successful result

- object
  - `ok` boolean
  - `data` object
    - `homePrice` integer
    - `downPayment` integer
    - `loanAmount` integer
    - `annualRatePercent` number
    - `termYears` integer
    - `frequency` string
    - `periodsPerYear` integer
    - `totalPeriods` integer
    - `periodicPayment` number
    - `totalPayment` number
    - `totalInterest` number
    - `loanToValuePercent` integer
    - `schedule` object[]
      - `period` integer
      - `payment` number
      - `principal` number
      - `interest` integer
      - `balance` number
    - `scheduleTruncated` boolean

## Other responses

- `400`: Missing or invalid request fields
- `401`: Invalid or missing API key
- `429`: Monthly plan limit reached

---

[API](https://skmtc.dev/toolforte/apis/toolforte-api.md) · [All operations](https://skmtc.dev/toolforte/apis/toolforte-api/llms.txt) · [OpenAPI document](https://skmtc.dev/toolforte/apis/toolforte-api/revisions/4d814d484dfc?raw)