Rent Regulation & Rent Control

Create a rent index

Creates a new rent index definition.

Requires the leases:write permission.

Usage Example

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"
  }'
post/legislative-zones/rent-indices

Request

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

Request body

codestring required

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

namestring required

Index name. 1-255 characters.

descriptionstring nullable

Optional description.

publication_frequency'Quarterly' | 'Monthly' | 'Annually'

Publication frequency of a rent index.

source_organizationstring nullable

Organization publishing the index.

Example request

{
  "code": "IRL",
  "name": "Indice de Référence des Loyers",
  "description": "Indice trimestriel publié par l'INSEE.",
  "publication_frequency": "Quarterly",
  "source_organization": "INSEE"
}

Response

Rent index created successfully

idstring uuid required

Unique index identifier.

tenant_idstring nullable

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

codestring required

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

namestring required

Human-readable index name. 1-255 characters.

descriptionstring nullable

Optional description of the index.

publication_frequency'Quarterly' | 'Monthly' | 'Annually'

Publication frequency of a rent index.

source_organizationstring nullable

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

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

Changes

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