FairePlace Property Management API

Legislative Zones

Endpointhttps://api.faireplace.com/api

Regulatory zones (rent control, etc.)

List legislative zones

GET

https://api.faireplace.com/api

/legislative-zones

List legislative zones › query Parameters

zone_type

string

country_code

string

code

string

name

string

is_active

boolean

effective_date

string · date

parent_zone_id

string · uuid

List legislative zones › Responses

object[]

id

string | null · uuid

zone_type

string | null

country_code

string | null

code

string | null

name

string | null

name_local

string | null

description

string | null

description_local

string | null

is_active

boolean | null

effective_date

string | null · date

end_date

string | null · date

parent_zone_id

string | null · uuid

created_at

string | null · date-time

updated_at

string | null · date-time

GET/legislative-zones

curl --request GET \
  --url https://api.faireplace.com/api/legislative-zones

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "zone_type": {},
    "country_code": {},
    "code": {},
    "name": {},
    "name_local": {},
    "description": {},
    "description_local": {},
    "is_active": {},
    "effective_date": "2024-08-25",
    "end_date": "2024-08-25",
    "parent_zone_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Create legislative zone

POST

https://api.faireplace.com/api

/legislative-zones

Create legislative zone › Request Body

zone_type

string · required

country_code

string · required

code

string · required

name

string · required

name_local

string | null

description

string | null

description_local

string | null

is_active

boolean

effective_date

string | null · date

end_date

string | null · date

parent_zone_id

string | null · uuid

Create legislative zone › Responses

Created

id

string | null · uuid

zone_type

string | null

country_code

string | null

code

string | null

name

string | null

name_local

string | null

description

string | null

description_local

string | null

is_active

boolean | null

effective_date

string | null · date

end_date

string | null · date

parent_zone_id

string | null · uuid

created_at

string | null · date-time

updated_at

string | null · date-time

POST/legislative-zones

curl --request POST \
  --url https://api.faireplace.com/api/legislative-zones \
  --header 'Content-Type: application/json' \
  --data '
{
  "zone_type": "zone_type",
  "country_code": "country_code",
  "code": "code",
  "name": "name",
  "name_local": {},
  "description": {},
  "description_local": {},
  "is_active": true,
  "effective_date": "2024-08-25",
  "end_date": "2024-08-25",
  "parent_zone_id": "00000000-0000-0000-0000-000000000000"
}
'

shell

Example Request Body

{
  "zone_type": "zone_type",
  "country_code": "country_code",
  "code": "code",
  "name": "name",
  "name_local": {},
  "description": {},
  "description_local": {},
  "is_active": true,
  "effective_date": "2024-08-25",
  "end_date": "2024-08-25",
  "parent_zone_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "zone_type": {},
  "country_code": {},
  "code": {},
  "name": {},
  "name_local": {},
  "description": {},
  "description_local": {},
  "is_active": {},
  "effective_date": "2024-08-25",
  "end_date": "2024-08-25",
  "parent_zone_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Search legislative zones

POST

https://api.faireplace.com/api

/legislative-zones/search

Search legislative zones › Request Body optional

zone_type

string | null

country_code

string | null

code

string | null

name

string | null

is_active

boolean | null

effective_date

string | null · date

parent_zone_id

string | null · uuid

Search legislative zones › Responses

200

object[]

id

string | null · uuid

zone_type

string | null

country_code

string | null

code

string | null

name

string | null

name_local

string | null

description

string | null

description_local

string | null

is_active

boolean | null

effective_date

string | null · date

end_date

string | null · date

parent_zone_id

string | null · uuid

created_at

string | null · date-time

updated_at

string | null · date-time

POST/legislative-zones/search

curl --request POST \
  --url https://api.faireplace.com/api/legislative-zones/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "zone_type": {},
  "country_code": {},
  "code": {},
  "name": {},
  "is_active": {},
  "effective_date": "2024-08-25",
  "parent_zone_id": "00000000-0000-0000-0000-000000000000"
}
'

shell

Example Request Body

{
  "zone_type": {},
  "country_code": {},
  "code": {},
  "name": {},
  "is_active": {},
  "effective_date": "2024-08-25",
  "parent_zone_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "zone_type": {},
    "country_code": {},
    "code": {},
    "name": {},
    "name_local": {},
    "description": {},
    "description_local": {},
    "is_active": {},
    "effective_date": "2024-08-25",
    "end_date": "2024-08-25",
    "parent_zone_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Get legislative zone

GET

https://api.faireplace.com/api

/legislative-zones/{id}

Get legislative zone › path Parameters

id

string · uuid · required

Get legislative zone › Responses

id

string | null · uuid

zone_type

string | null

country_code

string | null

code

string | null

name

string | null

name_local

string | null

description

string | null

description_local

string | null

is_active

boolean | null

effective_date

string | null · date

end_date

string | null · date

parent_zone_id

string | null · uuid

created_at

string | null · date-time

updated_at

string | null · date-time

GET/legislative-zones/{id}

curl --request GET \
  --url https://api.faireplace.com/api/legislative-zones/:id

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "zone_type": {},
  "country_code": {},
  "code": {},
  "name": {},
  "name_local": {},
  "description": {},
  "description_local": {},
  "is_active": {},
  "effective_date": "2024-08-25",
  "end_date": "2024-08-25",
  "parent_zone_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Update legislative zone

PUT

https://api.faireplace.com/api

/legislative-zones/{id}

Update legislative zone › path Parameters

id

string · uuid · required

Update legislative zone › Request Body

name

string

name_local

string | null

description

string | null

description_local

string | null

is_active

boolean

effective_date

string | null · date

end_date

string | null · date

parent_zone_id

string | null · uuid

Update legislative zone › Responses

id

string | null · uuid

zone_type

string | null

country_code

string | null

code

string | null

name

string | null

name_local

string | null

description

string | null

description_local

string | null

is_active

boolean | null

effective_date

string | null · date

end_date

string | null · date

parent_zone_id

string | null · uuid

created_at

string | null · date-time

updated_at

string | null · date-time

PUT/legislative-zones/{id}

curl --request PUT \
  --url https://api.faireplace.com/api/legislative-zones/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "name_local": {},
  "description": {},
  "description_local": {},
  "is_active": true,
  "effective_date": "2024-08-25",
  "end_date": "2024-08-25",
  "parent_zone_id": "00000000-0000-0000-0000-000000000000"
}
'

shell

Example Request Body

{
  "name": "name",
  "name_local": {},
  "description": {},
  "description_local": {},
  "is_active": true,
  "effective_date": "2024-08-25",
  "end_date": "2024-08-25",
  "parent_zone_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "zone_type": {},
  "country_code": {},
  "code": {},
  "name": {},
  "name_local": {},
  "description": {},
  "description_local": {},
  "is_active": {},
  "effective_date": "2024-08-25",
  "end_date": "2024-08-25",
  "parent_zone_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Delete legislative zone

DELETE

https://api.faireplace.com/api

/legislative-zones/{id}

Delete legislative zone › path Parameters

id

string · uuid · required

Delete legislative zone › Responses

No Content

No data returned

DELETE/legislative-zones/{id}

curl --request DELETE \
  --url https://api.faireplace.com/api/legislative-zones/:id

shell

Example Responses

No example specified for this content type

List child zones

GET

https://api.faireplace.com/api

/legislative-zones/{id}/children

List child zones › path Parameters

id

string · uuid · required

List child zones › Responses

object[]

id

string | null · uuid

zone_type

string | null

country_code

string | null

code

string | null

name

string | null

name_local

string | null

description

string | null

description_local

string | null

is_active

boolean | null

effective_date

string | null · date

end_date

string | null · date

parent_zone_id

string | null · uuid

created_at

string | null · date-time

updated_at

string | null · date-time

GET/legislative-zones/{id}/children

curl --request GET \
  --url https://api.faireplace.com/api/legislative-zones/:id/children

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "zone_type": {},
    "country_code": {},
    "code": {},
    "name": {},
    "name_local": {},
    "description": {},
    "description_local": {},
    "is_active": {},
    "effective_date": "2024-08-25",
    "end_date": "2024-08-25",
    "parent_zone_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Get parent zone

GET

https://api.faireplace.com/api

/legislative-zones/{id}/parent

Get parent zone › path Parameters

id

string · uuid · required

Get parent zone › Responses

id

string | null · uuid

zone_type

string | null

country_code

string | null

code

string | null

name

string | null

name_local

string | null

description

string | null

description_local

string | null

is_active

boolean | null

effective_date

string | null · date

end_date

string | null · date

parent_zone_id

string | null · uuid

created_at

string | null · date-time

updated_at

string | null · date-time

GET/legislative-zones/{id}/parent

curl --request GET \
  --url https://api.faireplace.com/api/legislative-zones/:id/parent

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "zone_type": {},
  "country_code": {},
  "code": {},
  "name": {},
  "name_local": {},
  "description": {},
  "description_local": {},
  "is_active": {},
  "effective_date": "2024-08-25",
  "end_date": "2024-08-25",
  "parent_zone_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

List ancestor zones

GET

https://api.faireplace.com/api

/legislative-zones/{id}/ancestors

List ancestor zones › path Parameters

id

string · uuid · required

List ancestor zones › Responses

object[]

id

string | null · uuid

zone_type

string | null

country_code

string | null

code

string | null

name

string | null

name_local

string | null

description

string | null

description_local

string | null

is_active

boolean | null

effective_date

string | null · date

end_date

string | null · date

parent_zone_id

string | null · uuid

created_at

string | null · date-time

updated_at

string | null · date-time

GET/legislative-zones/{id}/ancestors

curl --request GET \
  --url https://api.faireplace.com/api/legislative-zones/:id/ancestors

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "zone_type": {},
    "country_code": {},
    "code": {},
    "name": {},
    "name_local": {},
    "description": {},
    "description_local": {},
    "is_active": {},
    "effective_date": "2024-08-25",
    "end_date": "2024-08-25",
    "parent_zone_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Deactivate legislative zone

POST

https://api.faireplace.com/api

/legislative-zones/{id}/deactivate

Deactivate legislative zone › path Parameters

id

string · uuid · required

Deactivate legislative zone › Request Body

string · date

Deactivate legislative zone › Responses

id

string | null · uuid

zone_type

string | null

country_code

string | null

code

string | null

name

string | null

name_local

string | null

description

string | null

description_local

string | null

is_active

boolean | null

effective_date

string | null · date

end_date

string | null · date

parent_zone_id

string | null · uuid

created_at

string | null · date-time

updated_at

string | null · date-time

POST/legislative-zones/{id}/deactivate

curl --request POST \
  --url https://api.faireplace.com/api/legislative-zones/:id/deactivate \
  --header 'Content-Type: application/json' \
  --data '"2024-08-25"'

shell

Example Request Body

"2024-08-25"

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "zone_type": {},
  "country_code": {},
  "code": {},
  "name": {},
  "name_local": {},
  "description": {},
  "description_local": {},
  "is_active": {},
  "effective_date": "2024-08-25",
  "end_date": "2024-08-25",
  "parent_zone_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

Reactivate legislative zone

POST

https://api.faireplace.com/api

/legislative-zones/{id}/reactivate

Reactivate legislative zone › path Parameters

id

string · uuid · required

Reactivate legislative zone › Responses

id

string | null · uuid

zone_type

string | null

country_code

string | null

code

string | null

name

string | null

name_local

string | null

description

string | null

description_local

string | null

is_active

boolean | null

effective_date

string | null · date

end_date

string | null · date

parent_zone_id

string | null · uuid

created_at

string | null · date-time

updated_at

string | null · date-time

POST/legislative-zones/{id}/reactivate

curl --request POST \
  --url https://api.faireplace.com/api/legislative-zones/:id/reactivate

shell

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "zone_type": {},
  "country_code": {},
  "code": {},
  "name": {},
  "name_local": {},
  "description": {},
  "description_local": {},
  "is_active": {},
  "effective_date": "2024-08-25",
  "end_date": "2024-08-25",
  "parent_zone_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2024-08-25T15:00:00Z",
  "updated_at": "2024-08-25T15:00:00Z"
}

json

application/json

List zones by country

GET

https://api.faireplace.com/api

/legislative-zones/country/{country_code}

List zones by country › path Parameters

country_code

string · required

List zones by country › Responses

object[]

id

string | null · uuid

zone_type

string | null

country_code

string | null

code

string | null

name

string | null

name_local

string | null

description

string | null

description_local

string | null

is_active

boolean | null

effective_date

string | null · date

end_date

string | null · date

parent_zone_id

string | null · uuid

created_at

string | null · date-time

updated_at

string | null · date-time

GET/legislative-zones/country/{country_code}

curl --request GET \
  --url https://api.faireplace.com/api/legislative-zones/country/:country_code

shell

Example Responses

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "zone_type": {},
    "country_code": {},
    "code": {},
    "name": {},
    "name_local": {},
    "description": {},
    "description_local": {},
    "is_active": {},
    "effective_date": "2024-08-25",
    "end_date": "2024-08-25",
    "parent_zone_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2024-08-25T15:00:00Z",
    "updated_at": "2024-08-25T15:00:00Z"
  }
]

json

application/json

Check rent regulation by postal code

POST

https://api.faireplace.com/api

/legislative-zones/rent-regulation/check

Check rent regulation by postal code › Request Body

postal_code

string · required

Check rent regulation by postal code › Responses

postal_code

string

city_name

string

is_rent_regulated

boolean

insee_code

string

object

object[]

object

POST/legislative-zones/rent-regulation/check

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

shell

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

Get rent regulation data by INSEE code › path Parameters

insee_code

string · required

Get rent regulation data by INSEE code › Responses

200

postal_code

string

city_name

string

is_rent_regulated

boolean

insee_code

string

object

object[]

object

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

curl --request GET \
  --url https://api.faireplace.com/api/legislative-zones/rent-regulation/zone/:insee_code

shell

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

Check rent control compliance › Request Body

address

string · required

postal_code

string · required

room_count

integer · required

surface_area

number · float · required

construction_period

string · enum · required

Enum values:

before_1946

19461970

19711990

19912005

after_2005

after_1990

is_furnished

boolean · required

proposed_rent

number · float · required

Check rent control compliance › Responses

territory

string

address

string

administrative_quarter

string

quarter_id

integer | null

object

proposed_rent_per_sqm

number · float

is_compliant

boolean

compliance_status

string

object[]

data_source

string

last_update

string

POST/legislative-zones/rent-control/check

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

shell

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": {},
  "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": {}
    }
  ],
  "data_source": "data_source",
  "last_update": "last_update"
}

json

application/json

Get administrative quarter from address/postal code

GET

https://api.faireplace.com/api

/legislative-zones/rent-control/quarter

Get administrative quarter from address/postal code › query Parameters

address

string · required

postal_code

string · required

Get administrative quarter from address/postal code › Responses

200

id

integer

name

string

object

GET/legislative-zones/rent-control/quarter

curl --request GET \
  --url 'https://api.faireplace.com/api/legislative-zones/rent-control/quarter?address=%3Cstring%3E&postal_code=%3Cstring%3E'

shell

Example Responses

{
  "id": 0,
  "name": "name",
  "coordinates": {
    "longitude": 0,
    "latitude": 0
  }
}

json

application/json

Get reference rent for a quarter and parameters

GET

https://api.faireplace.com/api

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

Get reference rent for a quarter and parameters › query Parameters

quarter

string · required

room_count

integer · required

construction_period

string · enum · required

Enum values:

before_1946

19461970

19711990

19912005

after_2005

after_1990

is_furnished

boolean · required

year

string · required

Get reference rent for a quarter and parameters › Responses

200

reference_rent

number · float

reference_rent_increased

number · float

reference_rent_decreased

number · float

year

string

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

curl --request GET \
  --url 'https://api.faireplace.com/api/legislative-zones/rent-control/reference-rent?quarter=%3Cstring%3E&room_count=%3Cnumber%3E&construction_period=%3Cstring%3E&is_furnished=%3Cbool%3E&year=%3Cstring%3E'

shell

Example Responses

{
  "reference_rent": 0,
  "reference_rent_increased": 0,
  "reference_rent_decreased": 0,
  "year": "year"
}

json

application/json

List supported territories for rent control

GET

https://api.faireplace.com/api

/legislative-zones/rent-control/territories

List supported territories for rent control › Responses

200

territories

string[]

GET/legislative-zones/rent-control/territories

curl --request GET \
  --url https://api.faireplace.com/api/legislative-zones/rent-control/territories

shell

Example Responses

{
  "territories": [
    "string"
  ]
}

json

application/json

Media Lease Types