> ## Documentation Index
> Fetch the complete documentation index at: https://docs.urbanora.fr/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Obtenir une clé, qualifier un immeuble, lire la réponse.

Base URL : `https://partner.urbanora.fr`.

**1. Créer une clé**

Dans le [compte Urbanora](https://urbanora.fr), section **Clés API** (owners et admins). Choisissez l'environnement `test` pour commencer.

La clé complète s'affiche **une seule fois**. Elle commence par `upk_test_` ou `upk_live_`. Stockez-la dans un gestionnaire de secrets, jamais dans un dépôt git.

**2. Qualifier un immeuble**

Un seul mode d'entrée à la fois : `address`, `imb_code`, `parcelle_id`, ou `lon` + `lat`.

```bash curl theme={null}
curl -sS "https://partner.urbanora.fr/v1/buildings/qualify?address=12%20rue%20de%20la%20République%2C%20Marseille" \
  -H "X-Api-Key: $URBANORA_API_KEY"
```

```ts TypeScript theme={null}
const res = await fetch(
  "https://partner.urbanora.fr/v1/buildings/qualify?" +
    new URLSearchParams({
      address: "12 rue de la République, Marseille",
    }),
  { headers: { "X-Api-Key": process.env.URBANORA_API_KEY! } },
);

const body = await res.json();
if (!res.ok) {
  throw new Error(
    `${body.error.code}: ${body.error.message} (${body.request_id})`,
  );
}

console.log(body.copropriete?.syndic?.siren, body.fraicheur);
```

**3. Lire ce qui compte**

La réponse rassemble IMB, fibre, bâtiment, copropriété / syndic, décisionnaires, occupants, et un bloc `fraicheur`. Le détail des champs est dans la [référence OpenAPI](https://docs.urbanora.fr/api-reference/buildings/qualifier-un-immeuble-fibre-copro-syndic-occupants.md).

> [!NOTE]
>
> En local, la même clé fonctionne sur `http://127.0.0.1:8086`. Le MCP écoute `http://127.0.0.1:8094/mcp`.

## Ensuite

> **[Authentification](https://docs.urbanora.fr/authentification.md)**
>
> Header, rotation, test vs live, Bearer MCP.

> **[Erreurs et débit](https://docs.urbanora.fr/erreurs.md)**
>
> Format `{ error, request_id }`, 429, idempotence.

> **[Plaques](https://docs.urbanora.fr/guides/plaques-zones.md)**
>
> Résoudre une commune, lister, agréger.

> **[MCP](https://docs.urbanora.fr/guides/mcp.md)**
>
> Brancher Cursor en deux minutes.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.