FairePlace Public API

The Public API from FairePlace — 6 operation(s) for public.

GitHub OpenAPI

Operations 6

POST /public/tools/rent-control/check Verifie un loyer face a l'encadrement des loyers (zone tendue) #
POST /public/tools/irl/simulate-by-quarters Simule une revision de loyer (IRL), valeurs INSEE resolues par le serveur #
POST /public/tools/depot-garantie/calculate Calcule la restitution du depot de garantie (plafond, delai, penalites) #
POST /public/tools/rendement-locatif/simulate Calcule le rendement locatif brut/net et la fiscalite par regime #
POST /public/tools/risks/check Etat des risques naturels et technologiques d'une adresse (Georisques) #
POST /public/tools/bail-draft Cree un brouillon de bail et renvoie un draft_token. #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/faireplace-com:faireplace-com-public-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

faireplace-com-public-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: FairePlace — French Rental Tools Public API
  version: 1.0.0
  description: 'Free tools for residential renting in France (location): rent control (encadrement des loyers), IRL rent revision, security deposit, rental yield, address risks, and creating a lease draft (bail) then finalizing/e-signing it (advanced eIDAS) on FairePlace.'
servers:
- url: https://api.faireplace.com/api
tags:
- name: Public
paths:
  /public/tools/rent-control/check:
    post:
      operationId: checkRentControl
      summary: Verifie un loyer face a l'encadrement des loyers (zone tendue)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - address
              - postal_code
              - room_count
              - surface_area
              - construction_period
              - is_furnished
              - proposed_rent
              properties:
                address:
                  type: string
                  example: 1 rue de Rivoli
                postal_code:
                  type: string
                  example: '75001'
                room_count:
                  type: integer
                  example: 2
                surface_area:
                  type: number
                  example: 45
                construction_period:
                  type: string
                  example: 1971-1990
                is_furnished:
                  type: boolean
                  example: false
                proposed_rent:
                  type: number
                  example: 1500
      responses:
        '200':
          description: Verdict d'encadrement.
      tags:
      - Public
  /public/tools/irl/simulate-by-quarters:
    post:
      operationId: simulateIrl
      summary: Simule une revision de loyer (IRL), valeurs INSEE resolues par le serveur
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - current_rent
              - old_irl_quarter
              - new_irl_quarter
              - effective_date
              properties:
                current_rent:
                  type: number
                  example: 850
                old_irl_quarter:
                  type: string
                  example: T2-2023
                new_irl_quarter:
                  type: string
                  example: T2-2024
                effective_date:
                  type: string
                  example: '2024-07-01'
                region:
                  type: string
                  example: metropole
      responses:
        '200':
          description: Nouveau loyer et variation.
      tags:
      - Public
  /public/tools/depot-garantie/calculate:
    post:
      operationId: calculateDeposit
      summary: Calcule la restitution du depot de garantie (plafond, delai, penalites)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - lease_type
              - monthly_rent_hc
              - deposit_amount
              - lease_end_date
              - exit_inspection_conformity
              properties:
                lease_type:
                  type: string
                  example: vide
                monthly_rent_hc:
                  type: number
                  example: 750
                deposit_amount:
                  type: number
                  example: 750
                lease_end_date:
                  type: string
                  example: '2026-03-31'
                exit_inspection_conformity:
                  type: boolean
                  example: true
      responses:
        '200':
          description: Restitution calculee.
      tags:
      - Public
  /public/tools/rendement-locatif/simulate:
    post:
      operationId: simulateRentalYield
      summary: Calcule le rendement locatif brut/net et la fiscalite par regime
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - purchase_price
              - notary_fees
              - monthly_rent
              - annual_charges
              - furnishing
              - tmi_percent
              properties:
                purchase_price:
                  type: number
                  example: 200000
                notary_fees:
                  type: number
                  example: 16000
                monthly_rent:
                  type: number
                  example: 800
                annual_charges:
                  type: number
                  example: 2000
                furnishing:
                  type: string
                  example: furnished_long_term
                tmi_percent:
                  type: number
                  example: 30
      responses:
        '200':
          description: Simulation de rendement.
      tags:
      - Public
  /public/tools/risks/check:
    post:
      operationId: checkAddressRisks
      summary: Etat des risques naturels et technologiques d'une adresse (Georisques)
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - address
              properties:
                address:
                  type: string
                  example: 1 rue de Rivoli, 75001 Paris
      responses:
        '200':
          description: Synthese des risques.
      tags:
      - Public
  /public/tools/bail-draft:
    post:
      operationId: createLeaseDraft
      summary: Cree un brouillon de bail et renvoie un draft_token.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - owner
              - logement
              - lease
              properties:
                owner:
                  type: object
                  example:
                    last_name: Dupont
                    email: jean@ex.fr
                logement:
                  type: object
                  example:
                    name: T2
                    address: 12 rue B, 75011 Paris
                lease:
                  type: object
                  example:
                    rent_amount: 850
                    start_date: '2026-09-01'
                    lease_type: MEUBLE
      responses:
        '201':
          description: draft_token + expires_at (TTL 30 min).
      tags:
      - Public