Public Tools

Simulate a rent revision (server-resolved IRL values)

Stricter variant of POST /public/tools/irl/simulate: the caller provides only the rent, the two quarter labels and the region; the server resolves the trusted INSEE IRL values (no typo risk).

Public, unauthenticated tool.

Example

curl -X POST https://api.faireplace.com/api/public/tools/irl/simulate-by-quarters \
  -H "Content-Type: application/json" \
  -d '{
    "current_rent": 850.00,
    "old_irl_quarter": "T2-2023",
    "new_irl_quarter": "T2-2024",
    "effective_date": "2024-07-01",
    "region": "metropole"
  }'
post/public/tools/irl/simulate-by-quarters

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/public/tools/irl/simulate-by-quarters
  • Auth: none required

Request body

current_rentnumber required
old_irl_quarterstring required
new_irl_quarterstring required
effective_datestring date required
region'metropole' | 'corse' | 'outre_mer'

Regional variant. Default metropole.

Example request

{
  "current_rent": 850,
  "old_irl_quarter": "T2-2023",
  "new_irl_quarter": "T2-2024",
  "effective_date": "2024-07-01",
  "region": "metropole"
}

Response

Rent revision computed.

previous_rentnumber required
new_rentnumber required
old_irl_quarterstring required
old_irl_valuenumber required
new_irl_quarterstring required
new_irl_valuenumber required
variation_percentagenumber required
effective_datestring date required
monthly_increasenumber required
annual_increasenumber required

12 × monthly increase, rounded to 2 decimals.

Example response

{
  "previous_rent": 850,
  "new_rent": 894.85,
  "old_irl_quarter": "T2-2023",
  "old_irl_value": 136.27,
  "new_irl_quarter": "T2-2024",
  "new_irl_value": 143.46,
  "variation_percentage": 5.27,
  "effective_date": "2024-07-01",
  "monthly_increase": 44.85,
  "annual_increase": 538.2
}

Changes

No recorded changes to this operation across all 1 revision of this API.