> ## Documentation Index > Fetch the complete documentation index at: https://docs.osintcat.net/llms.txt > Use this file to discover all available pages before exploring further. # Email OSINT Discover which websites an email address is registered on. **Purpose Identification Required**: This endpoint requires you to specify the purpose/reason for your OSINT search. You can provide this in 4 different ways (in order of priority): 1. **Query Parameter**: `?purpose=Your%20Purpose` 2. **X-Purpose Header**: `X-Purpose: Your Purpose` 3. **Purpose Header**: `Purpose: Your Purpose` 4. **User-Agent Header**: Include `Purpose: Your Purpose` within the User-Agent string **Credits Required**: This endpoint requires email OSINT credits to perform searches. Credits are deducted only after a successful search. Check your credit balance using the `/api/user` endpoint, which includes email OSINT credit information in its response. ## Parameters Email address to investigate Purpose/reason for the OSINT search (can also be provided via headers) ## Headers Your API key Alternative way to provide the purpose (takes priority over query parameter) Alternative way to provide the purpose Can include `Purpose: Your Purpose` within the User-Agent string ## Credit System Email OSINT searches require credits to be performed. The cost per search varies by your subscription plan: | Plan | Price per Search | Monthly Free Credits | | ------------ | ---------------- | -------------------- | | Free | €0.50 | 5 searches (€2.50) | | Starter | €0.40 | 10 searches (€4.00) | | Researcher | €0.30 | 20 searches (€6.00) | | Investigator | €0.20 | 30 searches (€6.00) | | Enterprise | €0.15 | 50 searches (€7.50) | **Monthly Credits**: Free credits are automatically awarded on the first of each month based on your plan. Free credits are not stackable - unused credits from previous months do not accumulate. **Credit Deduction**: Credits are deducted only after a successful API response. Failed requests (due to invalid parameters, rate limits, etc.) do not consume credits. ## Check Credit Balance Before making a search request, you can check your current credit balance using the `/api/user` endpoint, which includes email OSINT credit information: **Endpoint**: `GET /api/user` ```bash cURL theme={null} curl "https://www.osintcat.net/api/user" \ -H "X-API-KEY: YOUR_API_KEY" ``` ```python Python theme={null} import requests url = "https://www.osintcat.net/api/user" headers = { "X-API-KEY": "YOUR_API_KEY" } response = requests.get(url, headers=headers) if response.ok: data = response.json() credits = data.get('email_osint_credits', {}) print(f"Current credits: €{credits.get('current_balance', 0)}") print(f"Price per search: €{credits.get('price_per_search', 0)}") print(f"Searches available: {credits.get('searches_available', 0)}") else: print(f"Error: {response.status_code}") ``` The `email_osint_credits` object in the response contains: * `current_balance`: Current credit balance in EUR * `price_per_search`: Cost per search based on your plan * `has_sufficient_credits`: Whether you have enough credits for at least one search * `searches_available`: Estimated number of searches available with current balance See the [User Info](/api-reference/endpoint/user) endpoint documentation for the complete response structure. ## Response Returns information about websites where the email address is registered. Credits are deducted after a successful response. ## Example Request ```bash cURL theme={null} # Using header for API Key and X-Purpose for reason curl "https://www.osintcat.net/api/email-osint?query=test@example.com" \ -H "X-API-KEY: YOUR_API_KEY" \ -H "X-Purpose: Security Research" ``` ```python Python theme={null} import requests url = "https://www.osintcat.net/api/email-osint" params = { "query": "test@example.com", "purpose": "Security Research" } headers = { "X-API-KEY": "YOUR_API_KEY" } response = requests.get(url, params=params, headers=headers) if response.ok: print(response.json()) else: print(f"Error: {response.status_code}") ``` ```javascript Node.js theme={null} const url = 'https://www.osintcat.net/api/email-osint?query=test@example.com&purpose=Security%20Research'; fetch(url, { headers: { 'X-API-KEY': 'YOUR_API_KEY' } }) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error('error:' + err)); ``` ```php PHP theme={null} $url, CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ "X-API-KEY: YOUR_API_KEY" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } ``` ```go Go theme={null} package main import ( "encoding/json" "fmt" "io" "net/http" "net/url" ) func main() { baseURL := "https://www.osintcat.net/api/email-osint" params := url.Values{} params.Add("query", "test@example.com") params.Add("purpose", "Security Research") fullURL := baseURL + "?" + params.Encode() req, _ := http.NewRequest("GET", fullURL, nil) req.Header.Set("X-API-KEY", "YOUR_API_KEY") client := &http.Client{} resp, err := client.Do(req) if err != nil { fmt.Printf("Error: %v\n", err) return } defer resp.Body.Close() body, _ := io.ReadAll(resp.Body) var result map[string]interface{} json.Unmarshal(body, &result) fmt.Printf("%+v\n", result) } ``` ```ruby Ruby theme={null} require 'net/http' require 'json' require 'uri' uri = URI('https://www.osintcat.net/api/email-osint') uri.query = URI.encode_www_form({ query: 'test@example.com', purpose: 'Security Research' }) request = Net::HTTP::Get.new(uri) request['X-API-KEY'] = 'YOUR_API_KEY' response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http| http.request(request) end if response.is_a?(Net::HTTPSuccess) data = JSON.parse(response.body) puts JSON.pretty_generate(data) else puts "Error: #{response.code}" end ``` ```java Java theme={null} import java.net.HttpURLConnection; import java.net.URL; import java.io.BufferedReader; import java.io.InputStreamReader; public class OsintCatAPI { public static void main(String[] args) { try { String apiUrl = "https://www.osintcat.net/api/email-osint?query=test@example.com&purpose=Security%20Research"; URL url = new URL(apiUrl); HttpURLConnection conn = (HttpURLConnection) url.openConnection(); conn.setRequestMethod("GET"); conn.setRequestProperty("X-API-KEY", "YOUR_API_KEY"); int responseCode = conn.getResponseCode(); if (responseCode == HttpURLConnection.HTTP_OK) { BufferedReader in = new BufferedReader(new InputStreamReader(conn.getInputStream())); String inputLine; StringBuilder response = new StringBuilder(); while ((inputLine = in.readLine()) != null) { response.append(inputLine); } in.close(); System.out.println(response.toString()); } else { System.out.println("Error: " + responseCode); } } catch (Exception e) { e.printStackTrace(); } } } ``` ```csharp C# theme={null} using System; using System.Net.Http; using System.Threading.Tasks; class Program { static async Task Main(string[] args) { using (var client = new HttpClient()) { try { string url = "https://www.osintcat.net/api/email-osint?query=test@example.com&purpose=Security%20Research"; client.DefaultRequestHeaders.Add("X-API-KEY", "YOUR_API_KEY"); var response = await client.GetAsync(url); if (response.IsSuccessStatusCode) { string content = await response.Content.ReadAsStringAsync(); Console.WriteLine(content); } else { Console.WriteLine($"Error: {response.StatusCode}"); } } catch (Exception ex) { Console.WriteLine($"Error: {ex.Message}"); } } } } ``` ## Error Responses ### Insufficient Credits (402 Payment Required) If you don't have enough credits to perform a search, you'll receive a 402 status code: ```json theme={null} { "error": "INSUFFICIENT_CREDITS", "message": "Insufficient credits. You need 0.50€ but have 0.00€. Please purchase credits.", "credits_needed": 0.50, "credits_available": 0.00 } ``` ### Rate Limit Exceeded (429 Too Many Requests) If you exceed the rate limit of 3 requests per second, you'll receive a 429 status code. This does not consume credits. ### Other Status Codes * `200 OK` - Success (credits are deducted) * `400 Bad Request` - Missing or invalid parameters (no credits deducted) * `403 Forbidden` - Invalid or missing API key (no credits deducted) * `429 Too Many Requests` - Rate limit exceeded (no credits deducted) * `500 Internal Server Error` - Server error (no credits deducted)