Démarrage rapide

Votre premier appel à l’API en moins de cinq minutes : créez une clé, testez-la, cherchez, puis révélez.

1. Créer une clé

Ouvrez Clés API dans votre compte et créez une clé. Elle n’est affichée qu’une fois, alors copiez-la aussitôt. Si votre offre n’inclut pas l’API, la page vous indique quelles offres l’incluent.

2. Tester la clé

Cet appel ne consomme rien et vous indique votre offre et vos limites. Remplacez la clé d’exemple par la vôtre.

curl "https://findbytown.com/api/v1/quota" \
  -H "Authorization: Bearer fbt_EXAMPLE_not_a_real_key_0000"

const res = await fetch("https://findbytown.com/api/v1/quota", {
  headers: { Authorization: "Bearer fbt_EXAMPLE_not_a_real_key_0000" },
});
const body = await res.json();
if (!res.ok) throw new Error(body.error);
console.log(body);

import requests

res = requests.get(
    "https://findbytown.com/api/v1/quota",
    headers={"Authorization": "Bearer fbt_EXAMPLE_not_a_real_key_0000"},
)
body = res.json()
if not res.ok:
    raise RuntimeError(body["error"])
print(body)

3. Chercher

Trouvez des plombiers en France. Utilisez /countries, /zones et /categories pour trouver les valeurs acceptées par les filtres.

curl "https://findbytown.com/api/v1/businesses?country=FR&trade=plumber&perPage=1" \
  -H "Authorization: Bearer fbt_EXAMPLE_not_a_real_key_0000"

const res = await fetch("https://findbytown.com/api/v1/businesses?country=FR&trade=plumber&perPage=1", {
  headers: { Authorization: "Bearer fbt_EXAMPLE_not_a_real_key_0000" },
});
const body = await res.json();
if (!res.ok) throw new Error(body.error);
console.log(body);

import requests

res = requests.get(
    "https://findbytown.com/api/v1/businesses?country=FR&trade=plumber&perPage=1",
    headers={"Authorization": "Bearer fbt_EXAMPLE_not_a_real_key_0000"},
)
body = res.json()
if not res.ok:
    raise RuntimeError(body["error"])
print(body)

Les lignes reviennent avec domain, website et contact à null. Cela consomme votre budget quotidien d’entreprises et aucun quota de révélations.

4. Révéler une entreprise

Cet appel consomme une révélation de votre quota mensuel. En cas de doute, vérifiez d’abord le coût avec GET /businesses/{id}/reveal.

curl -X POST "https://findbytown.com/api/v1/businesses/1001/reveal" \
  -H "Authorization: Bearer fbt_EXAMPLE_not_a_real_key_0000"

const res = await fetch("https://findbytown.com/api/v1/businesses/1001/reveal", {
  method: "POST",
  headers: { Authorization: "Bearer fbt_EXAMPLE_not_a_real_key_0000" },
});
const body = await res.json();
if (!res.ok) throw new Error(body.error);
console.log(body);

import requests

res = requests.post(
    "https://findbytown.com/api/v1/businesses/1001/reveal",
    headers={"Authorization": "Bearer fbt_EXAMPLE_not_a_real_key_0000"},
)
body = res.json()
if not res.ok:
    raise RuntimeError(body["error"])
print(body)

La réponse contient les contacts et "charged": true. Relancez-le et vous obtenez les mêmes données avec "charged": false : rien de plus n’est consommé pendant la même période.

Et ensuite

Gérez les erreurs grâce à leur code error stable.
Respectez les limites à l’aide des en-têtes de réponse.
Utilisez la même clé depuis un client MCP.

Retour à findbytown