JARVIS — Documentation

Getting Started

Welcome to the JARVIS documentation. This guide will help you get started with our powerful data search platform.

Quick Start

Obtenir une clé JARVIS
Contacte @emasculer sur Telegram ou consulte les tarifs sur l'accueil. La même clé fonctionne sur le bot @Jarvislookup et sur jarvis.st.
Se connecter sur le web
Va sur jarvis.st, entre ta clé JARVIS-XXXX-XXXX-XXXX-XXXX et ton ID Telegram (ou PIN web si activé). La session est stockée en cookie httpOnly — ne colle jamais ta clé dans du code front public.
Appels API (scripts / intégrations)
Envoie ta clé dans l'en-tête x-api-key sur les endpoints GET ci-dessous. Base URL : https://jarvis.st

Important

Keep your API key secret! Anyone with your key can access the API and consume your quota.

Authentication

Deux modes d'authentification :

Web (jarvis.st) — session cookie httpOnly après connexion sur la page recherche. Idéal pour l'interface.
API / scripts — en-tête x-api-key: JARVIS-XXXX-XXXX-XXXX-XXXX sur chaque requête.

Exemple (recherche floue)

            curl -G "https://jarvis.st/search/suggest" \
  -H "x-api-key: JARVIS-XXXX-XXXX-XXXX-XXXX" \
  --data-urlencode "type=EMAIL" \
  --data-urlencode "query=user@example.com" \
  --data-urlencode "limit=20"
          

API Endpoints

Tous les endpoints sont en GET. Types supportés : IDENTITY, PHONE, EMAIL, NIR, IBAN, ADDRESS, VILLE, CP, IP, PLATE, FACEBOOK, PSEUDO.

Recherche approximative

GET /search/suggest

Paramètres : type, query (ou champs identité : prenom, nom, phone, nir, iban…), limit, page.

Recherche exacte

GET /search

Paramètres : type, value, champs identité optionnels, limit.

FiveM Lookup

GET /search/fivem

Paramètres : query, limit, page.

Quota & compte

GET /search/key-info

Retourne quota du jour, expiration, rôle. Affiché aussi dans l'onglet Paramètres du site.

Statistiques index

GET /search/stats

Health Check

GET /health

Check API status (no authentication required).

Rate Limits

Plan	Rate Limit	Burst Limit
Test (Monthly)	100 req/min	150 req/min
Test (Yearly)	100 req/min	150 req/min

Rate Limit Headers

Each response includes headers showing your current rate limit status:

              X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1642252800
            

Error Codes

Code	Status	Description
400	Bad Request	Invalid request parameters
401	Unauthorized	Missing or invalid API key
403	Forbidden	API key expired or quota exceeded
404	Not Found	No results found
429	Too Many Requests	Rate limit exceeded
500	Internal Server Error	Server error, please retry

Error Response Format

            {
  "success": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "The provided API key is invalid or expired"
  }
}
          

Best Practices

Always use HTTPS for API requests
Store API keys securely (use environment variables)
Implement proper error handling in your application
Cache responses when appropriate to reduce API calls
Monitor your rate limits to avoid throttling
Use exact search when possible for better performance
Never expose API keys in client-side code
Don't hardcode API keys in your source code
Avoid making unnecessary duplicate requests

Code Examples

JavaScript / Node.js

            const key = process.env.JARVIS_API_KEY;

const url = new URL('https://jarvis.st/search/suggest');
url.searchParams.set('type', 'EMAIL');
url.searchParams.set('query', 'user@example.com');

const res = await fetch(url, { headers: { 'x-api-key': key } });
console.log(await res.json());
          

Python

            import os, requests

r = requests.get(
    'https://jarvis.st/search/suggest',
    headers={'x-api-key': os.environ['JARVIS_API_KEY']},
    params={'type': 'EMAIL', 'query': 'user@example.com'},
)
print(r.json())
          

PHP

            $key = getenv('JARVIS_API_KEY');
$url = 'https://jarvis.st/search/suggest?' . http_build_query([
    'type' => 'EMAIL',
    'query' => 'user@example.com',
]);

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: ' . $key],
]);
echo curl_exec($ch);
curl_close($ch);
          

Need Help?

Besoin d'aide, renouvellement de clé ou question sur le quota ?

Assistance et clés

t.me/jarvislookup →

Discord

Communauté et support

discord.gg/Jarvis →

API Documentation