# EasyLocation — API reference (for LLMs / agents)

> Companion to `/llms.txt` (the product/site index). This file documents the HTTP
> **API** so an LLM/agent can manage a landlord's rentals without the UI.

**Base URL:** `https://api.easylocation.fr` · **Docs:** OpenAPI/Swagger is exposed
only in DEBUG (hidden in prod for security); this file is the stable contract.

**Auth (for agents):** send an API key as the header `X-API-Key: <key>`. API keys
are created in the app (Settings → API Keys) and require the **Enterprise plan**.
(Interactive users authenticate with session cookies / JWT instead; agents should
use the API key.)

**MCP:** an MCP server may live at `easylocation/mcp/` in the repo — prefer it for
agent use (see its README).

## Core resources (`/api`)

- **Properties** — `GET /properties` (filters: type, status, min/max_rent, min/max_surface, rooms, address_search, sort, skip, limit) · `GET|POST /properties` · `GET|PUT|DELETE /properties/{id}`.
- **Tenants** — `GET|POST /tenants` · `GET|PUT|DELETE /tenants/{id}`.
- **Transactions** — `GET|POST /transactions` · `GET|PUT|DELETE /transactions/{id}` · `GET /transactions/stats`.
- **Documents** — `GET /documents` · `POST /documents/upload` · `GET /documents/{id}/download` · `GET /documents/{id}/preview`.
- **Document generation (PDF)** — `POST /generate/lease` · `/generate/receipt` · `/generate/inspection` · `/generate/rent-revision/{id}` · `/generate/caf-attestation`.
- **Rent revisions (IRL)** — `POST /rent-revisions/calculate` · `GET|POST /rent-revisions` · `GET|PUT|DELETE /rent-revisions/{id}`.
- **DPE (energy diagnosis / loi Climat)** — `GET /dpe/rental-banned/list` · `GET /dpe/expiring/soon` · `POST /dpe/check-rental-ban` · `GET /dpe/info/legal-requirements`.
- **Inspections (état des lieux)** — `GET|POST /inspections` · `GET|PUT|DELETE /inspections/{id}` · `POST /inspections/{id}/sign`.
- **Signatures** — `POST /signatures` · `GET /signatures/{request_id}` · `POST /signatures/{request_id}/capture`.
- **Payments (Stripe)** — `POST /payments/create-intent` · `/payments/confirm` · `/payments/refund`.
- **Subscriptions** — `GET /subscriptions/plans` · `GET /subscriptions/my-subscription` · `POST /subscriptions/checkout` · `POST /subscriptions/portal`.
- **Analytics** — `GET /analytics/dashboard` · `/analytics/properties` · `/analytics/tenants` · `/analytics/financial`.
- **Export** — `POST /export/{properties|tenants|transactions}/{csv|excel}`.

Health: `GET /health` · version: `GET /version` (both public).