Budget & Eligibility

curl --request GET \
  --url https://api.heyhestia.com/partner/budget \
  --header 'Authorization: Bearer <token>'

{
  "budget": 209845,
  "budgetWithNotaryFees": 226633,
  "eligibility": {
    "location": true,
    "budget": true
  }
}

GET

budget

curl --request GET \
  --url https://api.heyhestia.com/partner/budget \
  --header 'Authorization: Bearer <token>'

{
  "budget": 209845,
  "budgetWithNotaryFees": 226633,
  "eligibility": {
    "location": true,
    "budget": true
  }
}

This endpoint is used to simulate :

The budget of the user -> This represents the maximum amount (including agency fees) on which Hestia can help.
The eligibility -> This represents if Hestia can help based on the budget and location.

What is budgetWithNotaryFees?

Check this page to understand the differences between budget and budgetWithNotaryFees

monthlyDebt

number

required

The total loan repayments per month. This field is used to calculate the debt ratio.

monthlyIncome

number

required

The net income per month

savingsAvailable

number

required

The total amount of his assets (real estate, passbooks, current account, liquid investments at 15 months…etc)

postalCode

string

Postal code of purchase project

budget

number

This amount encompasses the total budget where Hestia can guide the buyer, including agency fees.

budgetWithNotaryFees

number

This amount represents the all-inclusive budget covering both agency and notary fees. This is the budget you can compare to banks.
Check our page about differences between budgets.

eligibility

object

The eligibility object

Hide properties

location

boolean

Is the location eligible to Hestia ?

budget

boolean

Is the budget enough to be eligibile to Hestia ?

{
  "budget": 209845,
  "budgetWithNotaryFees": 226633,
  "eligibility": {
    "location": true,
    "budget": true
  }
}