Authenticatie, invoer en resultaat

Bereken de hypotheek voor een Nederlandse woning

POST https://api.altum.ai/v1/mortgage-calculator

Headers

Naam	Type	Omschrijving
x-api-key*	string	Unieke API sleutel van Altum. Maak er één aan op https://platform.altum.ai
Content-Type	string	application/json

Request Body

Naam	Type	Omschrijving
postcode	string	Zes-cijferige postcode formaat
housenumber	number	Huisnummer van het object
houseaddition	string	Huisnummertoevoeging
gross_annual_income*	number	Bruto jaarinkomen van de hoofdaanvrager (in €)
partner_gross_income	number	Bruto jaarinkomen van de partner (in €). Standaardwaarde is 0
applicant_type	string	"single" of "couple". Beïnvloedt de €17.000 bonus voor alleenstaanden. Standaardwaarde is "single"
existing_debts	number	Maandelijkse bestaande schulden (in €). Verlagen het leenbedrag. Standaardwaarde is 0
student_loan	number	Maandelijkse studieschuld (in €). Verlaagt het leenbedrag. Standaardwaarde is 0
interest_rate*	number	Jaarlijkse rente als percentage (bijv. invoer 3,5 voor 3,5%)
mortgage_type*	string	"annuïteiten" of "lineaire" hypotheek.
loan_term_years*	number	Looptijd van de lening in jaren. Maximum is 30.
purchase_price	number	Aankoopprijs (in €). Wordt gebruikt als marktwaarde als er geen WOZ-waarde kan worden gevonden. Verplicht als er geen adres wordt meegegeven.
down_payment	number	Eigen middelen om de lening te verlagen (in €). Standaardwaarde is 0
fixed_rate_period	number	Aantal jaren dat de rente vaststaat.
nhg_eligible	boolean	NHG van toepassing of niet? Indien niet opgegeven, wordt dit automatisch bepaald: ''true'' bij een aankoopprijs ≤ €470.000
first_time_buyer	boolean	''True'' als de hoofdaanvrager een starter is. Beïnvloedt de overdrachtsbelasting. Standaardwaarde is ''false''
applicant_age	number	Leeftijd van de hoofdaanvrager. Verplicht voor vrijstelling van overdrachtsbelasting voor starters.

200: OK Succesvol response

{
	"postcode": "1234AB",
	"housenumber": "5",
	"houseaddition": null,
	"max_mortgage_amount": "180000.0",
	"max_mortgage_by_income": "197000.0",
	"principal": "180000.0",
	"monthly_payment_gross": "828.51",
	"monthly_payment_net": "620.05",
	"total_interest_paid": "118263.37",
	"total_costs": "304063.37",
	"transfer_tax": "3600.0",
	"transfer_tax_rate_used": "0.02",
	"affordability_ratio": "0.2486",
	"nhg_compliance": "True",
	"rate_used": "3.7",
	"loan_term_years": "30",
	"mortgage_type": "annuity",
	"single_bonus_applied": "17000.0",
	"debt_deduction_applied": "0.0",
	"data_enrichment_status": "fallback",
	"enrichment_data": {
		"found": "False",
		"woz_latest": null,
		"woz_latest_year": null
	},
	"warnings": [
		"Income allows a higher mortgage, but you are capped at the NHG limit of €450,000."
	],
	"metadata": {
		"nhg_price_limit": "470000",
		"nhg_cap": "450000",
		"income_multiplier": "4.5",
		"mortgage_interest_deduction_rate": "0.3756",
		"notary_cost": "1500",
		"appraisal_cost": "700",
		"market_value_source": "purchase_price",
		"market_value_used": "180000.0",
		"market_value_note": "purchase_price used — no WOZ found",
		"evaluation_date": "20260331"
	}
}

400: Bad Request

{
  "error": "Unable to process mortgage calculation at this time."
}

401: Unauthorized

{
  "output": "Please use https://api.altum.ai or visit https://mopsus.altum.ai to make your request."
}

403: Forbidden

{
  "message": "Forbidden"
}

500: Internal Server Error Service is not available and/or down

{
  "message": "Internal server error"
}

422: Unprocessable Entity

{
  "detail": [
    {
      "type": "value_error",
      "msg": "applicant_type must be \"single\" or \"couple\"."
    }
  ]
}

Request body

Voorbeeld verzoek

{
  "postcode": "9636AA",
  "housenumber": 5,
  "gross_annual_income": 65000,
  "interest_rate": 3.5,
  "mortgage_type": "annuity",
  "loan_term_years": 30
}