Skip to content

Main content

Canada Mortgage Calculator Source Code

Browse the implementation files for Canada Mortgage Calculator.
tool.ts typescript
import {
	calculateCanadaMortgage,
	type CanadaMortgageResult
} from '../calculation';
import { formatCurrencyAmount } from '../../format/currency/tool';
import { parseFiniteNumber } from '../../parse/number/tool';
import StandardMortgageCalculator from '../StandardMortgageCalculator.svelte';

const money = (value: number) =>
	formatCurrencyAmount(value, 'CAD', 'en-US');

export const formatCanadaMortgage = (
	result: CanadaMortgageResult
): string =>
	`${money(
		result.totalMonthlyPayment
	)} estimated monthly housing cost\n\n` +
	`Loan payment ${money(result.monthlyLoanPayment)}\n` +
	`Property tax ${money(result.monthlyPropertyTax)}\n` +
	`Insurance ${money(result.monthlyHomeInsurance)}\n` +
	`Condo fees ${money(result.monthlyCondoFees)}\n\n` +
	`Loan amount ${money(result.loanAmount)}\n` +
	`Principal repaid during term ${money(
		result.principalRepaidDuringTerm
	)}\n` +
	`Interest paid during term ${money(
		result.interestPaidDuringTerm
	)}\n` +
	`Balance at renewal ${money(
		result.remainingBalanceAtRenewal
	)}`;

export const canadaMortgageCalculator = (
	homePriceInput: unknown = 600000,
	downPaymentInput: unknown = 120000,
	interestRateInput: unknown = 4.5,
	mortgageTermInput: unknown = 5,
	amortizationInput: unknown = 25,
	annualPropertyTaxInput: unknown = 4800,
	annualInsuranceInput: unknown = 1800,
	condoFeesInput: unknown = 0
): string => {
	const values = [
		homePriceInput,
		downPaymentInput,
		interestRateInput,
		mortgageTermInput,
		amortizationInput,
		annualPropertyTaxInput,
		annualInsuranceInput,
		condoFeesInput
	].map(parseFiniteNumber);
	if (values.some((value) => value === null)) return '';

	const result = calculateCanadaMortgage({
		annualHomeInsurance: values[6] as number,
		annualInterestRate: values[2] as number,
		annualPropertyTax: values[5] as number,
		amortizationYears: values[4] as number,
		condoFees: values[7] as number,
		downPayment: values[1] as number,
		homePrice: values[0] as number,
		mortgageTermYears: values[3] as number
	});

	return result ? formatCanadaMortgage(result) : '';
};

const canadaMortgagePreview = (
	homePrice: unknown = 600000,
	downPayment: unknown = 120000,
	interestRate: unknown = 4.5
) =>
	canadaMortgageCalculator(
		homePrice,
		downPayment,
		interestRate
	);

export const Tool: TypeTool = {
	name: 'Canada Mortgage Calculator',
	slug: 'mortgage-calculator/ca',
	intro:
		'Estimate a Canadian mortgage using a separate mortgage term and amortization period, with semi-annual rate compounding and monthly payments.',
	tool: canadaMortgageCalculator,
	i: [],
	o: [
		{
			label: 'Canadian mortgage estimate',
			placeholder: 'Mortgage estimate',
			render: 'custom',
			renderas: StandardMortgageCalculator,
			type: 'text'
		}
	],
	preview: {
		i: [
			{
				label: 'Home price',
				placeholder: 'Home price in CAD',
				type: 'number',
				value: '600000'
			},
			{
				label: 'Down payment',
				placeholder: 'Down payment in CAD',
				type: 'number',
				value: '120000'
			},
			{
				label: 'Interest rate',
				placeholder: 'Annual interest rate (%)',
				type: 'number',
				value: '4.5'
			}
		],
		o: [
			{
				label: 'Mortgage estimate',
				placeholder: 'Mortgage estimate',
				render: 'textarea',
				type: 'text'
			}
		],
		tool: canadaMortgagePreview
	},
	alternative: [
		{
			title: 'All Mortgage Calculators',
			url: '/mortgage-calculator'
		}
	],
	cite: [
		{
			title:
				'Financial Consumer Agency of Canada: Mortgage terms and amortization',
			url: 'https://www.canada.ca/en/financial-consumer-agency/services/mortgages/mortgage-terms-amortization.html'
		},
		{
			title:
				'Financial Consumer Agency of Canada: Fixed mortgage disclosure example',
			url: 'https://www.canada.ca/en/financial-consumer-agency/services/industry/bulletins/information-box-examples/credit-agreement-fixed-mortgage.html'
		}
	]
};

export default Tool;

Description

Browse the implementation files for Canada Mortgage Calculator.

References

  1. Tool.io on GitHub
  2. Tool.io TypeScript tools library

Similar or alternative tools