FairePlace

FairePlace Public Tools API

Unauthenticated free-tool widgets (no API key) powering the SEO calculators and document generators on faireplace.com. JSON endpoints return DTOs; the `/generate` and `/bordereau` endpoints stream a PDF (`application/pdf`).

GitHub OpenAPI

Operations 27

POST /public/tools/irl/simulate Simulate a rent revision (explicit IRL values) #
POST /public/tools/irl/simulate-by-quarters Simulate a rent revision (server-resolved IRL values) #
GET /public/tools/irl/values List IRL quarter values #
GET /public/tools/irl/latest Get the latest published IRL value #
POST /public/tools/depot-garantie/calculate Calculate a security-deposit restitution #
POST /public/tools/depot-garantie/bordereau Generate a security-deposit restitution receipt (PDF) #
GET /public/tools/rent-control/territories List rent-control territories #
GET /public/tools/rent-control/quarter Resolve the administrative quarter for an address #
GET /public/tools/rent-control/reference-rent Get the reference rent for a quarter #
POST /public/tools/rent-control/check Check a proposed rent against rent control #
POST /public/tools/risks/check Check property risks for an address #
POST /public/tools/rendement-locatif/simulate Simulate rental yield across tax regimes #
GET /public/tools/referentials Get default referentials for the landing wizard #
GET /public/tools/bail-template/{lease_type_id} Get the default lease template for a lease type #
POST /public/tools/bail-draft Deposit an anonymous lease draft #
POST /public/tools/quittance/generate Generate a rent receipt (PDF) #
POST /public/tools/etat-des-lieux/generate Generate an inspection report (PDF) #
POST /public/tools/avenant/generate Generate a lease amendment (PDF) #
POST /public/tools/cautionnement/generate Generate a guarantor act (PDF) #
POST /public/tools/conge/generate Generate a notice / termination letter (PDF) #
POST /public/tools/inventaire-mobilier/generate Generate a furniture inventory (PDF) #
POST /public/tools/relance-impaye/generate Generate an unpaid-rent reminder (PDF) #
POST /public/tools/resiliation-amiable/generate Generate a mutual lease-termination agreement (PDF) #
POST /public/tools/notice-information/generate Generate the tenant information notice (PDF) #
POST /public/tools/reparations-locatives/generate Generate the tenant repairs list (PDF) #
POST /public/tools/grille-vetuste/generate Generate the wear-and-tear grid (PDF) #
POST /public/tools/charges-recuperables/generate Generate the recoverable charges list (PDF) #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/faireplace-com/openapi/faireplace-com-public-tools-api-openapi.yml

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-tools-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.

GitHub Google LinkedIn

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

OpenAPI Specification

faireplace-com-public-tools-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: FairePlace Property Management Public Tools API
  description: 'Comprehensive API for managing properties, leases, tenants, and all aspects of real estate management.

    Built with Rust and Actix-web following hexagonal architecture principles.


    ## Authentication

    This API uses API keys for authentication with tenant-based isolation.


    ## Base URL

    - Production: `https://api.faireplace.com/api`'
  version: 1.0.0
  contact:
    name: FairePlace API Support
    email: api-support@faireplace.com
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
- url: https://api.faireplace.com/api
  description: Production server
security:
- BearerAuth: []
tags:


# --- truncated at 32 KB (98 KB total) ---
# Full source: https://artifacts.apis.io/faireplace-com/openapi/faireplace-com-public-tools-api-openapi.yml