API DÉVELOPPEUR

L’API Xsearcher

Récupère les résultats OSINT dans tes bots Discord, tes scripts et tes applications avec une simple clé API.

Base https://xsearcher.cc Format JSON Limites 20 requêtes / minute · 500 / jour

Mes clés API

Crée jusqu’à 5 clés. Chaque clé est liée à ton compte. Réservé aux offres Ultra et Max.

Démarrage rapide

  1. 1
    Crée une clé

    Connecte-toi puis clique sur « Créer une clé » ci-dessus. Elle commence par xsearcher-, suivi du code de ton compte. L’accès demande l’offre X.GPT Ultra ou supérieure.

  2. 2
    Envoie une requête

    Appelle POST /api/v1/osint/search avec ta clé dans l’en-tête Authorization et les critères de recherche en JSON.

  3. 3
    Utilise les résultats

    L’API renvoie les fiches trouvées au format JSON : affiche-les dans ton bot Discord, ton site ou ton script.

Authentification

Envoie ta clé API dans l’en-tête Authorization de chaque requête, ou dans X-API-Key.

Authorization: Bearer xsearcher-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# ou
X-API-Key: xsearcher-xxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Ta clé est liée à l’offre de ton compte : si ton offre repasse sous Ultra, la clé cesse de fonctionner (erreur plan_required).

Garde ta clé secrète : ne la mets jamais dans du code côté navigateur ni dans un dépôt public. Si elle fuite, révoque-la et crée-en une autre.

Réponse

Les fiches trouvées sont dans data.results. Chaque fiche contient les champs disponibles (nom, e-mail, ville…) ; leur contenu varie selon les sources.

{
  "success": true,
  "data": {
    "results": [
      { "prenom": "Camille", "nom_famille": "Dupont", "email": "[email protected]", "ville": "Lyon" }
    ]
  },
  "meta": { "total": 1, "count": 1, "page": 1, "pages": 1, "took_ms": 214 },
  "usage": { "minute": { "used": 1, "limit": 20, "remaining": 19 },
             "day":    { "used": 1, "limit": 500, "remaining": 499 } }
}

GET /api/v1/me — infos sur ta clé et ta consommation (ne compte pas dans les limites).

Erreurs

En cas d’erreur, success vaut false et error contient un code stable et un message.

HTTPcodeSignification
400missing_criteriaAucun critère de recherche valide.
400invalid_jsonLe corps de la requête n’est pas un JSON valide.
401missing_api_key · invalid_api_keyClé absente, mal formée ou inconnue.
401revoked_api_keyLa clé a été révoquée.
403plan_requiredOffre insuffisante : l’API OSINT demande X.GPT Ultra ou supérieure.
403blocked_targetCette personne ne peut pas être recherchée.
429rate_limited · daily_quota_exceededTrop de requêtes. Respecte l’en-tête Retry-After.
502 / 503upstream_errorLa source de données est momentanément indisponible : réessaie.

Limites

20requêtes par minute et par clé
500requêtes par jour et par clé
5clés actives par compte

Chaque réponse contient les en-têtes X-RateLimit-Remaining-Minute et X-RateLimit-Remaining-Day. Au-delà de la limite, l’API répond 429 avec Retry-After (en secondes).

Exemples de code

Copie-colle, remplace la clé et c’est parti.

Bots Discord

Une commande /osint prête à l’emploi.

  • Stocke la clé dans une variable d’environnement (XSEARCHER_KEY) et le jeton du bot dans DISCORD_TOKEN.
  • Utilise deferReply() : la recherche peut prendre quelques secondes.
  • Limite l’affichage à 3–5 fiches par message et respecte les 429 avec Retry-After.
  • Réserve la commande à un rôle de confiance (setDefaultMemberPermissions / @app_commands.checks).

Tester l’API

Envoie une vraie requête depuis cette page.

Utilise la clé saisie dans « Exemples de code » (ou celle que tu viens de créer).

Bonnes pratiques

  • Ne partage jamais ta clé et révoque-la dès qu’elle est exposée.
  • Mets les résultats en cache côté serveur si tu fais plusieurs fois la même recherche.
  • Gère toujours les erreurs 401, 429 et 5xx sans faire planter ton bot.
  • Utilise l’API dans le respect de la loi et du RGPD : les données personnelles ne doivent servir qu’à un usage légitime.