> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hestia.fr/llms.txt
> Use this file to discover all available pages before exploring further.

# Budget & Eligibility

> Get a user budget & eligibility to Hestia

This endpoint is used to simulate :

1. The budget of the user -> This represents the **maximum amount** (including agency fees) on which Hestia can help.

2. The eligibility -> This represents if Hestia can help based on the **budget** and **location**.

<Card title="What is budgetWithNotaryFees?" icon="lightbulb" href="/budgetsDifferences">
  Check this page to understand the differences between `budget` and
  `budgetWithNotaryFees`
</Card>

## Parameters

<ParamField query="monthlyDebt" type="number" required>
  The total loan repayments per month. This field is used to calculate the debt
  ratio.
</ParamField>

<ParamField query="monthlyIncome" type="number" required>
  The net income per month
</ParamField>

<ParamField query="savingsAvailable" type="number" required>
  The total amount of his assets (real estate, passbooks, current account,
  liquid investments at 15 months...etc)
</ParamField>

<ParamField query="postalCode" type="string">
  Postal code of purchase project
</ParamField>

## Response

<ResponseField name="budget" type="number">
  This amount encompasses the total budget where Hestia can guide the buyer,
  including agency fees.
</ResponseField>

<ResponseField name="budgetWithNotaryFees" type="number">
  This amount represents the all-inclusive budget covering both agency and
  notary fees. This is the budget you can compare to banks. <br />
  [Check our page about differences between budgets.](/budgetsDifferences)
</ResponseField>

<ResponseField name="eligibility" type="object">
  The eligibility object
</ResponseField>

<Expandable title="properties" defaultOpen>
  <ResponseField name="location" type="boolean">
    Is the location eligible to Hestia ?
  </ResponseField>

  <ResponseField name="budget" type="boolean">
    Is the budget enough to be eligibile to Hestia ?
  </ResponseField>
</Expandable>

<ResponseExample>
  ```json Response theme={null}
  {
    "budget": 209845,
    "budgetWithNotaryFees": 226633,
    "eligibility": {
      "location": true,
      "budget": true
    }
  }
  ```
</ResponseExample>