Rent Regulation & Rent Control

Get latest rent index value

Retrieves the most recent value for a rent index. If no code is provided, defaults to the IRL index.

Requires the leases:read permission.

Usage Example

curl -X GET "https://api.faireplace.com/api/legislative-zones/rent-indices/latest?code=IRL" \
  -H "Authorization: Bearer YOUR_API_KEY"
get/legislative-zones/rent-indices/latest

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/legislative-zones/rent-indices/latest
  • Auth: HTTP bearer

Query parameters

codestring

Index code to look up (defaults to IRL).

Response

Latest rent index value retrieved successfully

idstring uuid required

Unique index value identifier.

tenant_idstring nullable

Tenant identifier owning this value. Null for global/system values.

index_idstring uuid required

Parent rent index identifier.

reference_periodstring required

Reference period label (e.g. T3-2024). 1-50 characters.

value_datestring date required

Date the value applies to (ISO 8601).

publication_datestring date required

Date the value was officially published (ISO 8601).

base_yearinteger required

Base year (100) for the index.

index_valuenumber double required

Official index value.

previous_valuenumber double nullable

Value of the previous reference period, if known.

percentage_changenumber double nullable

Year-over-year percentage change, if known.

official_source_urlstring uri nullable

URL of the official publication source.

created_atstring date-time required

Creation timestamp (ISO 8601).

updated_atstring date-time required

Last update timestamp (ISO 8601).

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440010",
  "tenant_id": "tenant_123",
  "index_id": "550e8400-e29b-41d4-a716-446655440000",
  "reference_period": "T3-2024",
  "value_date": "2024-07-01",
  "publication_date": "2024-10-15",
  "base_year": 2015,
  "index_value": 144.81,
  "previous_value": 143.46,
  "percentage_change": 3.26,
  "official_source_url": "https://www.insee.fr/fr/statistiques/serie/001515333",
  "created_at": "2024-10-15T09:00:00Z",
  "updated_at": "2024-10-15T09:00:00Z"
}

Changes

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