post https://api-lib.bambu.life/api/generalCalculator/v2/goalCalculator/calcHouseGoalAmount
Calculates prices of houses based on location and house type after adjustment to inflation.
The following table describes the parameters for House cost calculator:
Name | Data Type | Technical Description | Mandatory | Sample Value | List of possible values | No. of decimals | Notes |
---|---|---|---|---|---|---|---|
downPaymentYear | number | The year during which the initial payment was made for buying the house | Y | 2025, 2019, 2020 | > currentYear | 0 | User Input: User selects the year when they would like to make first payment for the house in the Front end. |
country | string | Country where the house is located | Y | Indonesia, Singapore,Malaysia | User input: input selected by the user in the Front End. | ||
region | string | A region in the specific country where the house is located | N | West Java, East Java | User input: input selected by the user in the Front End. | ||
city | string | City in the specific country where the house is located | N | Bandung | User input: input selected by the user in the Front End. | ||
location | string | Location in the specific city where the house is located | N | Ang Mo Kio, Bedok | User input: input selected by the user in the Front End. | ||
district | string | District in the specific city, country where the house is located | N | 16, 20 | User input: input selected by the user in the Front End. | ||
houseType | string | Describes the type of houses | N | Condo, HDB, One Bed, Terraced | User input: input selected by the user in the Front End. | ||
roomType | string | Describes the type of rooms/ number of rooms | N | Executive, Two room, classSix | User input: input selected by the user in the Front End. | ||
downPaymentPct | number | Percentage of down payment | Y | 0.3, 0.2 | 0-1 | 6 | The Downpayment percentage is either user input or hardcoded based on the client's requirements |
inflationRate | number | Inflation Rate | Y | 0.05 | 6 | Based on the long term inflation rate retrieved from the Country service of a specific country or by hardcoding in the Front End based on client requirement. endpoint - /v1/rate/:countryCode, field to use - inflation_rate_long_term | |
currentYear | number | The Year to date | Y | 2019 | 0 | System generated year to date |
The following table describes the outputs for House cost calculator:
Name | Data Type | Technical Description | Sample Value | No. of decimals |
---|---|---|---|---|
yearsToGoal | Number | Number of years it would take to accomplish the goal | 6 | 0 |
housecostInflationAdj | Number | Future adjusted cost of the house calculated as per country's inflation rate | 297781163.32 | 2 |
currency | String | Currency in which the user buys the house | SGD, USD, IDR | |
downPaymentAmt | Number | The initial payment which was made for buying the house | 89334348.99 | 2 |