Rent Regulation & Rent Control

Country references, rent regulation checks, and rent control compliance

Check rent regulation by postal code

POST

https://api.faireplace.com/api

/legislative-zones/rent-regulation/check

Check whether a postal code falls within a regulated rent area (zone tendue). Returns regulation type, applicable rules, geographical zone, and IRL index information.

Check rent regulation by postal code › Request Body

RentRegulationCheckRequest

postal_code

string · required

Check rent regulation by postal code › Responses

RentRegulationCheckResponse

postal_code

string

city_name

string

is_rent_regulated

boolean

insee_code

string

RegulationTypeResponse

RegulationDetail[]

GeographicalZoneResponse

IrlInfoResponse

POST/legislative-zones/rent-regulation/check

curl https://api.faireplace.com/api/legislative-zones/rent-regulation/check \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "postal_code": "postal_code"
}'

Example Request Body

{
  "postal_code": "postal_code"
}

json

Example Responses

{
  "postal_code": "postal_code",
  "city_name": "city_name",
  "is_rent_regulated": true,
  "insee_code": "insee_code",
  "regulation_type": {
    "type_name": "type_name",
    "description": "description",
    "rules": [
      "string"
    ]
  },
  "regulations": [
    {
      "name": "name",
      "description": "description",
      "is_applicable": true
    }
  ],
  "geographical_zone": {
    "zone_type": "zone_type",
    "irl_cap_percentage": 0,
    "description": "description",
    "postal_code_pattern": "postal_code_pattern"
  },
  "irl_info": {
    "current_quarter": "current_quarter",
    "current_value": 0,
    "previous_year_value": 0,
    "publication_date": "publication_date",
    "data_source": "data_source",
    "last_update": "last_update",
    "annual_increase_cap": 0
  }
}

json

application/json

Get rent regulation data by INSEE code

GET

https://api.faireplace.com/api

/legislative-zones/rent-regulation/zone/{insee_code}

Retrieve rent regulation details for a specific commune identified by its INSEE code.

Get rent regulation data by INSEE code › path Parameters

insee_code

string · required

Get rent regulation data by INSEE code › Responses

200

RentRegulationCheckResponse

postal_code

string

city_name

string

is_rent_regulated

boolean

insee_code

string

RegulationTypeResponse

RegulationDetail[]

GeographicalZoneResponse

IrlInfoResponse

GET/legislative-zones/rent-regulation/zone/{insee_code}

curl https://api.faireplace.com/api/legislative-zones/rent-regulation/zone/:insee_code \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "postal_code": "postal_code",
  "city_name": "city_name",
  "is_rent_regulated": true,
  "insee_code": "insee_code",
  "regulation_type": {
    "type_name": "type_name",
    "description": "description",
    "rules": [
      "string"
    ]
  },
  "regulations": [
    {
      "name": "name",
      "description": "description",
      "is_applicable": true
    }
  ],
  "geographical_zone": {
    "zone_type": "zone_type",
    "irl_cap_percentage": 0,
    "description": "description",
    "postal_code_pattern": "postal_code_pattern"
  },
  "irl_info": {
    "current_quarter": "current_quarter",
    "current_value": 0,
    "previous_year_value": 0,
    "publication_date": "publication_date",
    "data_source": "data_source",
    "last_update": "last_update",
    "annual_increase_cap": 0
  }
}

json

application/json

Check rent control compliance

POST

https://api.faireplace.com/api

/legislative-zones/rent-control/check

Verify whether a proposed rent complies with local rent control rules (encadrement des loyers). Compares the proposed rent against reference rents for the address, room count, construction period, and furnishing status.

Check rent control compliance › Request Body

RentControlRequest

address

string · required

postal_code

string · required

room_count

integer · required

surface_area

number · float · required

construction_period

ConstructionPeriod · enum · required

Enum values:

before_1946

1946_1970

1971_1990

1991_2005

after_2005

after_1990

is_furnished

boolean · required

proposed_rent

number · float · required

Check rent control compliance › Responses

RentControlResponse

territory

string

address

string

administrative_quarter

string

quarter_id

integer | null

Coordinates

ReferenceRentData

proposed_rent_per_sqm

number · float

is_compliant

boolean

compliance_status

string

RegulationRule[]

data_source

string

last_update

string

POST/legislative-zones/rent-control/check

curl https://api.faireplace.com/api/legislative-zones/rent-control/check \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "address": "address",
  "postal_code": "postal_code",
  "room_count": 0,
  "surface_area": 0,
  "construction_period": "before_1946",
  "is_furnished": true,
  "proposed_rent": 0
}'

Example Request Body

{
  "address": "address",
  "postal_code": "postal_code",
  "room_count": 0,
  "surface_area": 0,
  "construction_period": "before_1946",
  "is_furnished": true,
  "proposed_rent": 0
}

json

Example Responses

{
  "territory": "territory",
  "address": "address",
  "administrative_quarter": "administrative_quarter",
  "quarter_id": 0,
  "coordinates": {
    "longitude": 0,
    "latitude": 0
  },
  "reference_rent_data": {
    "reference_rent": 0,
    "reference_rent_increased": 0,
    "reference_rent_decreased": 0,
    "year": "year"
  },
  "proposed_rent_per_sqm": 0,
  "is_compliant": true,
  "compliance_status": "compliance_status",
  "applicable_regulations": [
    {
      "name": "name",
      "description": "description",
      "reference_url": "reference_url"
    }
  ],
  "data_source": "data_source",
  "last_update": "last_update"
}

json

application/json

Get administrative quarter from address

GET

https://api.faireplace.com/api

/legislative-zones/rent-control/quarter

Resolve an address and postal code to an administrative quarter used for rent control reference data.

Get administrative quarter from address › query Parameters

address

string · required

postal_code

string · required

Get administrative quarter from address › Responses

200

AdministrativeQuarter

id

integer

name

string

Coordinates

Get reference rent for a quarter and parameters

GET

https://api.faireplace.com/api

/legislative-zones/rent-control/reference-rent

Retrieve reference rent values (loyer de référence, majoré, minoré) for a specific quarter, room count, construction period, furnishing status, and year.

Get reference rent for a quarter and parameters › query Parameters

quarter

string · required

room_count

integer · required

construction_period

ConstructionPeriod · enum · required

Enum values:

before_1946

1946_1970

1971_1990

1991_2005

after_2005

after_1990

is_furnished

boolean · required

year

string · required

Get reference rent for a quarter and parameters › Responses

200

ReferenceRentData

reference_rent

number · float

reference_rent_increased

number · float

reference_rent_decreased

number · float

year

string

List supported territories for rent control

GET

https://api.faireplace.com/api

/legislative-zones/rent-control/territories

List all territories (cities/communes) that have rent control data available.

List supported territories for rent control › Responses

200

SupportedTerritories

territories

string[]

List rent indices

GET

https://api.faireplace.com/api

/legislative-zones/rent-indices

Retrieves the catalog of rent indices (IRL, ILC, ILAT, ...). Optionally filter by code.

Requires the LeasesRead permission.

Usage Example

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

List rent indices › query Parameters

code

string

Filter indices by code (e.g. IRL).

List rent indices › Responses

Rent indices retrieved successfully

RentIndex[]

A rent index definition (e.g. IRL — Indice de Référence des Loyers). Indices are referenced by rent revisions; their periodic values are stored separately (see `RentIndexValue`).

RentIndex

id

string · uuid · required

Unique index identifier.

Example: 550e8400-e29b-41d4-a716-446655440000

code

string · required

Index code (e.g. IRL, ILC, ILAT). 1-20 characters.

Example: IRL

name

string · required

Human-readable index name. 1-255 characters.

Example: Indice de Référence des Loyers

created_at

string · date-time · required

Creation timestamp (ISO 8601).

Example: 2025-06-15T10:30:00Z

updated_at

string · date-time · required

Last update timestamp (ISO 8601).

Example: 2025-06-15T10:30:00Z

tenant_id

string | null

Tenant (organization) identifier owning this index. Null for global/system indices.

Example: tenant_123

description

string | null

Optional description of the index.

Example: Indice trimestriel publié par l'INSEE pour la révision des loyers.

publication_frequency

string · enum

Publication frequency of the index.

Enum values:

Quarterly

Monthly

Annually

Example: Quarterly

source_organization

string | null

Organization publishing the index (e.g. INSEE).

Example: INSEE

Create a rent index

POST

https://api.faireplace.com/api

/legislative-zones/rent-indices

Creates a new rent index definition.

Requires the LeasesWrite permission.

Usage Example

Code
curl -X POST https://api.faireplace.com/api/legislative-zones/rent-indices \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "code": "IRL",
    "name": "Indice de Référence des Loyers",
    "publication_frequency": "Quarterly",
    "source_organization": "INSEE"
  }'

Create a rent index › Request Body

Request to create a rent index.

CreateRentIndexRequest

code

string · minLength: 1 · maxLength: 20 · required

Index code (e.g. IRL). 1-20 characters.

Example: IRL

name

string · minLength: 1 · maxLength: 255 · required

Index name. 1-255 characters.

Example: Indice de Référence des Loyers

description

string | null

Optional description.

Example: Indice trimestriel publié par l'INSEE.

publication_frequency

string · enum

Publication frequency of the index.

Enum values:

Quarterly

Monthly

Annually

Example: Quarterly

source_organization

string | null

Organization publishing the index.

Example: INSEE

Create a rent index › Responses

Rent index created successfully

A rent index definition (e.g. IRL — Indice de Référence des Loyers). Indices are referenced by rent revisions; their periodic values are stored separately (see `RentIndexValue`).

RentIndex

id

string · uuid · required

Unique index identifier.

Example: 550e8400-e29b-41d4-a716-446655440000

code

string · required

Index code (e.g. IRL, ILC, ILAT). 1-20 characters.

Example: IRL

name

string · required

Human-readable index name. 1-255 characters.

Example: Indice de Référence des Loyers

created_at

string · date-time · required

Creation timestamp (ISO 8601).

Example: 2025-06-15T10:30:00Z

updated_at

string · date-time · required

Last update timestamp (ISO 8601).

Example: 2025-06-15T10:30:00Z

tenant_id

string | null

Tenant (organization) identifier owning this index. Null for global/system indices.

Example: tenant_123

description

string | null

Optional description of the index.

Example: Indice trimestriel publié par l'INSEE pour la révision des loyers.

publication_frequency

string · enum

Publication frequency of the index.

Enum values:

Quarterly

Monthly

Annually

Example: Quarterly

source_organization

string | null

Organization publishing the index (e.g. INSEE).

Example: INSEE

POST/legislative-zones/rent-indices

curl https://api.faireplace.com/api/legislative-zones/rent-indices \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "code": "IRL",
  "name": "Indice de Référence des Loyers",
  "publication_frequency": "Quarterly",
  "source_organization": "INSEE"
}'

Example Request Body

{
  "code": "IRL",
  "name": "Indice de Référence des Loyers",
  "publication_frequency": "Quarterly",
  "source_organization": "INSEE"
}

json

application/json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tenant_id": "tenant_123",
  "code": "IRL",
  "name": "Indice de Référence des Loyers",
  "description": "Indice trimestriel publié par l'INSEE pour la révision des loyers.",
  "publication_frequency": "Quarterly",
  "source_organization": "INSEE",
  "created_at": "2025-06-15T10:30:00Z",
  "updated_at": "2025-06-15T10:30:00Z"
}

json

application/json

Get latest rent index value

GET

https://api.faireplace.com/api

/legislative-zones/rent-indices/latest

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

Requires the LeasesRead permission.

Usage Example

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

Get latest rent index value › query Parameters

code

string

Index code to look up (defaults to IRL).

Default: IRL

Get latest rent index value › Responses

Latest rent index value retrieved successfully

A periodic value of a rent index for a given reference period.

RentIndexValue

id

string · uuid · required

Unique index value identifier.

Example: 550e8400-e29b-41d4-a716-446655440010

index_id

string · uuid · required

Parent rent index identifier.

Example: 550e8400-e29b-41d4-a716-446655440000

reference_period

string · required

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

Example: T3-2024

value_date

string · date · required

Date the value applies to (ISO 8601).

Example: 2024-07-01

publication_date

string · date · required

Date the value was officially published (ISO 8601).

Example: 2024-10-15

base_year

integer · int32 · required

Base year (100) for the index.

Example: 2015

index_value

number · double · required

Official index value.

Example: 144.81

created_at

string · date-time · required

Creation timestamp (ISO 8601).

Example: 2024-10-15T09:00:00Z

updated_at

string · date-time · required

Last update timestamp (ISO 8601).

Example: 2024-10-15T09:00:00Z

tenant_id

string | null

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

Example: tenant_123

previous_value

number | null · double

Value of the previous reference period, if known.

Example: 143.46

percentage_change

number | null · double

Year-over-year percentage change, if known.

Example: 3.26

official_source_url

string | null · uri

URL of the official publication source.

Example: https://www.insee.fr/fr/statistiques/serie/001515333

Get a rent index

GET

https://api.faireplace.com/api

/legislative-zones/rent-indices/{index_id}

Retrieves a single rent index by its identifier.

Requires the LeasesRead permission.

Get a rent index › path Parameters

index_id

string · uuid · required

Rent index ID

Get a rent index › Responses

Rent index retrieved successfully

A rent index definition (e.g. IRL — Indice de Référence des Loyers). Indices are referenced by rent revisions; their periodic values are stored separately (see `RentIndexValue`).

RentIndex

id

string · uuid · required

Unique index identifier.

Example: 550e8400-e29b-41d4-a716-446655440000

code

string · required

Index code (e.g. IRL, ILC, ILAT). 1-20 characters.

Example: IRL

name

string · required

Human-readable index name. 1-255 characters.

Example: Indice de Référence des Loyers

created_at

string · date-time · required

Creation timestamp (ISO 8601).

Example: 2025-06-15T10:30:00Z

updated_at

string · date-time · required

Last update timestamp (ISO 8601).

Example: 2025-06-15T10:30:00Z

tenant_id

string | null

Tenant (organization) identifier owning this index. Null for global/system indices.

Example: tenant_123

description

string | null

Optional description of the index.

Example: Indice trimestriel publié par l'INSEE pour la révision des loyers.

publication_frequency

string · enum

Publication frequency of the index.

Enum values:

Quarterly

Monthly

Annually

Example: Quarterly

source_organization

string | null

Organization publishing the index (e.g. INSEE).

Example: INSEE

Update a rent index

PUT

https://api.faireplace.com/api

/legislative-zones/rent-indices/{index_id}

Updates a rent index. All fields are optional; only provided fields are updated.

Requires the LeasesWrite permission.

Update a rent index › path Parameters

index_id

string · uuid · required

Rent index ID

Update a rent index › Request Body

Request to update a rent index. All fields are optional; only provided fields are updated.

UpdateRentIndexRequest

code

string | null

Index code (e.g. IRL).

Example: IRL

name

string | null

Index name.

Example: Indice de Référence des Loyers

description

string | null

Optional description.

Example: Indice trimestriel publié par l'INSEE.

publication_frequency

string · enum

Publication frequency of the index.

Enum values:

Quarterly

Monthly

Annually

Example: Quarterly

source_organization

string | null

Organization publishing the index.

Example: INSEE

Update a rent index › Responses

Rent index updated successfully

A rent index definition (e.g. IRL — Indice de Référence des Loyers). Indices are referenced by rent revisions; their periodic values are stored separately (see `RentIndexValue`).

RentIndex

id

string · uuid · required

Unique index identifier.

Example: 550e8400-e29b-41d4-a716-446655440000

code

string · required

Index code (e.g. IRL, ILC, ILAT). 1-20 characters.

Example: IRL

name

string · required

Human-readable index name. 1-255 characters.

Example: Indice de Référence des Loyers

created_at

string · date-time · required

Creation timestamp (ISO 8601).

Example: 2025-06-15T10:30:00Z

updated_at

string · date-time · required

Last update timestamp (ISO 8601).

Example: 2025-06-15T10:30:00Z

tenant_id

string | null

Tenant (organization) identifier owning this index. Null for global/system indices.

Example: tenant_123

description

string | null

Optional description of the index.

Example: Indice trimestriel publié par l'INSEE pour la révision des loyers.

publication_frequency

string · enum

Publication frequency of the index.

Enum values:

Quarterly

Monthly

Annually

Example: Quarterly

source_organization

string | null

Organization publishing the index (e.g. INSEE).

Example: INSEE

PUT/legislative-zones/rent-indices/{index_id}

curl https://api.faireplace.com/api/legislative-zones/rent-indices/:index_id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "Indice de Référence des Loyers (IRL)",
  "source_organization": "INSEE"
}'

Example Request Body

{
  "name": "Indice de Référence des Loyers (IRL)",
  "source_organization": "INSEE"
}

json

application/json

Example Responses

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "tenant_id": "tenant_123",
  "code": "IRL",
  "name": "Indice de Référence des Loyers",
  "description": "Indice trimestriel publié par l'INSEE pour la révision des loyers.",
  "publication_frequency": "Quarterly",
  "source_organization": "INSEE",
  "created_at": "2025-06-15T10:30:00Z",
  "updated_at": "2025-06-15T10:30:00Z"
}

json

application/json

Delete a rent index

DELETE

https://api.faireplace.com/api

/legislative-zones/rent-indices/{index_id}

Deletes a rent index by its identifier.

Requires the LeasesWrite permission.

Delete a rent index › path Parameters

index_id

string · uuid · required

Rent index ID

Delete a rent index › Responses

Rent index deleted successfully

No data returned

List rent index values

GET

https://api.faireplace.com/api

/legislative-zones/rent-indices/{index_id}/values

Retrieves the periodic values of a rent index. Optionally filter by year.

Requires the LeasesRead permission.

Usage Example

Code
curl -X GET "https://api.faireplace.com/api/legislative-zones/rent-indices/550e8400-e29b-41d4-a716-446655440000/values?year=2024" \
  -H "Authorization: Bearer YOUR_API_KEY"

List rent index values › path Parameters

index_id

string · uuid · required

Parent rent index ID

List rent index values › query Parameters

year

integer · int32

Filter values by year.

List rent index values › Responses

Rent index values retrieved successfully

RentIndexValue[]

A periodic value of a rent index for a given reference period.

RentIndexValue

id

string · uuid · required

Unique index value identifier.

Example: 550e8400-e29b-41d4-a716-446655440010

index_id

string · uuid · required

Parent rent index identifier.

Example: 550e8400-e29b-41d4-a716-446655440000

reference_period

string · required

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

Example: T3-2024

value_date

string · date · required

Date the value applies to (ISO 8601).

Example: 2024-07-01

publication_date

string · date · required

Date the value was officially published (ISO 8601).

Example: 2024-10-15

base_year

integer · int32 · required

Base year (100) for the index.

Example: 2015

index_value

number · double · required

Official index value.

Example: 144.81

created_at

string · date-time · required

Creation timestamp (ISO 8601).

Example: 2024-10-15T09:00:00Z

updated_at

string · date-time · required

Last update timestamp (ISO 8601).

Example: 2024-10-15T09:00:00Z

tenant_id

string | null

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

Example: tenant_123

previous_value

number | null · double

Value of the previous reference period, if known.

Example: 143.46

percentage_change

number | null · double

Year-over-year percentage change, if known.

Example: 3.26

official_source_url

string | null · uri

URL of the official publication source.

Example: https://www.insee.fr/fr/statistiques/serie/001515333

GET/legislative-zones/rent-indices/{index_id}/values

curl https://api.faireplace.com/api/legislative-zones/rent-indices/:index_id/values \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "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"
  }
]

json

application/json

Create a rent index value

POST

https://api.faireplace.com/api

/legislative-zones/rent-indices/{index_id}/values

Creates a new periodic value for a rent index. The index_id in the path takes precedence over the one in the request body.

Requires the LeasesWrite permission.

Usage Example

Code
curl -X POST https://api.faireplace.com/api/legislative-zones/rent-indices/550e8400-e29b-41d4-a716-446655440000/values \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "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
  }'

Create a rent index value › path Parameters

index_id

string · uuid · required

Parent rent index ID

Create a rent index value › Request Body

Request to create a rent index value. The `index_id` from the URL path overrides the `index_id` field if both are provided.

CreateRentIndexValueRequest

index_id

string · uuid · required

Parent rent index identifier (overridden by the path parameter).

Example: 550e8400-e29b-41d4-a716-446655440000

reference_period

string · minLength: 1 · maxLength: 50 · required

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

Example: T3-2024

value_date

string · date · required

Date the value applies to (ISO 8601).

Example: 2024-07-01

publication_date

string · date · required

Date the value was officially published (ISO 8601).

Example: 2024-10-15

base_year

integer · int32 · required

Base year (100) for the index.

Example: 2015

index_value

number · double · required

Official index value.

Example: 144.81

previous_value

number | null · double

Value of the previous reference period.

Example: 143.46

percentage_change

number | null · double

Year-over-year percentage change.

Example: 3.26

official_source_url

string | null · uri

URL of the official publication source.

Example: https://www.insee.fr/fr/statistiques/serie/001515333

Create a rent index value › Responses

Rent index value created successfully

A periodic value of a rent index for a given reference period.

RentIndexValue

id

string · uuid · required

Unique index value identifier.

Example: 550e8400-e29b-41d4-a716-446655440010

index_id

string · uuid · required

Parent rent index identifier.

Example: 550e8400-e29b-41d4-a716-446655440000

reference_period

string · required

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

Example: T3-2024

value_date

string · date · required

Date the value applies to (ISO 8601).

Example: 2024-07-01

publication_date

string · date · required

Date the value was officially published (ISO 8601).

Example: 2024-10-15

base_year

integer · int32 · required

Base year (100) for the index.

Example: 2015

index_value

number · double · required

Official index value.

Example: 144.81

created_at

string · date-time · required

Creation timestamp (ISO 8601).

Example: 2024-10-15T09:00:00Z

updated_at

string · date-time · required

Last update timestamp (ISO 8601).

Example: 2024-10-15T09:00:00Z

tenant_id

string | null

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

Example: tenant_123

previous_value

number | null · double

Value of the previous reference period, if known.

Example: 143.46

percentage_change

number | null · double

Year-over-year percentage change, if known.

Example: 3.26

official_source_url

string | null · uri

URL of the official publication source.

Example: https://www.insee.fr/fr/statistiques/serie/001515333

POST/legislative-zones/rent-indices/{index_id}/values

curl https://api.faireplace.com/api/legislative-zones/rent-indices/:index_id/values \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "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
}'

Example Request Body

{
  "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
}

json

application/json

Example Responses

{
  "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"
}

json

application/json

Media Lease Types